gmime-3.0

---

Description:

MIME message parser and creator library

• Home: https://github.com/jstedfast/gmime
• C-Documentation: https://developer-old.gnome.org/gmime/stable/

Content:

Namespaces:

• GMime

Classes:

• ApplicationPkcs7Mime - An application/pkcs7-mime MIME part.
• AutocryptHeader - An object containing Autocrypt information about a given e-mail address, as derived from a message header.
• AutocryptHeaderList - A list of Autocrypt headers, typically extracted from a GMimeMessage.
• Certificate - An object containing useful information about a certificate.
• CertificateList - A collection of Certificate objects.
• ContentDisposition - A data structure representing a Content-Disposition.
• ContentType - A data structure representing a Content-Type.
• CryptoContext - A crypto context for use with MIME.
• DataWrapper - A wrapper for a stream which may be encoded.
• DecryptResult - An object containing the results from decrypting an encrypted stream.
• Filter - Base class for filters used by StreamFilter.
• FilterBasic - A basic encoder/decoder filter for the MIME encodings.
• FilterBest - A filter for calculating the best encoding and/or charset to encode the data passed through it.
• FilterCharset - A filter to convert between charsets.
• FilterChecksum - A filter for calculating the checksum of a stream.
• FilterDos2Unix - A filter to convert a stream from Windows/DOS line endings to Unix line endings.
• FilterEnriched - A filter for converting text/enriched or text/richtext textual streams into text/html.
• FilterFrom - A filter for armoring or escaping lines beginning with "From ".
• FilterGZip - A filter for compresing or decompressing a gzip stream.
• FilterHTML - A filter for converting text/plain into text/html.
• FilterOpenPGP - A filter to detect OpenPGP markers.
• FilterSmtpData - A filter to byte-stuff SMTP DATA.
• FilterStrip - A filter for stripping whitespace from the end of lines.
• FilterUnix2Dos - A filter to convert a stream from Windows/DOS line endings to Unix line endings.
• FilterWindows - A filter for detecting whether or not a text stream claimed to be iso-8859-X is really that charset or if it is really a Windows-CP125x charset.
• FilterYenc - A filter for yEncoding or yDecoding a stream.
• FormatOptions - Format options for serializing various GMime objects.
• GpgContext - A GnuPG crypto context.
• Header - A message or mime-part header.
• HeaderList - A list of message or mime-part headers.
• InternetAddress - An RFC 2822 Address object.
• InternetAddressGroup - An RFC 2822 Group address.
• InternetAddressList - A collection of InternetAddress objects.
• InternetAddressMailbox - An RFC 2822 Mailbox address.
• Message - A MIME Message object.
• MessagePart - A message/rfc822 or message/news MIME part.
• MessagePartial - A message/partial MIME part.
• Multipart - A base MIME multipart object.
• MultipartEncrypted - A multipart/encrypted MIME part.
• MultipartSigned - A multipart/signed MIME part.
• Object - Base class for all MIME parts.
• Param - A parameter name/value pair as used in the Content-Type and Content-Disposition headers.
• ParamList - A list of Content-Type or Content-Disposition parameters.
• Parser - A MIME parser context.
• ParserOptions - A set of parser options used by Parser and various other parsing functions.
• Part - A leaf-node MIME part object.
• PartIter - A MIME part iterator.
• Pkcs7Context - A PKCS7 crypto context.
• References - A List of references, as per the References or In-Reply-To header fields.
• Signature - An object containing useful information about a signature.
• SignatureList - A collection of Signature objects.
• Stream - Abstract I/O stream class.
• StreamBuffer - A buffered stream wrapper around any Stream object.
• StreamCat - A concatenation of other Stream objects.
• StreamFile - A Stream wrapper around standard-c FILE pointers.
• StreamFilter - A Stream which passes data through any Filter objects.
• StreamFs - A Stream wrapper around POSIX file descriptors.
• StreamGIO - A Stream wrapper around GLib's GIO streams.
• StreamMem - A memory-backed Stream.
• StreamMmap - A memory-mapped Stream.
• StreamNull - A Stream which has no backing store.
• StreamPipe - A Stream wrapper around pipes.
• TextPart - A text MIME part object.

Structs:

• Charset - State used by best and best_name .
• Encoding - A context used for encoding or decoding data.
• OpenPGPMarker - An OpenPGP marker for use with GMime's internal state machines used for detecting OpenPGP blocks.
• StreamIOVector - An I/O vector for use with writev.

Enums:

