Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

BINARY_AGE: number

GMime's binary age.

DISPOSITION_ATTACHMENT: string

Standard attachment disposition.

DISPOSITION_INLINE: string

Standard inline disposition.

FILTER_ENRICHED_IS_RICHTEXT: number

A bit flag for g_mime_filter_enriched_new() which signifies that the filter should expect Rich Text (aka RTF).

FILTER_HTML_BLOCKQUOTE_CITATION: number

Enclose citation text in blockquotes.

FILTER_HTML_CITE: number

Cites text by prepending "> " to each cited line.

FILTER_HTML_CONVERT_ADDRESSES: number

Wrap email addresses in "mailto:" href tags.

FILTER_HTML_CONVERT_NL: number

Convert new-lines ('\n') into <br> tags.

FILTER_HTML_CONVERT_SPACES: number

Preserve whitespace by converting spaces into their appropriate html entities.

FILTER_HTML_CONVERT_URLS: number

Wrap detected URLs in <a href=...> tags.

FILTER_HTML_ESCAPE_8BIT: number

Converts 8bit characters to '?'.

FILTER_HTML_MARK_CITATION: number

Change the colour of citation text.

FILTER_HTML_PRE: number

Wrap stream in <pre> and </pre> tags.

INTERFACE_AGE: number

GMime's interface age.

MAJOR_VERSION: number

GMime's major version.

MICRO_VERSION: number

GMime's micro version.

MINOR_VERSION: number

GMime's minor version.

SIGNATURE_STATUS_ERROR_MASK: number

A convenience macro for masking out the non-error bit flags.

UUDECODE_STATE_BEGIN: number

State for the g_mime_encoding_uudecode_step() function, denoting that the 'begin' line has been found.

UUDECODE_STATE_END: number

State for the g_mime_encoding_uudecode_step() function, denoting that the end of the UU encoded block has been found.

UUDECODE_STATE_INIT: number

Initial state for the g_mime_encoding_uudecode_step() function.

UUDECODE_STATE_MASK: number
YDECODE_STATE_BEGIN: number

State bit that denotes the yEnc filter has found the =ybegin line.

YDECODE_STATE_DECODE: number

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).

YDECODE_STATE_END: number

State bit that denoates that g_mime_ydecode_step() has finished decoding.

YDECODE_STATE_EOLN: number

State bit that denotes the yEnc filter has reached an end-of-line.

This state is for internal use only.

YDECODE_STATE_ESCAPE: number

State bit that denotes the yEnc filter has reached an escape sequence.

This state is for internal use only.

YDECODE_STATE_INIT: number

Initial state for the g_mime_ydecode_step() function.

YDECODE_STATE_PART: number

State bit that denotes the yEnc filter has found the =ypart line. (Note: not all yencoded blocks have one)

YENCODE_CRC_INIT: number

Initial state for the crc and pcrc state variables.

YENCODE_STATE_INIT: number

Initial state for the g_mime_ydecode_step() function.

