diff options
Diffstat (limited to 'doc/clamsmtpd.conf.5')
-rw-r--r-- | doc/clamsmtpd.conf.5 | 39 |
1 files changed, 3 insertions, 36 deletions
diff --git a/doc/clamsmtpd.conf.5 b/doc/clamsmtpd.conf.5 index f79be11..f528eb9 100644 --- a/doc/clamsmtpd.conf.5 +++ b/doc/clamsmtpd.conf.5 @@ -130,7 +130,9 @@ must be started as root. It will then drop root privileges and run as the specified user. The user can either be a name or a numerical user id. .It Ar VirusAction This is a command to run when a virus is found. See the VIRUS ACTION section -below for a discussion of this option. +in +.Xr clamsmtpd 8 +for a discussion of this option. .El .Sh ADDRESSES Addresses can be specified in multiple formats: @@ -144,41 +146,6 @@ the port number (ie: '127.0.0.1:3310'). .It IPv6 addresses are implemented but disabled. The code needs testing. .El -.Sh VIRUS ACTIONS -Using the -.Ar VirusAction -option you can run a script or program whenever a virus is found. This may -be handy in certain circumstances but it has several drawbacks. For one, the -performance of the virus filtering will take a hit, perhaps DOS'ing your -machine under heavy load. Secondly as with running any program there are -security implications to be considered. -.Pp -.Please consider the above carefully before implementing a virus action. -.Pp -The script is run without its output being logged, or return value being -checked. Because of this you should test it thoroughly. Make sure it runs -without problems under the user that -.Xr clamsmtpd 8 -is being run as. -.Pp -Various environment variables will be present when your script is run: -.Bl -tag -width Fl -.It Ar EMAIL -When the -.Ar Quarantine -option is enabled, this specifies the file that the virus was saved to. -.It Ar RECIPIENTS -The email addresses of the email recipients. These are specified one per -line, in standard address format. -.It Ar SENDER -The email address for the sender of the email. -.It Ar TMP -The path to the temp directory in use. This is the same as the -.Ar TempDirectory -option. -.It Ar VIRUS -The name of the virus found. -.El .Sh SEE ALSO .Xr clamsmtpd 8 .Sh AUTHOR |