Spam Filtering Configuration on the Mailbox Level: spamassassin.exe

The spamassassin.exe utility serves to manage spam filtering on the mail-account level. The utility allows the following operations:

enabling the use of server-wide spam filtering settings
setting the number of hits required to mark a letter as spam
adding mail addresses to black and white lists
marking mail subject as spam, deleting spam messages

Syntax

spamassassin.exe <command> [<mail_name>] [

<option1><param1> [<param2>…<param n>]

[<option2><param1> [<param2>…<param n>]]

…[<option N><param1> [<param2>…<param n>]]

]

Example

The following command line modifies the SpamAssassin configuration on Johndoe@domain1.com to using server-wide settings, sets the number of hits sufficient to consider a letter as spam to 6, orders to delete spam, and puts the spammer@spamdomain.com email address to the black list.

>spamassassin.exe --update JohnDoe@domain1.com -server-conf true -hits 6 -action del -blacklist add:spammer@spamdomain.com

Commands

Command	Parameter	Description	Example
`--update or -u`	`<mail_name>`	Updates the spam filter configuration for an existing email user.	Updates spam filter settings for John@somewhere.com: >spamassassin.exe --update John@somewhere.com -hits 3 action del -blacklist add:spam@somewhere.com or >spamassassin.exe -u John@somewhere.com -hits 3 action del -blacklist add:spam@somewhere.com
`--info or -i`	`<mail_name>`	Retrieves the spam filter settings for the specified email account.	To retrieve spam filter settings for John_Doe@somewhere.com: >spamassassin.exe --info John_Doe@somewhere.com or >spamassassin.exe -i John_Doe@somewhere.com
`--help or -h`		Displays help on the use of this utility.	To see the help info on the use of the `spamassassin.exe` utility: >spamassassin.exe -–help or >spamassassin.exe -h

Command

Parameter

Description

Example

--update or -u

<mail_name>

Updates the spam filter configuration for an existing email user.

Updates spam filter settings for John@somewhere.com:

>spamassassin.exe --update John@somewhere.com -hits 3 action del -blacklist add:spam@somewhere.com

>spamassassin.exe -u John@somewhere.com -hits 3 action del -blacklist add:spam@somewhere.com

--info or -i

<mail_name>

Retrieves the spam filter settings for the specified email account.

To retrieve spam filter settings for John_Doe@somewhere.com:

>spamassassin.exe --info John_Doe@somewhere.com

>spamassassin.exe -i John_Doe@somewhere.com

--help or -h

Displays help on the use of this utility.

To see the help info on the use of the spamassassin.exe utility:

>spamassassin.exe -–help

>spamassassin.exe -h

Options

Option	Parameter	Description	Example
`-server-conf`	`true\|false`	Applies the server- wide settings.	To use the server-wide settings: >spamassassin.exe --update John_Doe@somewhere.com -server-conf true
`-hits`	`<float>`	Specifies the number of hits that are enough to consider a letter as spam	To set the number of hits required to mark a letter as spam to 3: >spamassassin.exe --update John_Doe@somewhere.com -hits 3
`-action`	`del\|mark`	Specifies the action to perform against spam.	To delete spam: >spamassassin.exe --update John_Doe@somewhere.com -action del
`-modify-subj`	`true\|false`	Allows/prohibits modifying the subject of mail messages.	To allow mail subject modification and to mark the subject with the spam word. >spamassassin.exe -update John_Doe@somewhere.com -modify-subj true -modify-subj-text "SPAM mail"
`-modify-subj-text`	`<string>`	Modifies the text of email message's subject.
`-blacklist`	`add\|del:<pattern1> [, <pattern2>, […]]`	Adds/deletes email message(s) to /from the black list.	To add spam@spamdomain.com to the black list: >spamassassin.exe --update John_Doe@somewhere.com -blacklist add: spam@spamdomain.com
`-whitelist`	`add\|del:<pattern1> [, <pattern2>, […]]`	Adds/deletes email message(s) to /from the white list.	To add notspam@domain2.com to the white list: >spamassassin.exe --update John_Doe@somewhere.com -whitelist add: notspam@domain2.com
`-enable-filtering`	`true\|false`	Enables/disables spam filtering using SpamAssassin. Available since Plesk 7.6.	To enable spam filtering for John_Doe@somewhere.com: >spamassassin.exe --update John_Doe@somewhere.com –enable-filtering true