Functions

  • charset_best(inbuf: string, inlen: number): string | null
  • Computes the best charset to use to encode this text buffer.

    Parameters

    • inbuf: string

      a UTF-8 text buffer

    • inlen: number

      input buffer length

    Returns string | null

  • charset_canon_name(charset: string): string
  • Attempts to find a canonical charset name for charset.

    Note: Will normally return the same value as g_mime_charset_iconv_name() unless the system iconv does not use the canonical ISO charset names (such as using ISO8859-1 rather than the canonical form ISO-8859-1).

    Parameters

    • charset: string

      charset name

    Returns string

  • charset_iconv_name(charset: string): string
  • Attempts to find an iconv-friendly charset name for charset.

    Parameters

    • charset: string

      charset name

    Returns string

  • charset_iso_to_windows(isocharset: string): string
  • Maps the ISO-8859-# charset to the equivalent Windows-CP125# charset.

    Parameters

    • isocharset: string

      ISO-8859-# charset

    Returns string

  • charset_language(charset: string): string | null
  • Attempts to find a specific language code that is specific to charset. Currently only handles CJK and Russian/Ukranian charset->lang mapping. Everything else will return %NULL.

    Parameters

    • charset: string

      charset name

    Returns string | null

  • charset_locale_name(): string
  • Gets the user's locale charset (or iso-8859-1 by default).

    Note: This function is deprecated. Use g_mime_locale_charset() instead.

    Returns string

  • charset_map_init(): void
  • charset_map_shutdown(): void
  • charset_name(charset: string): string
  • Attempts to find an iconv-friendly charset name for charset.

    Note: This function is deprecated. Use g_mime_charset_iconv_name() instead.

    Parameters

    • charset: string

      charset name

    Returns string

  • check_version(major: number, minor: number, micro: number): boolean
  • Checks that the GMime library version meets the requirements of the required version.

    Parameters

    • major: number

      Minimum major version

    • minor: number

      Minimum minor version

    • micro: number

      Minimum micro version

    Returns boolean

  • Gets the appropriate #GMimeContentEncoding enumeration value based on the input string.

    Parameters

    • str: string

      a string representing a Content-Transfer-Encoding value

    Returns ContentEncoding

  • encoding_base64_decode_step(inbuf: number, inlen: number, outbuf: number, state: number, save: number): number
  • Decodes a chunk of base64 encoded data.

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been decoded

    Returns number

  • encoding_base64_encode_close(inbuf: number, inlen: number, outbuf: number, state: number, save: number): number
  • Base64 encodes the input stream to the output stream. Call this when finished encoding data with g_mime_encoding_base64_encode_step() to flush off the last little bit.

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been encoded

    Returns number

  • encoding_base64_encode_step(inbuf: number, inlen: number, outbuf: number, state: number, save: number): number
  • Base64 encodes a chunk of data. Performs an 'encode step', only encodes blocks of 3 characters to the output at a time, saves left-over state in state and save (initialise to 0 on first invocation).

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been encoded

    Returns number

  • encoding_quoted_decode_step(inbuf: number, inlen: number, outbuf: number, state: number, save: number): number
  • Decodes a block of quoted-printable encoded data. Performs a 'decode step' on a chunk of QP encoded data.

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been decoded

    Returns number

  • encoding_quoted_encode_close(inbuf: number, inlen: number, outbuf: number, state: number, save: number): number
  • Quoted-printable encodes a block of text. Call this when finished encoding data with g_mime_encoding_quoted_encode_step() to flush off the last little bit.

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been encoded

    Returns number

  • encoding_quoted_encode_step(inbuf: number, inlen: number, outbuf: number, state: number, save: number): number
  • Quoted-printable encodes a block of text. Performs an 'encode step', saves left-over state in state and save (initialise to -1 on first invocation).

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been encoded

    Returns number

  • encoding_uudecode_step(inbuf: number, inlen: number, outbuf: number, state: number, save: number): number
  • Uudecodes a chunk of data. Performs a 'decode step' on a chunk of uuencoded data. Assumes the "begin mode filename" line has been stripped off.

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been decoded

    Returns number

  • encoding_uuencode_close(inbuf: number, inlen: number, outbuf: number, uubuf: number, state: number, save: number): number
  • Uuencodes a chunk of data. Call this when finished encoding data with g_mime_encoding_uuencode_step() to flush off the last little bit.

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • uubuf: number

      temporary buffer of 60 bytes

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been encoded

    Returns number

  • encoding_uuencode_step(inbuf: number, inlen: number, outbuf: number, uubuf: number, state: number, save: number): number
  • Uuencodes a chunk of data. Performs an 'encode step', only encodes blocks of 45 characters to the output at a time, saves left-over state in uubuf, state and save (initialize to 0 on first invocation).

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output stream

    • uubuf: number

      temporary buffer of 60 bytes

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been encoded

    Returns number

  • iconv_locale_to_utf8(str: string): string
  • Allocates a new string buffer containing str in UTF-8.

    Parameters

    • str: string

      string in locale charset

    Returns string

  • iconv_locale_to_utf8_length(str: string, n: number): string
  • Allocates a new string buffer containing the first n bytes of str converted to UTF-8.

    Parameters

    • str: string

      string in locale charset

    • n: number

      number of bytes to convert

    Returns string

  • iconv_utf8_to_locale(str: string): string
  • Allocates a new string buffer containing str converted to the user's locale charset.

    Parameters

    • str: string

      string in UTF-8 charset

    Returns string

  • iconv_utf8_to_locale_length(str: string, n: number): string
  • Allocates a new string buffer containing the first n bytes of str converted to the user's locale charset.

    Parameters

    • str: string

      string in UTF-8 charset

    • n: number

      number of bytes to convert

    Returns string

  • init(): void
  • locale_charset(): string
  • locale_language(): string | null
  • Decodes a list of msg-ids as in the References and/or In-Reply-To headers defined in rfc822.

    Parameters

    • options: ParserOptions

      a #GMimeParserOptions or %NULL

    • text: string

      string containing a list of msg-ids

    Returns References

  • shutdown(): void
  • utils_decode_8bit(options: ParserOptions, text: Uint8Array): string
  • 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. If no exact match can be found, it will choose the best match and convert invalid byte sequences into question-marks (?) in the returned string buffer.

    Parameters

    • options: ParserOptions

      a #GMimeParserOptions or %NULL

    • text: Uint8Array

      input text in unknown 8bit/multibyte character set

    Returns string

  • utils_decode_message_id(message_id: string): string
  • Decodes a msg-id as defined by rfc822.

    Parameters

    • message_id: string

      string containing a message-id

    Returns string

  • utils_generate_message_id(fqdn: string): string
  • utils_header_decode_phrase(options: ParserOptions, phrase: string): string
  • utils_header_decode_text(options: ParserOptions, text: string): string
  • utils_header_encode_phrase(options: GMime.FormatOptions, phrase: string, charset: string): string
  • Encodes a 'phrase' header according to the rules in rfc2047.

    Parameters

    • options: GMime.FormatOptions

      a #GMimeFormatOptions or %NULL

    • phrase: string

      phrase to encode

    • charset: string

      the charset to use or %NULL to use the default

    Returns string

  • utils_header_encode_text(options: GMime.FormatOptions, text: string, charset: string): string
  • Encodes a 'text' header according to the rules in rfc2047.

    Parameters

    • options: GMime.FormatOptions

      a #GMimeFormatOptions or %NULL

    • text: string

      text to encode

    • charset: string

      the charset to use or %NULL to use the default

    Returns string

  • utils_header_unfold(value: string): string
  • Unfolds a raw header value according to the rules in rfc822.

    Parameters

    • value: string

      raw header value

    Returns string

  • utils_quote_string(str: string): string
  • Quotes string as needed according to the rules in rfc2822.

    Parameters

    • str: string

      input string

    Returns string

  • utils_text_is_8bit(text: Uint8Array): boolean
  • Determines if text contains 8bit characters within the first len bytes.

    Parameters

    • text: Uint8Array

      text to check for 8bit chars

    Returns boolean

  • utils_unquote_string(str: string): void
  • ydecode_step(inbuf: number, inlen: number, outbuf: number, state: number, pcrc: number, crc: number): number
  • Performs a 'decode step' on a chunk of yEncoded data of length inlen pointed to by inbuf and writes to outbuf. Assumes the =ybegin and =ypart lines have already been stripped off.

    To get the crc32 value of the part, use #GMIME_YENCODE_CRC_FINAL (pcrc). If there are more parts, you should reuse crc without re-initializing. Once all parts have been decoded, you may get the combined crc32 value of all the parts using #GMIME_YENCODE_CRC_FINAL (crc).

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      ydecode state

    • pcrc: number

      part crc state

    • crc: number

      crc state

    Returns number

  • yencode_close(inbuf: number, inlen: number, outbuf: number, state: number, pcrc: number, crc: number): number
  • Call this function when finished encoding data with g_mime_yencode_step() to flush off the remaining state.

    #GMIME_YENCODE_CRC_FINAL (pcrc) will give you the crc32 of the encoded "part". If there are more "parts" to encode, you should re-use crc when encoding the next "parts" and then use #GMIME_YENCODE_CRC_FINAL (crc) to get the combined crc32 value of all the parts.

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      yencode state

    • pcrc: number

      part crc state

    • crc: number

      crc state

    Returns number

  • yencode_step(inbuf: number, inlen: number, outbuf: number, state: number, pcrc: number, crc: number): number
  • Performs an yEncode 'encode step' on a chunk of raw data of length inlen pointed to by inbuf and writes to outbuf.

    state should be initialized to #GMIME_YENCODE_STATE_INIT before beginning making the first call to this function. Subsequent calls should reuse state.

    Along the same lines, pcrc and crc should be initialized to #GMIME_YENCODE_CRC_INIT before using.

    Parameters

    • inbuf: number

      input buffer

    • inlen: number

      input buffer length

    • outbuf: number

      output buffer

    • state: number

      yencode state

    • pcrc: number

      part crc state

    • crc: number

      crc state

    Returns number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method