Manual Pages for UNIX Darwin command on man pipe

PIPE(8) PIPE(8)

NAME

pipe - Postfix delivery to external command

SYNOPSIS

ppiippee [generic Postfix daemon options] commandattributes...

DESCRIPTION

The ppiippee daemon processes requests from the Postfix queue manager to deliver messages to external commands. This program expects to be run from the mmaasstteerr(8) process manager.

Message attributes such as sender address, recipient address and next-

hop host name can be specified as command-line macros that are expanded

before the external command is executed. The ppiippee daemon updates queue files and marks recipients as finished, or it informs the queue manager that delivery should be tried again at a later time. Delivery status reports are sent to the bboouunnccee(8), ddeeffeerr(8) or ttrraaccee(8) daemon as appropriate.

SSIINNGGLLEE-RREECCIIPPIIEENNTT DDEELLIIVVEERRYY

Some external commands cannot handle more than one recipient per deliv-

ery request. Examples of such transports are pagers, fax machines, and so on. To prevent Postfix from sending multiple recipients per delivery request, specify transportddeessttiinnaattiioonnrreecciippiieennttlliimmiitt == 11 in the Postfix mmaaiinn..ccff file, where transport is the name in the first

column of the Postfix mmaasstteerr..ccff entry for the pipe-based delivery

transport. CCOOMMMMAANNDD AATTTTRRIIBBUUTTEE SSYYNNTTAAXX The external command attributes are given in the mmaasstteerr..ccff file at the end of a service definition. The syntax is as follows: ffllaaggss==BBDDFFOORRhhqquu..>> (optional) Optional message processing flags. By default, a message is copied unchanged. BB Append a blank line at the end of each message. This is required by some mail user agents that recognize "FFrroomm " lines only when preceded by a blank line.

DD Prepend a "DDeelliivveerreedd-TToo:: recipient" message header with

the envelope recipient address. Note: for this to work, the transportddeessttiinnaattiioonnrreecciippiieennttlliimmiitt must be 1. FF Prepend a "FFrroomm sender timestamp" envelope header to the message content. This is expected by, for example, UUUUCCPP software.

OO Prepend an "XX-OOrriiggiinnaall-TToo:: recipient" message header with

the recipient address as given to Postfix. Note: for this to work, the transportddeessttiinnaattiioonnrreecciippiieennttlliimmiitt must be 1.

RR Prepend a RReettuurrnn-PPaatthh:: message header with the envelope

sender address.

hh Fold the command-line $$rreecciippiieenntt domain name and $$nneexxtthhoopp

host name to lower case. This is recommended for deliv-

ery via UUUUCCPP. qq Quote white space and other special characters in the

command-line $$sseennddeerr and $$rreecciippiieenntt address localparts

(text to the left of the right-most @@ character), accord-

ing to an 8-bit transparent version of RFC 822. This is

recommended for delivery via UUUUCCPP or BBSSMMTTPP.

The result is compatible with the address parsing of com-

mand-line recipients by the Postfix sseennddmmaaiill mail submis-

sion command. The qq flag affects only entire addresses, not the partial

address information from the $$uusseerr, $$eexxtteennssiioonn or $$mmaaiill-

bbooxx command-line macros.

uu Fold the command-line $$rreecciippiieenntt address localpart (text

to the left of the right-most @@ character) to lower case.

This is recommended for delivery via UUUUCCPP. .. Prepend .. to lines starting with "..". This is needed by, for example, BBSSMMTTPP software. >> Prepend >> to lines starting with "FFrroomm ". This is expected by, for example, UUUUCCPP software. uusseerr=username (required) uusseerr=username:groupname

The external command is executed with the rights of the speci-

fied username. The software refuses to execute commands with root privileges, or with the privileges of the mail system owner. If groupname is specified, the corresponding group ID is used instead of the group ID of username. eeooll==ssttrriinngg (optional, default: \\nn) The output record delimiter. Typically one would use either \\rr\\nn

or \\nn. The usual C-style backslash escape sequences are recog-

nized: \\aa \\bb \\ff \\nn \\rr \\tt \\vv \\octal and \\\\. ssiizzee=sizelimit (optional) Messages greater in size than this limit (in bytes) will be bounced back to the sender. aarrggvv=command... (required) The command to be executed. This must be specified as the last

command attribute. The command is executed directly, i.e. with-

out interpretation of shell meta characters by a shell command interpreter.

In the command argument vector, the following macros are recog-

nized and replaced with corresponding information from the Post-

fix queue manager delivery request:

