MAN page from OpenSuSE amavisd-new-docs-2.8.0-26.1.i586.rpm

amavisd-milter

Section: Maintenance Commands (8)
Index
BSD mandoc

NAME

amavisd-milter - sendmail milter for amavisd-new

SYNOPSIS

[-fhv][-d debug-level][-D delivery-care-of][-m max-conns][-M max-wait][-p pidfile][-P][-q backlog][-s socket][-t timeout][-S socket][-T timeout][-w directory]

DESCRIPTION

Theis a sendmail milter (mail filter) foramavisd-new2.4.3 and above andsendmail8.13 and above (limited support for 8.12 is provided).

Instead of olderamavis-milterhelper program, fullamavisd-newfunctionality is available, including adding spam and virus informationheader fields, modifying Subject, adding address extensions and removingcertain recipients from delivery while delivering the same message tothe rest.

For more information you can visit amavisd-milter website:

http://amavisd-milter.sourceforge.net/

and SourceForge project:

http://sourceforge.net/projects/amavisd-milter

Options

The options are as follows:

-d debug-level

Set the debug level to debug-level .Debugging traces become more verbose as the debug level increases.Maximum is 9.

-D delivery-care-of

Set AM.PDP request attribute delivery_care_of toclient(default) orserver . Whenclientmethod is used thenamavisd-milteris responsible to forward the message to recipients. This method doesn'tallow personalized header or body modification.

Whenservermethod is used thenamavisd-newis responsible to forward the message to recipients and can providepersonalized header and body modification.$forward_method in amavisd.conf must point to some place willing to acceptmail without further checking inamavisd-new .

-f

Runin the foreground (i.e. do not daemonize).Print debug messages to the terminal.

-h

Print help page and exit.

-m max-conns

Maximum concurrentamavisdconnections (default 0 - unlimited number of connections).It must agree with the $max_servers entry in amavisd.conf.

-M max-wait

Maximum wait for connection toamavisdin seconds (default 300 = 5 minutes).It must be less then sending MTA timeout for a response to the final "."that terminates a message on sending MTA.sendmailhas default value 1 hour,postfix10 minutes andqmail20 minutes.We suggest to use less than 10 minutes.

-p pidfile

Use this pid file (default /var/amavis/amavisd-milter.pid).

-P

Whenamavisd-newfails mail will be passed through unchecked.

-q backlog

Sets the incoming socket backlog used bylisten(2).If it is not set or set to zero, the operating system default is used.

-s socket

Communication socket betweensendmailand(default /var/amavis/amavisd-milter.sock).The protocol spoken over this socket isMILTER(Mail FILTER).It must agree with the INPUT_MAIL_FILTER entry in sendmail.mc

Thesocketshould be in "proto:address" format:

{unix|local}:/path/to/file- A named pipe.
inet:port@{hostname|ip-address}- An IPV4 socket.
inet6:port@{hostname|ip-address}- An IPV6 socket.

-S socket

Communication socket betweenandamavisd-new(default /var/amavis/amavisd.sock).The protocol spoken over this socket isAM.PDP(AMavis Policy Delegation Protocol).It must agree with the $unix_socketname entry in amavisd.conf.

Thesocketshould be in "proto:address" format:

{unix|local}:/path/to/file- A named pipe.

-t timeout

sendmailconnection timeout in seconds (default 600 = 10 minutes).It must agree with the INPUT_MAIL_FILTER entry in sendmail.mc and must begreater than or equal to theamavisd-newconnection timeout.When you use other milters (especially time-consuming), the timeout must besufficient to process message in all milters.

-T timeout

amavisd-newconnection timeout in seconds (default 600 = 10 minutes).This timeout must be sufficient for message processing inamavisd-new .It's usually a good idea to adjust them to the same value assendmailconnection timeout.

-v

Report the version number and exit.

-w directory

Set working directory (default /var/amavis).

Limited support for sendmail 8.12

Fn smfi_addheaderis used instead ofFn smfi_insheaderforinsheaderandaddheaderAM.PDP responses. This works well withamavisd-new2.4.3 or newer.
Fn smfi_progressisn't called whenamavisd-milterwait foramavisd-newcommunication socket.
AM.PDP responsequarantineisn't implemented.

FILES

/var/amavis/amavisd-milter.pid: The default process-id file.
/var/amavis/amavisd-milter.sock: The defaultsendmailcommunication socket.
/var/amavis/amavisd.sock: Th defaultamavisd-newcommunication socket.
/var/amavis: The default working directory.

POLICY BANK

When remote client is authenticated,amavisd-milterforward this information toamavisd-newthrough AM.PDP request attributepolicy_bank :

SMTP_AUTH: Indicate that the remote client is authenticated.
SMTP_AUTH_<MECH>: Remote client authentication mechanism.
SMTP_AUTH_<MECH>_<BITS>: The number of bits used for the key of the symmetric cipher whenauthentication mechanism use it.

EXAMPLES

Configuring amavisd-new

In amavisd.conf file change protocol and socket settings to:

$protocol = "AM.PDP";                      # Use AM.PDP protocol$unix_socketname = "$MYHOME/amavisd.sock"; # Listen on Unix socket### $inet_socket_port = 10024;             # Don't listen on TCP port

Then (re)start amavisd daemon.

Configuring sendmail

To the sendmail.mc file add the following entries:

define(`confMILTER_MACROS_ENVFROM',        confMILTER_MACROS_ENVFROM`, r, b')INPUT_MAIL_FILTER(`amavisd-milter',        `S=local:/var/amavis/amavisd-milter.sock,        F=T, T=S:10m;R:10m;E:10m')

Then rebuild your sendmail.cf file, install it (usually to/etc/mail/sendmail.cf) and (re)start sendmail daemon.

Running

This example assume thatamavisd-newis running as useramavis .It must agree with the entry $daemon_user in amavisd.conf.

First create working directory:

mkdir /var/amavis/tmpchmod 750 /var/amavis/tmpchown amavis /var/amavis/tmp

Then startas non-priviledged user amavis:

su - amavis -c " -w /var/amavis/tmp

Limiting maximum concurrent connections to amavisd

To limit concurrent connections to 4 and fail after 10 minutes(10*60 secs) of waiting runwith this options:

su - amavis -c " -w /var/amavis/tmp -m 4 -M 600

Troubleshooting

For troubleshooting runon the foreground and set debug level to appropriate level:

su - amavis -c " -w /var/amavis/tmp -f -d level

where debug levels are:

1: Not errors but unexpected states (connection abort etc).
2: Main states in message processing.
3: Alldebug messages.
4-9: Milter communication debugging (smfi_setdbg 1-6).

AUTHORS

This manual page was written by Petr Rehor <rxAATTrx.cz> and is based onJerzy Sakol <jerzy.sakolAATTcommgraf.pl> initial work.

BUGS

A community mailing lists are available at:

http://sourceforge.net/mail/?group_id=138169

Enhancements, requests and problem reports are welcome.

If you run into problems first check the users mailing list archivebefore asking questions on the list.It's highly likely somebody has already come across the same problemand it's been solved.

Index

NAME

SYNOPSIS

DESCRIPTION

Options
Limited support for sendmail 8.12

FILES

POLICY BANK

EXAMPLES

Configuring amavisd-new
Configuring sendmail
Running Nm
Limiting maximum concurrent connections to amavisd
Troubleshooting

SEE ALSO

AUTHORS

BUGS

This document was created byman2html,using the manual pages.