grey_listing: Greylisting

Using grey_listing utility, you can manage the Mail Greylisting service which provides smart spam protecting mechanism.

This utility performs the following tasks:

  • enabling/disabling greylisting service on the server and particular domains
  • setting up/retrieving server-wide greylisting configuration:
    • allowed/prohibited custom user configurations of greylisting
    • enabled/disabled penalties
    • grey, expiration and/or penalty intervals
    • black/white list of mail addresses (defined by patterns) and domains
  • setting up/retrieving status of greylisting service on domain
  • setting up/retrieving mail user's black/white lists of mail addresses (defined by patterns)

 

Usage
grey_listing <command> [mail-address|domain-name] [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]

Example

The following command enables greylisting service on the server, and sets it up so that custom mailname-level configurations are applied; penalties are enabled; grey interval is 8 minutes, expire interval is 40 days, and penalty interval is 5 minutes; domains example.com and sample.net are in the server white list, and all e-mail addresses containing "instant" are in black list:

plesk bin grey_listing --update-server -status on -personal-conf true -penalty-status true -grey-interval 8 -expire-interval 57600 -penalty-interval 5 -domains-whitelist add:example.com,sample.net -blacklist add:*instant*@*

Commands
Command Parameter Description Example

--update-mailname or -um

<mail@domain>

Updates the greylisting configuration for a specified mail user.

To add all mail addresses registered on the domain ietf.org to white list of mail name johndoe@example.com:

plesk bin grey_listing -um johndoe@example.com -whitelist add:*@ietf.org

 

--update-domain or -ud

<domain>

Updates the greylisting configuration for a specified domain.

To turn off greylisting service on domain example.com:

plesk bin grey_listing -ud example.com -status off

--update-server or -u

 

Updates server-wide greylisting settings.

To enable the greylisting service on server and allow applying custom configurations:

plesk bin grey_listing --update-server -status on -personal-conf true

--info-mailname or -im

<mail@domain>

Retrieves greylisting settings of the specified mail user.

To retrieve greylisting configuration of the mail name johndoe@example.com:

plesk bin grey_listing --info-mailname johndoe@example.com

--info-domain or -id

<domain>

Retrieves greylisting settings of the specified domain.

To retrieve status of greylisting service on domain sample.net:

plesk bin grey_listing --info-domain sample.net

--info-server or -i

 

Retrieves server-wide greylisting settings.

plesk bin grey_listing --info-server

--help or -h

 

 

Displays help on the utility usage.

plesk bin grey_listing -h

Options
Option Parameter Description Example

-status

on|off

Enables/Disables greylisting service.

Used with the --update-domain and --update-server commands.

To disable greylisting service for domain example.com:

plesk bin grey_listing --update-domain example.com -status off

-personal-conf

true|false

Allows/Prohibits applying mail user level configurations of greylisting.

Used only with the --update-server command.

To enable the greylisting service on server and allow applying custom configurations:

plesk bin grey_listing --update-server -status on -personal-conf true

-grey-interval

<number>

Specifies grey interval (in minutes) - a period of time that a sender should wait for before retrying sending the mail.

Default grey interval is 5 minutes.

Used only with the --update-server command.

To change the server-wide greylisting settings so that penalties are enabled, and grey interval is 8 minutes, expire interval is 40 days, and penalty interval is 5 minutes:

plesk bin grey_listing --update-server -grey-interval 8 -expire-interval 57600 -penalty-interval 5 -penalty-status true

-expire-interval

<number>

Specifies expiration interval (in minutes) - a period of time after which a record in grey list expires.

Default expiration interval is 36 days.

Used only with the --update-server command.

-penalty-interval

<number>

Specifies penalty interval (in minutes) - a period of time added to the grey interval in case a sender retried sending mail before the grey interval finished.

Default penalty interval is 2 minutes.

Used only with --update-server command.

-penalty-status

true|false

Enables/Disables penalties.

Used only with the --update-server command.

To disable greylisting penalties on the server:

plesk bin grey_listing --update-server -penalty-status false

-blacklist

<add|del>:<pattern1>[,<pattern2>,[…]]

Adds/Removes e-mail address(es) specified by pattern(s) to/from server's or mail name's black list (shared with Spamassassin).

Mail name's black list overrides the server's, but works only in case applying custom configurations is allowed (-personal-conf option value is true).

Used only with the --update-mailname or --update-server commands.

To add to to server-wide black list all mail addresses matching pattern *v1agra@example.com:

plesk bin grey_listing --update-server -blacklist add:*v1agra@example.com

-whitelist

<add|del>:<pattern1>[,<pattern2>,[…]]

Adds/Removes e-mail address(es) specified by pattern(s) to/from server's or mail name's white list (shared with Spamassassin).

Mail name's white list overrides the server's, but works only in case applying custom configurations is allowed (-personal-conf option value is true).

Used only with the --update-mailname or --update-server commands.

To add all mail addresses matching patterns *doe@* and *smith@* to white list of the mail name johndoe@sample.net:

plesk bin grey_listing --update-mailname johndoe@sample.net -whitelist add:*doe@*,*smith@*

-domains-whitelist

<add|del>:<domain-name1>[,<domain-name2>,[…]]

Adds/Removes domains to/from server-wide white list - a list of hosts whose mail is accepted without greylisting check-ups.

Used only with the --update-server command.

To add to the server white list domains example.com and sample.net:

plesk bin grey_listing --update-server -domains-whitelist add:example.com,sample.net

-domains-blacklist

<add|del>:<domain-name1>[,<domain-name2>,[…]]

Adds/Removes domains to/from server-wide black list - a list of hosts whose mail is rejected without greylisting check-ups.

Used only with the --update-server command.

To remove from the server black list domains example.com and sample.net:

plesk bin grey_listing --update-server -domains-blacklist del:example.com,sample.net

-service-node-ip

<IP address>

Manage greylisting settings on the specified service node.

To turn on the greylisting service for the domain example.com hosted on the service node with the IP 192.168.1.2:

plesk bin grey_listing -ud example.com -status on -service-node-ip 192.168.1.2

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.