$${{eexxtteennssiioonn}

This macro expands to the extension part of a recipient address. For example, with an address user+foo@domain the extension is foo.

A command-line argument that contains $${{eexxtteennssiioonn}

expands into as many command-line arguments as there are

recipients.

This information is modified by the uu flag for case fold-

ing.

$${{mmaaiillbbooxx}

This macro expands to the complete local part of a recip-

ient address. For example, with an address user+foo@domain the mailbox is user+foo.

A command-line argument that contains $${{mmaaiillbbooxx} expands

into as many command-line arguments as there are recipi-

ents.

This information is modified by the uu flag for case fold-

ing.

$${{nneexxtthhoopp}

This macro expands to the next-hop hostname.

This information is modified by the hh flag for case fold-

ing.

$${{rreecciippiieenntt}

This macro expands to the complete recipient address.

A command-line argument that contains $${{rreecciippiieenntt}

expands into as many command-line arguments as there are

recipients. This information is modified by the hhqquu flags for quoting and case folding.

$${{sseennddeerr}

This macro expands to the envelope sender address. This information is modified by the qq flag for quoting.

$${{ssiizzee}

This macro expands to Postfix's idea of the message size, which is an approximation of the size of the message as delivered.

$${{uusseerr}

This macro expands to the username part of a recipient address. For example, with an address user+foo@domain the username part is user.

A command-line argument that contains $${{uusseerr} expands

into as many command-line arguments as there are recipi-

ents.

This information is modified by the uu flag for case fold-

ing.

In addition to the form ${name}, the forms $name and $(name) are also

recognized. Specify $$$$ where a single $$ is wanted.

DIAGNOSTICS Command exit status codes are expected to follow the conventions defined in . Problems and transactions are logged to ssyyssllooggdd(8). Corrupted message files are marked so that the queue manager can move them to the ccoorrrruupptt queue for further inspection. SSEECCUURRIITTYY This program needs a dual personality 1) to access the private Postfix queue and IPC mechanisms, and 2) to execute external commands as the specified user. It is therefore security sensitive. CCOONNFFIIGGUURRAATTIIOONN PPAARRAAMMEETTEERRSS

Changes to mmaaiinn..ccff are picked up automatically as pipe(8) processes run

for only a limited amount of time. Use the command "ppoossttffiixx rreellooaadd" to speed up a change. The text below provides only a parameter summary. See postconf(5) for more details including examples. RREESSOOUURRCCEE AANNDD RRAATTEE CCOONNTTRROOLLSS In the text below, transport is the first field in a mmaasstteerr..ccff entry.

transportddeessttiinnaattiioonnccoonnccuurrrreennccyylliimmiitt (($$ddeeffaauullttddeessttiinnaattiioonnccoonnccuurr-

rreennccyylliimmiitt)) Limit the number of parallel deliveries to the same destination, for delivery via the named transport. The limit is enforced by the Postfix queue manager.

transportddeessttiinnaattiioonnrreecciippiieennttlliimmiitt (($$ddeeffaauullttddeessttiinnaattiioonnrreecciippii-

eennttlliimmiitt))

Limit the number of recipients per message delivery, for deliv-

ery via the named transport. The limit is enforced by the Post-

fix queue manager.

transportttiimmeelliimmiitt (($$ccoommmmaannddttiimmeelliimmiitt))

Limit the time for delivery to external command, for delivery

via the named transport. The limit is enforced by the pipe

delivery agent. MMIISSCCEELLLLAANNEEOOUUSS CCOONNTTRROOLLSS

ccoonnffiiggddiirreeccttoorryy ((sseeee ''ppoossttccoonnff -dd'' oouuttppuutt))

The default location of the Postfix main.cf and master.cf con-

figuration files. ddaaeemmoonnttiimmeeoouutt ((1188000000ss)) How much time a Postfix daemon process may take to handle a

request before it is terminated by a built-in watchdog timer.

eexxppoorrtteennvviirroonnmmeenntt ((sseeee ''ppoossttccoonnff -dd'' oouuttppuutt))

The list of environment variables that a Postfix process will

export to non-Postfix processes.

iippccttiimmeeoouutt ((33660000ss)) The time limit for sending or receiving information over an internal communication channel. mmaaiilloowwnneerr ((ppoossttffiixx)) The UNIX system account that owns the Postfix queue and most Postfix daemon processes. mmaaxxiiddllee ((110000ss)) The maximum amount of time that an idle Postfix daemon process waits for the next service request before exiting. mmaaxxuussee ((110000))

The maximal number of connection requests before a Postfix dae-

mon process terminates.

pprroocceessssiidd ((rreeaadd-oonnllyy))

The process ID of a Postfix command or daemon process.

pprroocceessssnnaammee ((rreeaadd-oonnllyy))

The process name of a Postfix command or daemon process.

qquueeuueeddiirreeccttoorryy ((sseeee ''ppoossttccoonnff -dd'' oouuttppuutt))

The location of the Postfix top-level queue directory.

rreecciippiieennttddeelliimmiitteerr ((eemmppttyy)) The separator between user names and address extensions (user+foo). ssyyssllooggffaacciilliittyy ((mmaaiill)) The syslog facility of Postfix logging. ssyyssllooggnnaammee ((ppoossttffiixx)) The mail system name that is prepended to the process name in

syslog records, so that "smtpd" becomes, for example, "post-

fix/smtpd".