Spamd (Sieve test)

Spamd is a Sieve test implemented as a loadable extension.

Syntax

 spamd [:host <inet-host: string>]
       [:port <inet-port: number> / :socket <unix-socket: string>]
       [:user <name: string>]
       [:over" / :under <limit: string>]

The spamd test is an interface with spamd daemon, which is a part of SpamAssassin mail filter. The test evaluates to True if SpamAssassin recognized the message as spam, or the message spam score satisfies the given relation.

If the argument is :over and the spam score is greater than or equal to the number provided, the test is True; otherwise, it is False.

If the argument is :under and the spam score is less than or equal to the number provided, the test is True; otherwise, it is False.

Spam score is a floating point number. The comparison takes into account three decimal digits.

The spamd socket to use is configured via the :host/:port or :socket tags.

The :host tag instructs spamd to connect to the INET socket on host tcp-host. The :port tag supplies the port to use. If not specified, the spamd default port 783 is assumed.

The :socket tag argument instructs spamd to connect to the given UNIX socket. The argument is an absolute file name of the socket file.

If neither :host not :socket are given, :host 127.0.0.1 :port 783 will be used.

Example

  require "test-spamd";

  if spamd :host "127.0.0.1" :user "gray" :over "9.5"
    {
      discard;
    }