Skip to content

Clamsmtp

services.clamsmtp.enable

Whether to enable clamsmtp. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances

Instances of clamsmtp to run. Type: list of (submodule)

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.action

Action to take when a virus is detected.

Note that viruses often spoof sender addresses, so bouncing is in most cases not a good idea.

Type: one of "bounce", "drop", "pass"

Default

"drop"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.header

A header to add to scanned messages. See clamsmtpd.conf(5) for more details. Empty means no header.

Type: string

Default

""

Example

"X-Virus-Scanned: ClamAV using ClamSMTP"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.keepAlives

Number of seconds to wait between each NOOP sent to the sending server. 0 to disable.

This is meant for slow servers where the sending MTA times out waiting for clamd to scan the file.

Type: signed integer

Default

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.listen

Address to wait for incoming SMTP connections on. See clamsmtpd.conf(5) for more details.

Type: string

Example

"127.0.0.1:10025"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.maxConnections

Maximum number of connections to accept at once. Type: signed integer

Default

64

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.outAddress

Address of the SMTP server to send email to once it has been scanned.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.quarantine

Whether to quarantine files that contain viruses by leaving them in the temporary directory.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.tempDirectory

Temporary directory that needs to be accessible to both clamd and clamsmtpd.

Type: string

Default

"/tmp"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.timeout

Time-out for network connections. Type: signed integer

Default

180

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.transparentProxy

Enable clamsmtp's transparent proxy support. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.virusAction

Command to run when a virus is found. Please see VIRUS ACTION in clamsmtpd(8) for a discussion of this option and its safe use.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix

services.clamsmtp.instances.*.xClient

Send the XCLIENT command to the receiving server, for forwarding client addresses and connection information if the receiving server supports this feature.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/mail/clamsmtp.nix