ec_message_part_extract — Prepare to extract a message part in a streaming fashion
io_object * **ec_message_part_extract** ( | part, | |
| | desired_charset
); | |
This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.
Prepare to extract a message part in a streaming fashion.
the message part to be extracted
the character set to use for textual parts.
If desired_charset is NULL, then no decoding will be performed; the stream will simply return the message part as it appears in the body.
If desired_charset is "/transfer-decode-only/" then only transfer decoding will be performed; the stream will supply the octets after decoding the transfer-encoding for that part.
Returns an io_object that will produce the decoded part when read.
While the io_object returned from this function is active, you should not perform operations on the message that might seek the io object that underpins the message, otherwise you will confuse the extractor or vice versa.
omit the trailing SMTP termination dot from the rendition
calculate the length only
render the rfc2822 headers only
render the output in an XML based format
don’t render the rfc2822 headers
don’t include epilogue
remove SMTP dot stuffing while rendering, and use LF instead of CRLF
enable additional output in debugging mode
don’t incur disk IO if we can avoid it
don’t log write errors, useful when rendering to a static string to limit the amount of the message being requested