• AddressType - An address type.
• AutocryptPreferEncrypt - A description of the user's preference for encrypted messaging.
• CipherAlgo - A cipher algorithm.
• ContentEncoding - A Content-Transfer-Encoding enumeration.
• DecryptFlags - Decryption flags.
• DigestAlgo - A hash algorithm.
• EncodingConstraint - Used with functions like encoding and encode as the 'constraint' argument.
• EncryptFlags - Encryption flags.
• FilterBestFlags - Bit flags to enable charset and/or encoding scanning to make educated guesses as to what the best charset and/or encodings to use for the content passed through the filter.
• FilterFromMode - The mode for a FilterFrom filter.
• FilterGZipMode - The mode for the FilterGZip filter.
• Format - An enum of formats.
• NewLineFormat - There are two commonly used line-endings used by modern Operating Systems.
• OpenPGPData - The type of OpenPGP data found, if any.
• OpenPGPState - The current state of the FilterOpenPGP filter.
• ParamEncodingMethod - The MIME specifications specify that the proper method for encoding Content-Type and Content-Disposition parameter values is the method described in <a href="https://tools.
• ParserWarning - Issues the GMimeParser detects.
• PubKeyAlgo - A public-key algorithm.
• RfcComplianceMode - An RFC compliance mode.
• SecureMimeType - The S/MIME data type.
• SeekWhence - Relative seek position.
• SignatureStatus - A value representing the signature status bit flags for a particular Signature.
• StreamBufferMode - The buffering mode for a StreamBuffer stream.
• Trust - The trust level of a certificate.
• Validity - The validity level of a certificate's User ID.
• VerifyFlags - Signature verification flags.

Constants:

• public const int BINARY_AGE
  GMime's binary age.
• public const string DISPOSITION_ATTACHMENT
  Standard attachment disposition.
• public const string DISPOSITION_INLINE
  Standard inline disposition.
• public const int FILTER_ENRICHED_IS_RICHTEXT
  A bit flag for FilterEnriched which signifies that the filter should expect Rich Text (aka RTF).
• public const int FILTER_HTML_BLOCKQUOTE_CITATION
  Enclose citation text in blockquotes.
• public const int FILTER_HTML_CITE
  Cites text by prepending "&gt; " to each cited line.
• public const int FILTER_HTML_CONVERT_ADDRESSES
  Wrap email addresses in "mailto:" href tags.
• public const int FILTER_HTML_CONVERT_NL
  Convert new-lines ('\n') into &lt;br&gt; tags.
• public const int FILTER_HTML_CONVERT_SPACES
  Preserve whitespace by converting spaces into their appropriate html entities.
• public const int FILTER_HTML_CONVERT_URLS
  Wrap detected URLs in &lt;a href=...&gt; tags.
• public const int FILTER_HTML_ESCAPE_8BIT
  Converts 8bit characters to '?'.
• public const int FILTER_HTML_MARK_CITATION
  Change the colour of citation text.
• public const int FILTER_HTML_PRE
  Wrap stream in &lt;pre&gt; and &lt;/pre&gt; tags.
• public const int INTERFACE_AGE
  GMime's interface age.
• public const int MAJOR_VERSION
  GMime's major version.
• public const int MICRO_VERSION
  GMime's micro version.
• public const int MINOR_VERSION
  GMime's minor version.
• public const int SIGNATURE_STATUS_ERROR_MASK
  A convenience macro for masking out the non-error bit flags.
• public const int UUDECODE_STATE_BEGIN
  State for the uudecode_step function, denoting that the 'begin' line has been found.
• public const int UUDECODE_STATE_END
  State for the uudecode_step function, denoting that the end of the UU encoded block has been found.
• public const int UUDECODE_STATE_INIT
  Initial state for the uudecode_step function.
• public const int UUDECODE_STATE_MASK
• public const int YDECODE_STATE_BEGIN
  State bit that denotes the yEnc filter has found the =ybegin line.
• public const int YDECODE_STATE_DECODE
  State bit that denotes yEnc filter has begun decoding the actual yencoded content and will continue to do so until an =yend line is found (or until there is nothing left to decode).
• public const int YDECODE_STATE_END
  State bit that denoates that ydecode_step has finished decoding.
• public const int YDECODE_STATE_EOLN
  State bit that denotes the yEnc filter has reached an end-of-line.
• public const int YDECODE_STATE_ESCAPE
  State bit that denotes the yEnc filter has reached an escape sequence.
• public const int YDECODE_STATE_INIT
  Initial state for the ydecode_step function.
• public const int YDECODE_STATE_PART
  State bit that denotes the yEnc filter has found the =ypart line.
• public const int YENCODE_CRC_INIT
  Initial state for the crc and pcrc state variables.
• public const int YENCODE_STATE_INIT
  Initial state for the ydecode_step function.

Delegates:

• public delegate string HeaderRawValueFormatter (Header header, FormatOptions options, string value, string charset)
  Function callback for encoding and formatting a header value.
• public delegate void ObjectForeachFunc (Object parent, Object part)
  The function signature for a callback to @foreach and @foreach.
• public delegate void ParserHeaderRegexFunc (Parser parser, string header, string value, int64 offset)
  Function signature for the callback to g_mime_parser_set_header_regex.
• public delegate void ParserWarningFunc (int64 offset, ParserWarning errcode, string item)
  The function signature for a callback to g_mime_parser_options_set_warning_callback.
• public delegate bool PasswordRequestFunc (CryptoContext ctx, string user_id, string prompt, bool reprompt, Stream response) throws Error
  A password request callback allowing a CryptoContext to prompt the user for a password for a given key.

