smfi_addheader(3N)smfi_addheader(3N)NAMEsmfi_addheader() - adds a header to the current sendmail message
SYNOPSISPARAMETERS
includes the following arguments:
ctx Specifies the opaque context structure.
headerf Specifies the header name, which is a non-NULL, null- termi‐
nated string.
headerv Specifies the header value to be added. headerv is a non-
NULL, null-terminated string and can be an empty string.
DESCRIPTION
adds a header to the current message. can be called only from the
function.
Notes
does not change existing headers of a message. To change the current
value of a header, use the routine.
A filter that calls the must set the flag in the structure passed to
the
For the filter, the order in which filters are placed is important.
Filters placed later in the sequence will observe the changes already
done by the earlier filters.
The name and the value of the header are not checked for standards com‐
pliance. However, each line of the header must be under 2048 charac‐
ters. If longer headers are needed, multi-line header must be used.
To make a multi-line header, insert a line feed (ASCII 0x0a, or \n in
C) followed by at least one whitespace character, such as, a space
(ASCII 0x20) or tab (ASCII 0x09, or \t in C). The line feed must not
be preceded by a carriage return (ASCII 0x0d); the MTA adds this auto‐
matically. It is the responsibility of the filter writer to ensure
that standards are not violated.
RETURN VALUE
returns due to the following reasons:
· The headerf or headerv is
· Adding headers in the current connection state is invalid.
· Memory allocation failure.
· Network error
· is not set when the routine is called.
returns on success.
EXAMPLES
Following is an example to add a header:
AUTHOR
was developed by the Sendmail Inc.
SEE ALSOsmfi_chgheader(3N), smfi_insheader(3N), smfi_addrcpt(3N), smfi_delr‐
cpt(3N), smfi_replacebody(3N).
on
smfi_addheader(3N)
