Skip to content

Latest commit

 

History

History
180 lines (98 loc) · 3.94 KB

README.md

File metadata and controls

180 lines (98 loc) · 3.94 KB
Raw

Build Status Code Climate NPM

haraka-plugin-rspamd

This plugin facilitates scanning messages with Rspamd.

Configuration

rspamd.ini

  • host

    Default: localhost

    Host to connect to to query Rspamd.

  • port

    Default: 11333

    Port Rspamd is listening on.

  • unix_socket

    Path to a unix socket to connect to. If set, overrides host and port.

  • add_headers

    Default: sometimes

    Possible values are:

      "always" - always add headers
  "never" - never add headers (unless provided by rspamd - see rmilter_headers)
  "sometimes" - add headers when rspamd recommends `add header` action

    Format of these headers is governed by header.* settings

  • reject.message

    Default: Detected as spam

    Message to send when rejecting mail due to Rspamd policy recommendation.

  • reject.spam

    Default: true

    If set to false, ignore recommended reject action from Rspamd (except for authenticated users).

  • reject.authenticated

    Default: false

    Reject messages from authenticated users if Rspamd recommends reject.

  • check.authenticated

    Default: false

    If true, messages from authenticated users will be scanned by Rspamd.

  • check.relay

    Default: false

    If true, messages from relay clients will be scanned by Rspamd.

  • check.private_ip

    Default: false

    If false, messages from private IPs will not be scanned by Rspamd. If true, messages from private IPs will be scanned by Rspamd.

  • check.local_ip

    Default: false

    If false, messages from localhost will not be scanned by Rspamd. If true, messages from localhost will be scanned by Rspamd.

  • dkim.enabled

    Default: true

    If set to true, allow rspamd to add DKIM signatures to messages.

  • header.bar

    Default: undefined

    If set, add a visual spam level in a header with this name.

  • header.report

    Default: undefined

    If set, add information about symbols matched & their scores in a header with this name.

  • header.score

    Default: undefined

    If set, add the numeric spam score in a header with this name.

  • rewrite_subject.enabled

    Default: true

    If set to true, "rewrite subject" action is honored.

  • rmilter_headers.enabled

    Default: true

    If set to true, allow rspamd to add/remove headers to messages via task:set_milter_reply().

  • smtp_message.enabled

    Default: true

    If set to true, "smtp_message" provided by Rspamd is used in response for "reject" & "soft reject" actions.

  • soft_reject.enabled

    Default: true

    If set to true, allow rspamd to defer messages.

  • soft_reject.message

    Default: Deferred by policy

    Message to send to remote server on rspamd soft rejection.

  • spambar.positive

    Default: +

    Used as character for visual spam-level where score is positive.

  • spambar.negative

    Default: -

    Used as character for visual spam-level where score is negative.

  • spambar.neutral

    Default: /

    Used as character for visual spam-level where score is zero.

  • subject

    Default: [SPAM] %s

    Subject to use for rewrite subject action if Rspamd does not provide one.

  • timeout (in seconds)

    Default: 29 seconds

    How long to wait for a response from rspamd.