smfi_insheader(3N)smfi_insheader(3N)NAMEsmfi_insheader() - prepends a header to the current sendmail message
SYNOPSISPARAMETERS
ctx Specifies the opaque context structure.
hdridx Specifies the location in the internal header list where the
header must be inserted. A value of 0 (zero) places the
header in the beginning of the header.
headerf Specifies the header name, which is a non-NULL, null-termi‐
nated string.
headerv Specifies the header value to be added. A header value is a
non-NULL, null-terminated string and can be an empty string.
DESCRIPTION
prepends 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 cur‐
rent value of a header, use the routine.
· A filter that calls must set the flag in the structure passed to the
routine.
· For the filter, the order in which filters are placed is imporant.
Filters placed later in the sequence will observe the changes
already done by the earlier filters.
· If the value of hdridx larger than the number of headers in the mes‐
sage, the header is simply be appended.
· The name and the value of the header are not checked for standards
compliance. However, each line of the header must be under 2048
characters. If longer headers are needed, multi-line header must be
used. To make a multi-line header, insert a linefeed (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 linefeed
must not be preceded by a carriage return (ASCII 0x0d); the MTA adds
this automatically. 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 value is NULL.
· Adding headers in the current connection state is invalid.
· Memory allocation fails.
· Network error occurs.
· is not set when is called.
returns on success.
EXAMPLESAUTHOR
was developed by the Sendmail Inc.
SEE ALSOsmfi_chgheader(3N), smfi_addheader(3N), smfi_addrcpt(3N), smfi_delr‐
cpt(3N), smfi_replacebody(3N).
on
smfi_insheader(3N)