3.10.1 Invoking mail.local

General usage of mail.local program is:

mail.local [option...] recipient [recipient ...]

If recipient part is present is a FQDN, mail.local will attempt to deliver to a virtual host. The program uses following option groups: See section 3.1.2 Mailbox, See section 3.1.6 Auth, See section 3.1.8 Logging, See section 3.8 sieve.

`-f addr'

`--from addr'

Specify the sender's name. This option forces mail.local to add `From ' envelope to the beginning of the message. If it is not specified, mail.local first looks into the first line from the standard input. If it starts with `From ', it is assumed to contain a valid envelope. If it does not, mail.local creates the envelope by using current user name and date.

`-h'

`--help'

Display usage summary and exit.

`-L'

`--license'

Display GNU General Public License and exit.

`-m path'

`--mail-spool path'

Specify path to mailspool directory.

`-q'

`--quota-db file'

Specify path to DBM mailbox quota database (see section 3.10.3 Setting up Mailbox Quotas).

`--quota-query'

Specify SQL query that should be used to obtain user mailbox quotas from the SQL database (see section 3.10.3 Setting up Mailbox Quotas).

`-s pattern'

`--source pattern'

Set name pattern for user-defined mail filters written in Scheme (see section 3.10.5 Implementing User-defined Scheme Mail Filters). The metacharacters `%u' and `%h' in the pattern are expanded to the current recipient user name and home directory correspondingly.

This option is available only if the package has been configured to use Guile extension language.

`-S pattern'

`--sieve pattern'

Set name pattern for user-defined mail filters written is Sieve (see section 3.10.4 Implementing User-defined Sieve Mail Filters). The metacharacters `%u' and `%h' in the pattern are expanded to the current recipient user name and home directory correspondingly.

`-t number'

`--timeout number'

Wait number seconds for acquiring the lockfile. If it doesn't become available after that amount of time, return failure. The timeout defaults to 5 minutes.

`-x flags'

`--debug flags'

Enable debugging. The debugging information will be output using syslog. The flags is a string consisting of the following flags: Debug flags are:

`g'

Start with guile debugging evaluator and backtraces. This is convenient for debugging user-defined filters (see section 3.10.5 Implementing User-defined Scheme Mail Filters).

`T'

Enable libmailutil traces (MU_DEBUG_TRACE).

`P'

Enable network protocol traces (MU_DEBUG_PROT)

`t'

Enable sieve trace (MU_SIEVE_DEBUG_TRACE)

`l'

Enable sieve action logs

The digits in the range `0' -- `9' used in flags set mail.local debugging level.

`-v'

`--version'

Display program version and exit.

`--ex-multiple-delivery-success'

Don't return errors when delivering to multiple recipients.

`--ex-quota-tempfail'

Return temporary failure if disk or mailbox quota is exceeded. By default, 'service unavailable' is returned if the message exceeds the mailbox quota.