FORMAIL(1)

Please read the README file in this directory first.

NAME
formail - mail (re)formatter

SYNOPSIS
formail [@FM_SKIP@skip] [@FM_TOTAL@total] [-@FM_VERSION@@FM_BOGUS@@FM_CONCATENATE@@FM_ZAPWHITE@@FM_FORCE@@FM_REPLY@@FM_KEEPB@@FM_TRUST@@FM_EVERY@@FM_DIGEST@@FM_QUIET@@FM_BABYL@@FM_BERKELEY@] [-@FM_QPREFIX@ prefix]
[-@FM_DUPLICATE@ maxlen idcache]
[-@FM_EXTRACT@ headerfield] [-@FM_EXTRC_KEEP@ headerfield]
[-@FM_ADD_IFNOT@ headerfield] [-@FM_ADD_ALWAYS@ headerfield]
[-@FM_REN_INSERT@ headerfield] [-@FM_DEL_INSERT@ headerfield]
[-@FM_FIRST_UNIQ@ headerfield] [-@FM_LAST_UNIQ@ headerfield]
[-@FM_ReNAME@ oldfield newfield]
[-@FM_NOWAIT@ [maxprocs ]] [-@FM_MINFIELDS@ minfields] [-@FM_SPLIT@ [command [arg ...]]]

DESCRIPTION
formail is a filter that can be used to force mail into mailbox format, perform `@FROM@' escaping, generate auto-replying headers, do simple header munging/extracting or split up a mailbox/digest/articles file. The mail/mailbox/article contents will be expected on stdin.

If formail is supposed to determine the sender of the mail, but is unable to find any, it will substitute `@UNKNOWN@'.

If formail is started without any command line options, it will force any mail coming from stdin into mailbox format and will escape all bogus `@FROM@' lines with a `@ESCAP@'.

OPTIONS

-@FM_VERSION@
    Formail will print its version number and exit.

-@FM_BOGUS@
    Don't escape any bogus mailbox headers (i.e. lines starting with `@FROM@').

-@FM_QPREFIX@ prefix
    Define a different quotation prefix. If unspecified it defaults to `@ESCAP@'.

-@FM_BERKELEY@
    Assume traditional Berkeley mailbox format, ignoring any Content-Length: fields.

-@FM_CONCATENATE@
    Concatenate continued fields in the header. Might be convenient when postprocessing mail with standard (line oriented) text utilities.

-@FM_ZAPWHITE@
    Ensure a whitespace exists between field name and content. Zap fields which contain only a single whitespace character. Zap leading and trailing whitespace on fields extracted with -@FM_EXTRACT@.

-@FM_FORCE@
    Force formail to simply pass along any non-mailbox format (i.e. don't generate a `@FROM@' line as the first line).

