| SYNOPSIS |
#include <libmilter/mfapi.h>
int smfi_addheader(
SMFICTX *ctx,
char *headerf,
char *headerv
);
Add a header to the current message.
|
|---|
| DESCRIPTION |
| Called When |
Called only from xxfi_eom. |
| Effects |
Adds a header to the current message. |
|
|---|
| ARGUMENTS |
| Argument | Description |
|---|
| ctx |
Opaque context structure.
|
| headerf |
The header name, a non-NULL, null-terminated string.
|
| headerv |
The header value to be added, a non-NULL, null-terminated string.
This may be the empty string.
|
|
|---|
| RETURN VALUES |
smfi_addheader returns MI_FAILURE if:
- headerf or headerv is NULL.
- Adding headers in the current connection state is invalid.
- Memory allocation fails.
- A network error occurs.
- SMFIF_ADDHDRS was not set when smfi_register was called.
Otherwise, it returns MI_SUCCESS.
|
| NOTES |
- smfi_addheader does not change a message's existing headers.
To change a header's current value, use
smfi_chgheader.
- A filter which calls smfi_addheader must have set the SMFIF_ADDHDRS
flag in the smfiDesc_str passed to
smfi_register.
- For smfi_addheader, filter order is important.
Later filters will see the header changes made by earlier ones.
- Neither the name nor the value of the header is checked for
standards compliance.
However, each line of the header must be under 2048 characters
and should be under 998 characters.
If longer headers are needed, make them multi-line.
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 should NOT be preceded by a carriage return (ASCII 0x0d);
the MTA will add this automatically.
It is the filter writer's responsibility to ensure that no standards
are violated.
- The MTA adds a leading space to an added header value unless
the flag
SMFIP_HDR_LEADSPC
is set, in which case the milter
must include any desired leading spaces itself.
|
| EXAMPLE |
int ret;
SMFICTX *ctx;
...
ret = smfi_addheader(ctx, "Content-Type",
"multipart/mixed;\n\tboundary=\"foobar\"");
|