gmime/mailparser

Types

MailParsingError = object of CatchableError

Procs

proc allowAddressesWithoutDomain(options: ptr GMimeParserOptions; allow: bool) {.
    ...raises: [], tags: [], forbids: [].}
Sets whether the parser should allow email addresses without a domain part.
proc close(parser: ptr GMimeParser) {....raises: [], tags: [], forbids: [].}
Closes the parser and releases any associated resources.
proc constructMail(parser: ptr GMimeParser): ptr GMimeMessage {.inline,
    ...raises: [MailParsingError], tags: [], forbids: [].}
This is an alias for constructMessage, provided for convenience and readability.
proc constructMessage(parser: ptr GMimeParser): ptr GMimeMessage {.
    ...raises: [MailParsingError], tags: [], forbids: [].}
Constructs a GMimeMessage from the given parser.
proc getBCCList(message: ptr GMimeMessage): ptr InternetAddressList {.
    ...raises: [], tags: [], forbids: [].}
Retrieves the list of BCC (blind carbon copy) addresses from the email message.
proc getBody(message: ptr GMimeMessage; plainTextOnly = false): string {.
    ...raises: [], tags: [], forbids: [].}
Returns all collected text parts joined with a blank line.
proc getCCList(message: ptr GMimeMessage): ptr InternetAddressList {....raises: [],
    tags: [], forbids: [].}
Retrieves the list of CC (carbon copy) addresses from the email message.
proc getDateTime(message: ptr GMimeMessage): Option[DateTime] {....raises: [],
    tags: [], forbids: [].}
Retrieves the date and time when the email message was sent. Returns none if the date is not available.
proc getDefaultParserOptions(): ptr GMimeParserOptions {....raises: [], tags: [],
    forbids: [].}
Retrieves the default parser options for GMime.
proc getFromList(message: ptr GMimeMessage): ptr InternetAddressList {.
    ...raises: [], tags: [], forbids: [].}
Retrieves the list of sender addresses from the email message.
proc getSubject(message: ptr GMimeMessage): string {....raises: [], tags: [],
    forbids: [].}
Retrieves the subject of the email message.
proc hasDateTime(message: ptr GMimeMessage): bool {....raises: [], tags: [],
    forbids: [].}
Checks if the email message has a valid date and time.
proc hasSubject(message: ptr GMimeMessage): bool {....raises: [], tags: [],
    forbids: [].}
Checks if the email message has a subject.
proc newParserOptions(): ptr GMimeParserOptions {....raises: [], tags: [],
    forbids: [].}
Creates a new instance of GMimeParserOptions with default values.
proc parseEmail(filePath: string): ptr GMimeParser {....raises: [MailParsingError],
    tags: [], forbids: [].}
Parses the email message at the given file path and returns a GMimeParser instance.
proc parseMail(filePath: string): ptr GMimeParser {.inline,
    ...raises: [MailParsingError], tags: [], forbids: [].}
This is an alias for parseEmail, provided for convenience and readability.