KMime::HeaderParsing Namespace

Function Documentation

void HeaderParsing::eatCFWS(const char *&scursor, const char *const send, KMime::NewlineType newline)

Eats comment-folding-white-space, skips whitespace, folding and comments (even nested ones) and stops at the next non-CFWS character. After calling this function, you should check whether scursor == send (end of header reached).

If a comment with unbalanced parentheses is encountered, scursor is being positioned on the opening '(' of the outmost comment.

scursor pointer to the first character beyond the initial '=' of the input string.

send pointer to end of input buffer.

newline whether the input string is terminated with CRLF or LF.

void HeaderParsing::eatCFWS(const char *&scursor, const char *const send, KMime::NewlineType newline, KMime::HeaderParsing::ParserState &state)

Eats comment-folding-white-space, skips whitespace, folding and comments (even nested ones) and stops at the next non-CFWS character. After calling this function, you should check whether scursor == send (end of header reached).

If a comment with unbalanced parentheses is encountered, scursor is being positioned on the opening '(' of the outmost comment.

scursor pointer to the first character beyond the initial '=' of the input string.

send pointer to end of input buffer.

newline whether the input string is terminated with CRLF or LF.

state Parser state between different calls on the same header. Use when possible to prevent quadratic behavior on invalid nested comments.

void HeaderParsing::extractHeaderAndBody(const QByteArray &content, QByteArray &header, QByteArray &body)

Extract the header header and the body from a complete content.

Internally, it will simply look for the first newline and use that as a separator between the header and the body.

content the complete mail

header return value for the extracted header

body return value for the extracted body

bool HeaderParsing::parseAddress(const char *&scursor, const char *const send, KMime::Types::Address &result, KMime::NewlineType newline = NewlineType::LF)

bool HeaderParsing::parseAddressList(const char *&scursor, const char *const send, QList<KMime::Types::Address> &result, KMime::NewlineType newline = NewlineType::LF)

bool HeaderParsing::parseAtom(const char *&scursor, const char *const send, QByteArrayView &result, KMime::HeaderParsing::ParsingPolicy parsingPolicy = ParsingPolicy::Allow7BitOnly)

You may or may not have already started parsing into the atom. This function will go on where you left off.

bool HeaderParsing::parseGroup(const char *&scursor, const char *const send, KMime::Types::Address &result, KMime::NewlineType newline = NewlineType::LF)

bool HeaderParsing::parseMailbox(const char *&scursor, const char *const send, KMime::Types::Mailbox &result, KMime::NewlineType newline = NewlineType::LF)

Parses a single mailbox.

RFC 2822, section 3.4 defines a mailbox as follows:

mailbox := addr-spec / ([ display-name ] angle-addr)

KMime also accepts the legacy format of specifying display names:

mailbox := (addr-spec [ "(" display-name ")" ])
/ ([ display-name ] angle-addr)
/ (angle-addr "(" display-name ")")

scursor pointer to the first character of the input string

send pointer to end of input buffer

result the parsing result

newline whether the input string is terminated with CRLF or LF.

[since 6.0] std::unique_ptr<KMime::Headers::Base> HeaderParsing::parseNextHeader(QByteArrayView &head)

Parses the first header contained the given data.

If a header is found head will be shortened to no longer include the corresponding data, ie. this method can be called iteratively on the same data until it returns nullptr.

This function was introduced in 6.0.