ec_message_extract_part_to_string
Name
ec_message_extract_part_to_string — Extract a message part to a string, decoding transfer encoding
Synopsis
#include "ec_message.h"
| int **ec_message_extract_part_to_string** (
| part, | |
| | str, | |
| | desired_charset)
; | |
ec_message_part * <var class="pdparam">part</var>
;
string * <var class="pdparam">str</var>
;
const char * <var class="pdparam">desired_charset</var>
;
Description
Note
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.
Extract a message part to a string, decoding transfer encoding.
- part
-
the message part to be extracted
- str
-
the string to render into
- desired_charset
-
the character set to use for textual parts
Returns the length of the rendered output in bytes.
- EC_MSG_RENDER_OMIT_DOT
-
omit the trailing SMTP termination dot from the rendition
- EC_MSG_RENDER_CALCULATE_LENGTH_ONLY
-
calculate the length only
- EC_MSG_RENDER_HEADERS_ONLY
-
render the rfc2822 headers only
- EC_MSG_RENDER_XML
-
render the output in an XML based format
- EC_MSG_RENDER_OMIT_HEADERS
-
don't render the rfc2822 headers
- EC_MSG_RENDER_OMIT_EPILOGUE
-
don't include epilogue
- EC_MSG_RENDER_UNSTUFFED
-
remove SMTP dot stuffing while rendering, and use LF instead of CRLF
- EC_MSG_RENDER_DEBUG
-
enable additional output in debugging mode
- EC_MSG_RENDER_AVOID_IO
-
don't incur disk IO if we can avoid it
- EC_MSG_RENDER_SUPPRESS_WRITE_ERRORS
-
don't log write errors, useful when rendering to a static string to limit the amount of the message being requested