Methods:

• public unowned string? charset_best (string inbuf, size_t inlen)
• public unowned string charset_canon_name (string charset)
• public unowned string charset_iconv_name (string charset)
• public unowned string charset_iso_to_windows (string isocharset)
• public unowned string? charset_language (string charset)
• public unowned string charset_locale_name ()
• public void charset_map_init ()
• public void charset_map_shutdown ()
• public unowned string charset_name (string charset)
• public bool check_version (uint major, uint minor, uint micro)
  Checks that the GMime library version meets the requirements of the required version.
• public size_t encoding_base64_decode_step (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 save)
• public size_t encoding_base64_encode_close (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 save)
• public size_t encoding_base64_encode_step (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 save)
• public size_t encoding_quoted_decode_step (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 save)
• public size_t encoding_quoted_encode_close (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 save)
• public size_t encoding_quoted_encode_step (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 save)
• public size_t encoding_uudecode_step (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 save)
• public size_t encoding_uuencode_close (uint8 inbuf, size_t inlen, uint8 outbuf, uint8 uubuf, int state, uint32 save)
• public size_t encoding_uuencode_step (uint8 inbuf, size_t inlen, uint8 outbuf, uint8 uubuf, int state, uint32 save)
• public FormatOptions format_options_get_default ()
  Gets the default format options.
• public string iconv_locale_to_utf8 (string str)
  Allocates a new string buffer containing str in UTF-8.
• public string iconv_locale_to_utf8_length (string str, size_t n)
  Allocates a new string buffer containing the first n bytes of str converted to UTF-8.
• public string iconv_utf8_to_locale (string str)
  Allocates a new string buffer containing str converted to the user's locale charset.
• public string iconv_utf8_to_locale_length (string str, size_t n)
  Allocates a new string buffer containing the first n bytes of str converted to the user's locale charset.
• public void init ()
  Initializes GMime.
• public unowned string locale_charset ()
  Gets the user's locale charset (or iso-8859-1 by default).
• public unowned string? locale_language ()
  Gets the user's locale language code (or null by default).
• public ParserOptions parser_options_get_default ()
  Gets the default parser options.
• public References references_parse (ParserOptions? options, string text)
  Decodes a list of msg-ids as in the References and/or In-Reply-To headers defined in rfc822.
• public void shutdown ()
  Frees internally allocated tables created in init.
• public ContentEncoding utils_best_encoding (uint8[] text)
  Determines the best content encoding for the first text.length bytes of text.
• public string utils_decode_8bit (ParserOptions? options, uint8[] text)
  Attempts to convert text in an unknown 8bit/multibyte charset into UTF-8 by finding the charset which will convert the most bytes into valid UTF-8 characters as possible.
• public string utils_decode_message_id (string message_id)
  Decodes a msg-id as defined by rfc822.
• public string utils_generate_message_id (string fqdn)
  Generates a unique Message-Id.
• public DateTime? utils_header_decode_date (string str)
  Parses the rfc822 date string.
• public string utils_header_decode_phrase (ParserOptions? options, string phrase)
  Decodes an rfc2047 encoded 'phrase' header.
• public string utils_header_decode_text (ParserOptions? options, string text)
  Decodes an rfc2047 encoded 'text' header.
• public string utils_header_encode_phrase (FormatOptions? options, string phrase, string? charset)
  Encodes a 'phrase' header according to the rules in rfc2047.
• public string utils_header_encode_text (FormatOptions? options, string text, string? charset)
  Encodes a 'text' header according to the rules in rfc2047.
• public string utils_header_format_date (DateTime date)
  Allocates a string buffer containing the rfc822 formatted date string represented by date.
• public string utils_header_unfold (string value)
  Unfolds a raw header value according to the rules in rfc822.
• public string utils_quote_string (string str)
  Quotes string as needed according to the rules in rfc2822.
• public string utils_structured_header_fold (ParserOptions? options, FormatOptions? format, string header)
  Folds a structured header according to the rules in rfc822.
• public bool utils_text_is_8bit (uint8[] text)
  Determines if text contains 8bit characters within the first text.length bytes.
• public void utils_unquote_string (string str)
  Unquotes and unescapes a string.
• public string utils_unstructured_header_fold (ParserOptions? options, FormatOptions? format, string header)
  Folds an unstructured header according to the rules in rfc822.
• public size_t ydecode_step (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 pcrc, uint32 crc)
  Performs a 'decode step' on a chunk of yEncoded data of length inlen pointed to by inbuf and writes to outbuf.
• public size_t yencode_close (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 pcrc, uint32 crc)
  Call this function when finished encoding data with yencode_step to flush off the remaining state.
• public size_t yencode_step (uint8 inbuf, size_t inlen, uint8 outbuf, int state, uint32 pcrc, uint32 crc)
  Performs an yEncode 'encode step' on a chunk of raw data of length inlen pointed to by inbuf and writes to outbuf.