Gjsify LogoGjsify Logo

A MIME Message object.

Hierarchy

Index

Constructors

Properties

a table of address lists

field
contentId: string

a Content-Id

field
contentType: GMime.ContentType

a #GMimeContentType

field

Date value

field

a #GMimeContentDisposition

field
gTypeInstance: TypeInstance
headers: HeaderList

a #GMimeHeaderList

field
messageId: string

Message-Id string

field
mimePart: GMime.Object

toplevel MIME part

field
parentObject: GMime.Object

parent #GMimeObject

field
subject: string

Subject string

field
name: string

Methods

  • addMailbox(type: AddressType, name: string, addr: string): void
  • Add a mailbox of a chosen type to the MIME message.

    Note: The name (and addr) strings should be in UTF-8.

    Parameters

    • type: AddressType

      A #GMimeAddressType

    • name: string

      The name of the mailbox (or %NULL)

    • addr: string

      The address of the mailbox

    Returns void

  • appendHeader(header: string, value: string, charset: string): void
  • Appends a new header to the header list.

    Parameters

    • header: string

      header name

    • value: string

      header value

    • charset: string

      a charset

    Returns void

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • emit(sigName: string, ...args: any[]): void
  • Calculates and sets the most efficient Content-Transfer-Encoding for this #GMimeObject and all child parts based on the constraint provided.

    Parameters

    Returns void

  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • Recursively calls callback on each of the mime parts in the mime message.

    Parameters

    • callback: ObjectForeachFunc

      function to call on each of the mime parts contained by the mime message

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Creates a new #GMimeAutocryptHeaderList of relevant headers of the given type based on the recipient(s) of an e-mail message.

    Returns the same object as #g_mime_message_get_autocrypt_gossip_headers_with_inner_part , but handles decryption and cleanup automatically.

    flags and session_key are passed through to #g_mime_multipart_encrypted_decrypt, as needed.

    If the message is not actually an encrypted message, returns %NULL: it should be ignored for purposes of evaluating gossip.

    If decryption fails, returns %NULL. In this case, an exception will be set on err to provide information about the decryption failure.

    Parameters

    • now: GLib.DateTime

      a #GDateTime object, or %NULL

    • flags: DecryptFlags

      a #GMimeDecryptFlags, to be used during decryption

    • sessionKey: string

      session key to use or %NULL

    Returns AutocryptHeaderList

  • Creates a new #GMimeAutocryptHeaderList of relevant headers of the given type based on the recipient(s) of an e-mail message.

    You must pass the decrypted inner part of the message to this function, since Autocrypt-Gossip headers are only stored within the encrypted layer.

    If you don't already have the decrypted inner part available to you, you probably want to use #g_mime_message_get_autocrypt_gossip_headers instead.

    Each header in the returned list will:

    • have a valid address
    • be of the type requested
    • be complete

    If no Autocrypt header is found for a recipient, no #GMimeAutocryptHeader will be in the list associated with that e-mail address.

    Note that the following types of Autocrypt headers will not be returned by this function:

    • headers of an unrequested type
    • headers that do not match an address in "From:"
    • unparseable headers
    • headers with unknown critical attributes
    • duplicate valid headers for a given address

    On error (e.g. if this version of GMime cannot handle the requested Autocrypt type, or if a parameter is missing or malformed), returns %NULL

    The returned Autocrypt headers will have their effective_date set to the earliest of either:

    • the Date: header of the message or
    • now (or the current time, if now is %NULL)

    Parameters

    • now: GLib.DateTime

      a #GDateTime object, or %NULL

    • innerPart: GMime.Object

      a #GMimeObject which is the cleartext part of the inner message

    Returns AutocryptHeaderList

  • Creates a new #GMimeAutocryptHeader based on the relevant Autocrypt header associated with the sender of an e-mail message.

    If the message has no sender in the From: field, or has more than one sender, then this function will return %NULL. Autocrypt should ignore the message entirely.

    If there is one sender, but no single Autocrypt header is found that matches that e-mail address, a #GMimeAutocryptHeader will be returned for the sender, but it will be incomplete (see #g_mime_autocrypt_header_is_complete).

    Note that the following types of Autocrypt headers will not be returned by this function:

    • headers that do not match an address in "From:"
    • unparseable headers
    • headers with unknown critical attributes
    • duplicate valid headers for the sender's address

    The returned Autocrypt header will have its effective_date set to the earliest of either:

    • the Date: header of the message or
    • now (or the current time, if now is %NULL)

    Parameters

    Returns AutocryptHeader

  • getContentDispositionParameter(name: string): string
  • getContentId(): string
  • getContentTypeParameter(name: string): string
  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getDisposition(): string
  • getHeader(header: string): string
  • Gets the value of the first header with the specified name.

    Parameters

    • header: string

      header name

    Returns string

  • getMessageId(): string
  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getSubject(): string
  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • isFloating(): boolean
  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • partialSplitMessage(maxSize: number): [GMime.Message, number]
  • Splits message into an array of #GMimeMessage objects each containing a single #GMimeMessagePartial object containing max_size bytes or fewer. nparts is set to the number of #GMimeMessagePartial objects created.

    Parameters

    • maxSize: number

      max size

    Returns [GMime.Message, number]

  • prependHeader(header: string, value: string, charset: string): void
  • Prepends a new header to the header list.

    Parameters

    • header: string

      header name

    • value: string

      header value

    • charset: string

      a charset

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • removeHeader(header: string): boolean
  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • setContentDispositionParameter(name: string, value: string): void
  • Add a content-disposition parameter to the specified mime part.

    Note: The name string should be in US-ASCII while the value string should be in UTF-8.

    Parameters

    • name: string

      parameter name

    • value: string

      parameter value

    Returns void

  • setContentId(contentId: string): void
  • setContentTypeParameter(name: string, value: string): void
  • Sets the content-type param name to the value value.

    Note: The name string should be in US-ASCII while the value string should be in UTF-8.

    Parameters

    • name: string

      param name

    • value: string

      param value

    Returns void

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setDisposition(disposition: string): void
  • Sets the disposition to disposition which may be one of #GMIME_DISPOSITION_ATTACHMENT or #GMIME_DISPOSITION_INLINE or, by your choice, any other string which would indicate how the MIME part should be displayed by the MUA.

    Parameters

    • disposition: string

      disposition ("attachment" or "inline")

    Returns void

  • setHeader(header: string, value: string, charset: string): void
  • Sets a header to the specified value.

    Parameters

    • header: string

      header name

    • value: string

      header value

    • charset: string

      a charset

    Returns void

  • setMessageId(messageId: string): void
  • Set the Message-Id on a message.

    Parameters

    • messageId: string

      message-id (addr-spec portion)

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • setSubject(subject: string, charset: string): void
  • Set the subject of a message.

    Note: The subject string should be in UTF-8.

    Parameters

    • subject: string

      Subject string

    • charset: string

      The charset to use for encoding the subject or %NULL to use the default

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • If pretty_headers is %TRUE, then the standard rfc822 headers are initialized so as to put headers in a nice friendly order. This is strictly a cosmetic thing, so if you are unsure, it is safe to say no (%FALSE).

    Parameters

    • prettyHeaders: boolean

      make pretty headers

    Returns GMime.Message

  • Performs a lookup of registered #GMimeObject subclasses, registered using g_mime_object_register_type(), to find an appropriate class capable of handling MIME parts of the specified Content-Type. If no class has been registered to handle that type, it looks for a registered class that can handle content_type's media type. If that also fails, then it will use the generic part class, #GMimePart.

    Parameters

    Returns GMime.Object

  • Performs a lookup of registered #GMimeObject subclasses, registered using g_mime_object_register_type(), to find an appropriate class capable of handling MIME parts of type type/``subtype. If no class has been registered to handle that type, it looks for a registered class that can handle type. If that also fails, then it will use the generic part class, #GMimePart.

    Parameters

    • options: ParserOptions

      a #GMimeParserOptions or %NULL

    • type: string

      mime type

    • subtype: string

      mime subtype

    Returns GMime.Object

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • registerType(type: string, subtype: string, objectType: GType<unknown>): void
  • Registers the object type object_type for use with the g_mime_object_new_type() convenience function.

    Note: You may use the wildcard "*" to match any type and/or subtype.

    Parameters

    • type: string

      mime type

    • subtype: string

      mime subtype

    • objectType: GType<unknown>

      object type

    Returns void

  • typeRegistryInit(): void
  • typeRegistryShutdown(): 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