From: Stephan Bosch Date: Wed, 16 Sep 2020 23:26:13 +0000 (+0200) Subject: lib-mail: message-header-encode - Update function descriptions. X-Git-Tag: 2.3.13~108 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=05e84eb74cd9ea2992bac4370916bc4a82acaa96;p=thirdparty%2Fdovecot%2Fcore.git lib-mail: message-header-encode - Update function descriptions. --- diff --git a/src/lib-mail/message-header-encode.h b/src/lib-mail/message-header-encode.h index 1cc9e5f0fa..fdd3b197d7 100644 --- a/src/lib-mail/message-header-encode.h +++ b/src/lib-mail/message-header-encode.h @@ -2,9 +2,13 @@ #define MESSAGE_HEADER_ENCODE_H /* Encode UTF-8 input into output wherever necessary using either Q or B - encoding depending on which takes less space (approximately). Folding - whitespace is preserved. Bare [CR]LF will be preserved by adding a TAB - after it to make it a valid folding whitespace. */ + encoding depending on which takes less space (approximately). The encoded + output is split into multiple lines if necessary (max 76 chars/line). + Existing folding whitespace is preserved. Bare [CR]LF will be preserved by + adding a TAB after it to make it a valid folding whitespace. All the control + characters are encoded, including NUL, CR and LF. Sequences of one or more + invalid UTF-8 characters are replaced by a single Unicode replacement + character (U+fffd). */ void message_header_encode(const char *input, string_t *output); void message_header_encode_data(const unsigned char *input, size_t len, string_t *output); @@ -12,7 +16,9 @@ void message_header_encode_data(const unsigned char *input, size_t len, /* Encode the whole UTF-8 input using "Q" or "B" encoding into output. The output is split into multiple lines if necessary (max 76 chars/line). The first line's length is given as parameter. All the control characters - are encoded, including NUL, CR and LF. */ + are encoded, including NUL, CR and LF. Sequences of one or more invalid UTF-8 + characters are replaced by a single Unicode replacement character (U+fffd). + */ void message_header_encode_q(const unsigned char *input, size_t len, string_t *output, size_t first_line_len); void message_header_encode_b(const unsigned char *input, size_t len,