Update Greylisting settings

This function modifies the server's Greylisting configuration settings.

Important:

When you call this function, you must include at least one of the following parameters:

  • spf_bypass
  • child_timeout_secs
  • record_exp_time_mins
  • initial_block_time_mins
  • max_child_procs
  • purge_interval_mins
  • must_try_time_mins
Authorizations:
query Parameters
child_timeout_secs
integer >= 1

The maximum of seconds that Greylisting waits for a child process to timeout.

Note:

This parameter affects the function of the cPGreyList daemon. Do not change this value unless it is absolutely necessary.

Example: child_timeout_secs=5
initial_block_time_mins
integer [ 1 .. 240 ]

The number of minutes during which Greylisting defers email from an unknown triplet. The maximum value for this parameter is four hours (240 minutes).

Example: initial_block_time_mins=10
max_child_procs
integer >= 1

The maximum number of child processes.

Notes:

This parameter affects the function of the cPGreyList daemon. Do not change this value unless it is absolutely necessary.

Example: max_child_procs=5
must_try_time_mins
integer [ 1 .. 1440 ]

The number of minutes during which Greylisting accepts a re-sent email from an unknown triplet. The maximum value for this parameter is one day (1440 minutes).

Example: must_try_time_mins=240
purge_interval_mins
integer >= 1

The number of minutes before Greylisting deletes the records in the Greylisting database.

Note:

This parameter affects the function of the cPGreyList daemon. Do not change this value unless it is absolutely necessary.

Example: purge_interval_mins=60
record_exp_time_mins
integer [ 1 .. 43200 ]

The number of minutes before Greylisting deletes the triplet record and treats a re-sent email as coming from a new, unknown triplet. The maximum value for this parameter is 30 days (43200 minutes).

Example: record_exp_time_mins=4320
spf_bypass
integer

Whether emails with SPF bypass Greylisting.

  • 1 — Enabled.
  • 0 — Disabled.
Enum: 1 0
Example: spf_bypass=1

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  save_cpgreylist_config

Response samples

Content type
application/json
{
  • "data": {
    • "cpgreylist_config": {
      • "child_timeout_secs": 5,
      • "initial_block_time_mins": 10,
      • "is_enabled": 1,
      • "is_exim_enabled": 1,
      • "max_child_procs": 5,
      • "must_try_time_mins": 240,
      • "purge_interval_mins": 60,
      • "record_exp_time_mins": 4320,
      • "spf_bypass": 1
      }
    },
  • "metadata": {
    • "command": "save_cpgreylist_config",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}