ec_message_render_headers_to_string
Name
ec_message_render_headers_to_string — Renders the headers of the first part of a message to a string
Synopsis
#include "ec_message.h"
| int **ec_message_render_headers_to_string** ( | mess, | |
| | str, | |
| | flags); | |
ec_message * <var class="pdparam">mess</var>;
string * <var class="pdparam">str</var>;
int <var class="pdparam">flags</var>;
Description
Renders the headers of the first part of a message to a string.
- mess
-
A pointer to an ec_message struct. For documentation of this data structure see “ec_message”
- str
-
The target string for the rendering
- flags
-
Flags that control the message parts that are rendered. See the the section called “Related Constants”
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 the 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. This is useful when rendering to a static string to limit the amount of the message being requested
It is legal to call this function in any thread.