rfc2822_header_stringwrite_ex

March 26, 2020 Contributors

Name

rfc2822_header_stringwrite_ex — Renders the rfc2822 header to a string, with formatting options

Synopsis

#include "rfc2822_parser.h"

| string * **rfc2822_header_stringwrite_ex** ( | s, |   |
|   | field, |   |
|   | flags); |   |

string * <var class="pdparam">s</var>;
rfc2822_field * <var class="pdparam">field</var>;
int <var class="pdparam">flags</var>;

Description

Renders the rfc2822 header to a string, with formatting options.

Parameters

s

The string to write to.

field

The header to render.

flags

Zero or more RFC2822_HDR_RENDER_* flags These flags are:

  • RFC2822_HDR_RENDER_NAME – Render the field name and wsp_pad between name and first line

  • RFC2822_HDR_RENDER_FOLD – Render CRLF and wsp_pad between lines (else render a single space)

  • RFC2822_HDR_RENDER_CRLF – End with a CRLF

Return Values

On success this function returns the string passed in; on error, NULL.

Threading

It is legal to call this function in any thread.

See Also

“rfc2822_field”