-@FM_REPLY@
    Generate an auto-reply header. This will normally throw away all the existing fields (except X-Loop:) in the original message, fields you wish to preserve need to be named using the -@FM_REN_INSERT@ option. If you use this option in conjunction with -@FM_KEEPB@, you can prevent the body from being `escaped' by also specifying -@FM_BOGUS@.

-@FM_KEEPB@
    When generating the auto-reply header or when extracting fields, keep the body as well.

-@FM_TRUST@
    Trust the sender to have used a valid return address in his header. This option will be most useful when generating auto-reply headers from news articles. If this option is not turned on, formail tends to favour machine-generated addresses in the header.

-@FM_SPLIT@
    The input will be split up into separate mail messages, and piped into a program one by one (a new program is started for every part). -@FM_SPLIT@ has to be the last option specified, the first argument following it is expected to be the name of a program, any other arguments will be passed along to it. If you omit the program, then formail will simply concatenate the splitted mails on stdout again. See @FILENO@.

-@FM_NOWAIT@ [maxprocs]
    Tell formail not to wait for every program to finish before starting the next (causes splits to be processed in parallel). Maxprocs optionally specifies an upper limit on the number of concurrently running processes.

-@FM_EVERY@
    Do not require empty lines to be preceding the header of a new message (i.e. the messages could start on every line).

-@FM_DIGEST@
    Tell formail that the messages it is supposed to split need not be in strict mailbox format (i.e. allows you to split digests/articles or non-standard mailbox formats). This disables recognition of the Content-Length: field.

-@FM_BABYL@
    Makes formail assume that it is splitting up a BABYL rmail file.

-@FM_MINFIELDS@ minfields
    Allows you to specify the number of consecutive headerfields formail needs to find before it decides it found the start of a new message, it defaults to @DEFminfields@.

-@FM_QUIET@
    Tells formail to (still detect but) be quiet about write errors, duplicate messages and mismatched Content-Length: fields. This option is on by default, to make it display the messages use -@FM_QUIET@-.

-@FM_DUPLICATE@ maxlen idcache
    Formail will detect if the Message-ID of the current message has already been seen using an idcache file of approximately maxlen size. If not splitting, it will return success if a duplicate has been found. If splitting, it will not output duplicate messages. If used in conjunction with -@FM_REPLY@, formail will look at the mail address of the sender instead at the Message-ID.

-@FM_EXTRACT@ headerfield
    Extract the contents of this headerfield from the header, display it as a single line.

-@FM_EXTRC_KEEP@ headerfield
    Same as -@FM_EXTRACT@, but also preserves the field name.

-@FM_ADD_IFNOT@ headerfield
    Append a custom headerfield onto the header; but only if a similar field does not exist yet. If you specify either one of the field names Message-ID: or Resent-Message-ID: with no field contents, then formail will generate a unique message-ID for you.

-@FM_ADD_ALWAYS@ headerfield
    Append a custom headerfield onto the header in any case.

-@FM_REN_INSERT@ headerfield
    Same as -@FM_ADD_ALWAYS@, except that any existing similar fields are renamed by prepending an ``@OLD_PREFIX@'' prefix. If headerfield consists only of a field-name, it will not be appended.

-@FM_DEL_INSERT@ headerfield
    Same as -@FM_REN_INSERT@, except that any existing similar fields are simply removed. If headerfield consists only of a field-name, it effectively deletes the field.

-@FM_FIRST_UNIQ@ headerfield
    Make the first occurrence of this field unique, and thus delete all subsequent occurrences of it.

-@FM_LAST_UNIQ@ headerfield
    Make the last occurrence of this field unique, and thus delete all preceding occurrences of it.

-@FM_ReNAME@ oldfield newfield
    Renames all occurrences of the fieldname oldfield into newfield.

@FM_SKIP@skip
    Skip the first skip messages while splitting.

@FM_TOTAL@total
    Output at most total messages while splitting.

ENVIRONMENT

@FILENO@
    While splitting, formail assigns the message number currently being output to this variable. By presetting @FILENO@, you can change the initial message number being used and the width of the zero-padded output. If @FILENO@ is unset it will default to @DEFfileno@. If @FILENO@ is non-empty and does not contain a number, @FILENO@ generation is disabled.

EXAMPLES
To split up a digest one usually uses:
    formail @FM_SKIP@1 -@FM_DIGEST@@FM_SPLIT@ >>the_mailbox_of_your_choice
or
    formail @FM_SKIP@1 -@FM_DIGEST@@FM_SPLIT@ procmail

To remove all Received: fields from the header:
    formail -@FM_DEL_INSERT@ Received:

To remove all fields except From: and Subject: from the header:
    formail -@FM_KEEPB@ -@FM_EXTRC_KEEP@ From: -@FM_EXTRC_KEEP@ Subject:

To supersede the Reply-To: field in a header you could use:
    formail -@FM_REN_INSERT@ "Reply-To: foo@bar"

To convert a non-standard mailbox file into a standard mailbox file you can use:
    formail -@FM_DIGEST@@FM_SPLIT@ <old_mailbox >>new_mailbox

Or, if you have a very tolerant mailer:
    formail -@FM_ADD_IFNOT@ Date: -@FM_DIGEST@@FM_SPLIT@ <old_mailbox >>new_mailbox

To extract the header from a message:
    formail -@FM_EXTRC_KEEP@ ""
or
    sed -e '/^$/ q'

To extract the body from a message:
    formail -@FM_DEL_INSERT@ ""
or
    sed -e '1,/^$/ d'

SEE ALSO
mail(1), binmail(1), sendmail(8), procmail(1), sed(1), sh(1), RFC822, RFC1123

DIAGNOSTICS

Can't fork
    Too many processes on this machine.

Content-Length: field exceeds actual length by nnn bytes
    The Content-Length: field in the header specified a length that was longer than the actual body. This causes this message to absorb a number of subsequent messages following it in the same mailbox.

Couldn't write to stdout
    The program that formail was trying to pipe into didn't accept all the data formail sent to it; this diagnostic can be suppressed by the -@FM_QUIET@ option.

Duplicate key found: x
    The Message-ID or sender x in this message was found in the idcache; this diagnostic can be suppressed by the -@FM_QUIET@ option.

Failed to execute "x"
    Program not in path, or not executable.

File table full
    Too many open files on this machine.

Invalid field-name: "x"
    The specified field-name "x" contains control characters, or cannot be a partial field-name for this option.

WARNINGS
You can save yourself and others a lot of grief if you try to avoid using this autoreply feature on mails coming through mailinglists. Depending on the format of the incoming mail (which in turn depends on both the original sender's mail agent and the mailinglist setup) formail could decide to generate an autoreply header that replies to the list.

BUGS
When formail has to generate a leading `@FROM@' line it normally will contain the current date. If formail is given the option `-@FM_ADD_IFNOT@ Date:', it will use the date from the `Date:' field in the header (if present). However, since formail copies it verbatim, the format will differ from that expected by most mail readers.

If formail is instructed to delete or rename the leading `@FROM@' line, it will not automatically regenerate it as usual. To force formail to regenerate it in this case, include -@FM_ADD_IFNOT@ '@FROM@'.

If formail is not called as the first program in a pipe and it is told to split up the input in several messages, then formail will not terminate until the program it receives the input from terminates itself.

If formail is instructed to generate an autoreply mail, it will never put more than one address in the `To:' field.

MISCELLANEOUS
Formail is eight-bit clean.

When formail has to determine the sender's address, every RFC822 conforming mail address is allowed. Formail will always strip down the address to its minimal form (deleting excessive comments and whitespace).

The regular expression that is used to find `real' postmarks is:
    "\n\n@FROM@[\t ]*[^\t\n ]+[\t ]+[^\n\t ]"

If a Content-Length: field is found in a header, formail will copy the number of specified bytes in the body verbatim before resuming the regular scanning for message boundaries (except when splitting digests or Berkeley mailbox format is assumed).

NOTES
Calling up formail with the -@HELPOPT1@ or -@HELPOPT2@ options will cause it to display a command-line help page.