Gjsify LogoGjsify Logo

Format options for serializing various GMime objects.

record

Hierarchy

  • FormatOptions

Index

Constructors

Properties

name: string

Methods

  • addHiddenHeader(header: string): void
  • Adds the given header to the list of headers that should be hidden.

    Parameters

    • header: string

      a header name

    Returns void

  • clearHiddenHeaders(): void
  • createNewlineFilter(ensureNewline: boolean): GMime.Filter
  • Creates a #GMimeFilter suitable for converting line-endings to the currently set new-line format.

    Parameters

    • ensureNewline: boolean

      %TRUE if the output must always end with a new line

    Returns GMime.Filter

  • free(): void
  • getNewline(): string
  • Gets a string representing the currently set new-line format.

    Returns string

  • isHiddenHeader(header: string): boolean
  • Gets whether or not the specified header should be hidden.

    Parameters

    • header: string

      the name of a header

    Returns boolean

  • removeHiddenHeader(header: string): void
  • Removes the given header from the list of headers that should be hidden.

    Parameters

    • header: string

      a header name

    Returns void

  • Sets the new-line format that should be used when writing headers and messages.

    Parameters

    Returns void

  • Sets the parameter encoding method to use when encoding parameters which do not have an encoding method specified.

    Note: #GMIME_PARAM_ENCODING_METHOD_DEFAULT is not allowed.

    Parameters

    Returns void

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