Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

abort_notifications: boolean

Flag, whether the info is currently aborting notifications. It is used to avoid unnecessary 'folder-flagged' and 'dirty' flags changes and also to avoid associated folder's "changed" signal. f

cc: string

CC address of the associated message.

date_received: number

Received date of the associated message.

date_sent: number

Sent Date of the associated message.

dirty: boolean

Flag, whether the info is changed and requires save to disk. Compare with CamelMessageInfo:folder-flagged

Bit-or of #CamelMessageFlags.

folder_flagged: boolean

Flag, whether the info is changed and requires save to the destination store/server. This is different from the CamelMessageInfo:dirty, which takes care of the local information only.

folder_flagged_stamp: number

The 'folder-flagged-stamp' is a stamp of the 'folder-flagged' flag. This stamp changes whenever anything would mark the mi 'folder-flagged', regardless the mi being already 'folder-flagged'. It can be used to recognize changes on the 'folder-flagged' flag during the time.

from: string

From address of the associated message.

g_type_instance: TypeInstance

Headers of the associated message. Can be %NULL.

message_id: number

Encoded Message-ID of the associated message as a guint64 number, partial MD5 sum. The value can be cast to #CamelSummaryMessageID.

mlist: string

Mailing list address of the associated message.

parent: MessageInfo
preview: string

Body preview of the associated message. Can be %NULL.

references: object[]

Encoded In-Reply-To and References headers of the associated message as an array of guint64 numbers, partial MD5 sums. Each value can be cast to #CamelSummaryMessageID.

size: number

Size of the associated message.

subject: string

Subject of the associated message.

summary: FolderSummary

The #CamelFolderSummary to which the message info belongs, or %NULL. It can be set only during construction of the object.

to: string

To address of the associated message.

uid: string

A unique ID of the message in its folder.

user_flags: NamedFlags

User flags for the associated message. Can be %NULL. Unlike user-tags, which can contain various values, the user-flags can only be set or not.

user_headers: NameValueArray

User-defined headers of the associated message. Can be %NULL.

user_tags: NameValueArray

User tags for the associated message. Can be %NULL. Unlike user-flags, which can be set or not, the user-tags can contain various values.

name: string

Methods

  • 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

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

    • transform_from: TClosure<any, any>

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

    Returns Binding

  • Clones the mi as a new #CamelMessageInfo and eventually assigns a new #CamelFolderSummary to it. If it's not set, then the same summary as the one with mi is used.

    Parameters

    • assign_summary: FolderSummary

      parent #CamelFolderSummary object, or %NULL, to set on the clone

    Returns MessageInfo

  • disconnect(id: number): void
  • dump(): void
  • dup_preview(): string
  • dup_references(): number[]
  • Duplicates encoded In-Reply-To and References headers of the associated message as an array of guint64 numbers, partial MD5 sums. Each value can be cast to #CamelSummaryMessageID.

    Returns number[]

  • dup_user_header(name: string): string
  • dup_user_tag(name: string): string
  • emit(sigName: "notify::abort-notifications", ...args: any[]): void
  • emit(sigName: "notify::cc", ...args: any[]): void
  • emit(sigName: "notify::date-received", ...args: any[]): void
  • emit(sigName: "notify::date-sent", ...args: any[]): void
  • emit(sigName: "notify::dirty", ...args: any[]): void
  • emit(sigName: "notify::flags", ...args: any[]): void
  • emit(sigName: "notify::folder-flagged", ...args: any[]): void
  • emit(sigName: "notify::folder-flagged-stamp", ...args: any[]): void
  • emit(sigName: "notify::from", ...args: any[]): void
  • emit(sigName: "notify::headers", ...args: any[]): void
  • emit(sigName: "notify::message-id", ...args: any[]): void
  • emit(sigName: "notify::mlist", ...args: any[]): void
  • emit(sigName: "notify::preview", ...args: any[]): void
  • emit(sigName: "notify::references", ...args: any[]): void
  • emit(sigName: "notify::size", ...args: any[]): void
  • emit(sigName: "notify::subject", ...args: any[]): void
  • emit(sigName: "notify::summary", ...args: any[]): void
  • emit(sigName: "notify::to", ...args: any[]): void
  • emit(sigName: "notify::uid", ...args: any[]): void
  • emit(sigName: "notify::user-flags", ...args: any[]): void
  • emit(sigName: "notify::user-headers", ...args: any[]): void
  • emit(sigName: "notify::user-tags", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): 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

  • freeze_notifications(): void
  • freeze_notify(): 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

  • get_abort_notifications(): boolean
  • get_cc(): string
  • get_data(key?: string): object
  • get_date_received(): number
  • get_date_sent(): number
  • get_dirty(): boolean
  • get_flags(): number
  • get_folder_flagged(): boolean
  • The folder flagged flag is used to mark the message infor as being changed and this change should be propagated to the remote store (server). This is different from the 'dirty' flag, which is set for local changes only. It can happen that the 'folder-flagged' flag is set, but the 'dirty' flag not.

    This is only a convenient wrapper around CAMEL_MESSAGE_FOLDER_FLAGGED flag, for better readiness of the code.

    Returns boolean

  • get_folder_flagged_stamp(): number
  • The 'folder-flagged-stamp' is a stamp of the 'folder-flagged' flag. This stamp changes whenever anything would mark the mi as 'folder-flagged', regardless the mi being already 'folder-flagged'. It can be used to recognize changes on the 'folder-flagged' flag during the time.

    Returns number

  • get_from(): string
  • get_message_id(): number
  • get_mlist(): string
  • get_notifications_frozen(): boolean
  • get_preview(): string
  • get_property(property_name?: 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 property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_references(): number[]
  • get_size(): number
  • get_subject(): string
  • get_to(): string
  • get_uid(): string
  • get_user_flag(name: string): boolean
  • get_user_header(name: string): string
  • get_user_tag(name: string): 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

  • is_floating(): boolean
  • load(record: MIRecord, bdata_ptr: string): boolean
  • Load content of mi from the data stored in record. The bdata_ptr points to the current position of the record->bdata, where the read can continue. Use helper functions camel_util_bdata_get_number() and camel_util_bdata_get_string() to read data from it and also move forward the *bdata_ptr.

    After successful load of the mi, the 'dirty' flag is unset.

    Parameters

    • record: MIRecord

      a #CamelMIRecord to load the mi from

    • bdata_ptr: string

      a backend specific data (bdata) pointer

    Returns boolean

  • notify(property_name: 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

    • property_name: 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

  • pooldup_uid(): string
  • property_lock(): void
  • Acquires a property lock, which is used to ensure thread safety when properties are changing. Release the lock with camel_message_info_property_unlock().

    Note: Make sure the CamelFolderSummary lock is held before this lock, if there will be called any 'set' function on the mi, to avoid deadlock when the summary would be set as dirty while another thread might try to read values from the mi, waiting for the property lock and holding the summary lock at the same time.

    Returns void

  • property_unlock(): 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

  • ref_summary(): object
  • run_dispose(): void
  • Save the mi content to the message info record record. It can populate all but the record->bdata value, which is set fro mthe bdata_str. Use helper functions camel_util_bdata_put_number() and camel_util_bdata_put_string() to put data into the bdata_str.

    Parameters

    • record: MIRecord

      a #CamelMIRecord to populate

    • bdata_str: GLib.String

      a #GString with a string to save as backend specific data (bdata)

    Returns boolean

  • set_abort_notifications(abort_notifications: boolean): void
  • Marks the mi to abort any notifications, which means that it will not influence 'dirty' and 'folder-flagged' flags in the set/take functions, neither it will emit any GObject::notify signals on change, nor associated folder's "changed" signal.

    Parameters

    • abort_notifications: boolean

      a state to set

    Returns void

  • set_cc(cc: string): boolean
  • Sets CC from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • cc: string

      a CC to set

    Returns boolean

  • set_data(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

  • set_date_received(date_received: number): boolean
  • Sets received date (the Received header) of the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • date_received: number

      a received date to set

    Returns boolean

  • set_date_sent(date_sent: number): boolean
  • Sets sent date (the Date header) of the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • date_sent: number

      a sent date to set

    Returns boolean

  • set_dirty(dirty: boolean): void
  • set_flags(mask: number, set: number): boolean
  • Change the state of the flags on the mi. Both mask and set are bit-or of #CamelMessageFlags.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary. In case the CAMEL_MESSAGE_FOLDER_FLAGGED flag would be set and the mi is not aborting notifications, the 'folder-flagged-stamp' changes too.

    Parameters

    • mask: number

      mask of flags to change

    • set: number

      state the flags should be changed to

    Returns boolean

  • set_folder_flagged(folder_flagged: boolean): boolean
  • Changes the folder-flagged flag to the folder_flagged value. See camel_message_info_get_folder_flagged() for more information about the use of this flag.

    This is only a convenient wrapper around CAMEL_MESSAGE_FOLDER_FLAGGED flag, for better readiness of the code.

    Parameters

    • folder_flagged: boolean

      a value to set to

    Returns boolean

  • set_from(from: string): boolean
  • Sets From from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • from: string

      a From to set

    Returns boolean

  • set_message_id(message_id: number): boolean
  • Sets encoded Message-ID of the associated message as a guint64 number, partial MD5 sum. The value can be cast to #CamelSummaryMessageID.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • message_id: number

      a message id to set

    Returns boolean

  • set_mlist(mlist: string): boolean
  • Sets mesage list address from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • mlist: string

      a message list address to set

    Returns boolean

  • set_preview(preview: string): boolean
  • Set preview as the body preview of the associated message. Use %NULL or an empty string to unset the value.

    If the mi changed, the 'dirty' flag is set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • preview: string

      message body preview, or %NULL

    Returns boolean

  • set_property(property_name: string, value?: any): void
  • set_size(size: number): boolean
  • Sets size of the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • size: number

      a size to set

    Returns boolean

  • set_subject(subject: string): boolean
  • Sets Subject from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • subject: string

      a Subject to set

    Returns boolean

  • set_to(to: string): boolean
  • Sets To from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • to: string

      a To to set

    Returns boolean

  • set_uid(uid: string): boolean
  • Changes UID of the mi to uid. If it changes, the 'dirty' flag of the mi is set too, unless the mi is aborting notifications. This change does not influence the 'folder-flagged' flag.

    Parameters

    • uid: string

      a UID to set

    Returns boolean

  • set_user_flag(name: string, state: boolean): boolean
  • Change state of the flag named name. Unlike user tags, user flags can only be set or unset, while the user tags can contain certain values.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary.

    Parameters

    • name: string

      user flag name

    • state: boolean

      state to set for the flag

    Returns boolean

  • set_user_header(name: string, value: string): boolean
  • Set value for a single user-defined message header of the associated message. When the value is %NULL, the header name is removed from the user-defined headers.

    If the mi changed, the 'dirty' flag is set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Parameters

    • name: string

      header name

    • value: string

      header value, or %NULL

    Returns boolean

  • set_user_tag(name: string, value: string): boolean
  • Set user tag name to value, or remove it, if value is %NULL.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary.

    Parameters

    • name: string

      user tag name

    • value: string

      user tag value, or %NULL to remove the user tag

    Returns boolean

  • steal_data(key?: string): object
  • steal_qdata(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

  • Takes headers of the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Note that it's not safe to use the headers after the call to this function, because it can be freed due to no change.

    Parameters

    • headers: NameValueArray

      headers to set, as #CamelNameValueArray, or %NULL

    Returns boolean

  • take_references(references: number[]): boolean
  • Takes encoded In-Reply-To and References headers of the associated message as an array of guint64 numbers, partial MD5 sums. Each value can be cast to #CamelSummaryMessageID.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Note that it's not safe to use the references after the call to this function, because it can be freed due to no change.

    Parameters

    • references: number[]

      a references to set

    Returns boolean

  • Takes all the user_flags, which replaces any current user flags on the mi. The passed-in user_flags is consumed by the mi, which becomes an owner of it. The caller should not change user_flags afterwards.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary.

    Note that it's not safe to use the user_flags after the call to this function, because it can be freed due to no change.

    Parameters

    Returns boolean

  • Takes user-defined message headers of the associated message.

    If the mi changed, the 'dirty' flag is set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Note that it's not safe to use the headers after the call to this function, because it can be freed due to no change.

    Parameters

    • headers: NameValueArray

      headers to set, as #CamelNameValueArray, or %NULL

    Returns boolean

  • Takes all the user_tags, which replaces any current user tags on the mi. The passed-in user_tags is consumed by the mi, which becomes an owner of it. The caller should not change user_tags afterwards.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary.

    Note that it's not safe to use the user_tags after the call to this function, because it can be freed due to no change.

    Parameters

    Returns boolean

  • thaw_notifications(): void
  • thaw_notify(): 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

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_cc(): string
  • vfunc_get_date_received(): number
  • vfunc_get_date_sent(): number
  • vfunc_get_flags(): number
  • vfunc_get_from(): string
  • vfunc_get_message_id(): number
  • vfunc_get_mlist(): string
  • vfunc_get_preview(): string
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_get_references(): number[]
  • vfunc_get_size(): number
  • vfunc_get_subject(): string
  • vfunc_get_to(): string
  • vfunc_get_user_flag(name: string): boolean
  • vfunc_get_user_header(name: string): string
  • vfunc_get_user_tag(name: string): string
  • vfunc_load(record: MIRecord, bdata_ptr: string): boolean
  • Load content of mi from the data stored in record. The bdata_ptr points to the current position of the record->bdata, where the read can continue. Use helper functions camel_util_bdata_get_number() and camel_util_bdata_get_string() to read data from it and also move forward the *bdata_ptr.

    After successful load of the mi, the 'dirty' flag is unset.

    virtual

    Parameters

    • record: MIRecord

      a #CamelMIRecord to load the mi from

    • bdata_ptr: string

      a backend specific data (bdata) pointer

    Returns boolean

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

    virtual

    Parameters

    Returns void

  • Save the mi content to the message info record record. It can populate all but the record->bdata value, which is set fro mthe bdata_str. Use helper functions camel_util_bdata_put_number() and camel_util_bdata_put_string() to put data into the bdata_str.

    virtual

    Parameters

    • record: MIRecord

      a #CamelMIRecord to populate

    • bdata_str: GLib.String

      a #GString with a string to save as backend specific data (bdata)

    Returns boolean

  • vfunc_set_cc(cc: string): boolean
  • Sets CC from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • cc: string

      a CC to set

    Returns boolean

  • vfunc_set_date_received(date_received: number): boolean
  • Sets received date (the Received header) of the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • date_received: number

      a received date to set

    Returns boolean

  • vfunc_set_date_sent(date_sent: number): boolean
  • Sets sent date (the Date header) of the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • date_sent: number

      a sent date to set

    Returns boolean

  • vfunc_set_flags(mask: number, set: number): boolean
  • Change the state of the flags on the mi. Both mask and set are bit-or of #CamelMessageFlags.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary. In case the CAMEL_MESSAGE_FOLDER_FLAGGED flag would be set and the mi is not aborting notifications, the 'folder-flagged-stamp' changes too.

    virtual

    Parameters

    • mask: number

      mask of flags to change

    • set: number

      state the flags should be changed to

    Returns boolean

  • vfunc_set_from(from: string): boolean
  • Sets From from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • from: string

      a From to set

    Returns boolean

  • vfunc_set_message_id(message_id: number): boolean
  • Sets encoded Message-ID of the associated message as a guint64 number, partial MD5 sum. The value can be cast to #CamelSummaryMessageID.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • message_id: number

      a message id to set

    Returns boolean

  • vfunc_set_mlist(mlist: string): boolean
  • Sets mesage list address from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • mlist: string

      a message list address to set

    Returns boolean

  • vfunc_set_preview(preview: string): boolean
  • Set preview as the body preview of the associated message. Use %NULL or an empty string to unset the value.

    If the mi changed, the 'dirty' flag is set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • preview: string

      message body preview, or %NULL

    Returns boolean

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_set_size(size: number): boolean
  • Sets size of the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • size: number

      a size to set

    Returns boolean

  • vfunc_set_subject(subject: string): boolean
  • Sets Subject from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • subject: string

      a Subject to set

    Returns boolean

  • vfunc_set_to(to: string): boolean
  • Sets To from the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • to: string

      a To to set

    Returns boolean

  • vfunc_set_user_flag(name: string, state: boolean): boolean
  • Change state of the flag named name. Unlike user tags, user flags can only be set or unset, while the user tags can contain certain values.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary.

    virtual

    Parameters

    • name: string

      user flag name

    • state: boolean

      state to set for the flag

    Returns boolean

  • vfunc_set_user_header(name: string, value: string): boolean
  • Set value for a single user-defined message header of the associated message. When the value is %NULL, the header name is removed from the user-defined headers.

    If the mi changed, the 'dirty' flag is set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    virtual

    Parameters

    • name: string

      header name

    • value: string

      header value, or %NULL

    Returns boolean

  • vfunc_set_user_tag(name: string, value: string): boolean
  • Set user tag name to value, or remove it, if value is %NULL.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary.

    virtual

    Parameters

    • name: string

      user tag name

    • value: string

      user tag value, or %NULL to remove the user tag

    Returns boolean

  • Takes headers of the associated message.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Note that it's not safe to use the headers after the call to this function, because it can be freed due to no change.

    virtual

    Parameters

    • headers: NameValueArray

      headers to set, as #CamelNameValueArray, or %NULL

    Returns boolean

  • vfunc_take_references(references: number[]): boolean
  • Takes encoded In-Reply-To and References headers of the associated message as an array of guint64 numbers, partial MD5 sums. Each value can be cast to #CamelSummaryMessageID.

    This property is considered static, in a meaning that it should not change during the life-time of the mi, the same as it doesn't change in the associated message.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Note that it's not safe to use the references after the call to this function, because it can be freed due to no change.

    virtual

    Parameters

    • references: number[]

      a references to set

    Returns boolean

  • vfunc_take_user_flags(user_flags: NamedFlags): boolean
  • Takes all the user_flags, which replaces any current user flags on the mi. The passed-in user_flags is consumed by the mi, which becomes an owner of it. The caller should not change user_flags afterwards.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary.

    Note that it's not safe to use the user_flags after the call to this function, because it can be freed due to no change.

    virtual

    Parameters

    Returns boolean

  • Takes user-defined message headers of the associated message.

    If the mi changed, the 'dirty' flag is set automatically, unless the mi is aborting notifications. There is not emitted folder's "changed" signal for this mi.

    Note that it's not safe to use the headers after the call to this function, because it can be freed due to no change.

    virtual

    Parameters

    • headers: NameValueArray

      headers to set, as #CamelNameValueArray, or %NULL

    Returns boolean

  • Takes all the user_tags, which replaces any current user tags on the mi. The passed-in user_tags is consumed by the mi, which becomes an owner of it. The caller should not change user_tags afterwards.

    If the mi changed, the 'dirty' flag and the 'folder-flagged' flag are set automatically, unless the mi is aborting notifications. There is also emitted folder's "changed" signal for this mi, if necessary.

    Note that it's not safe to use the user_tags after the call to this function, because it can be freed due to no change.

    virtual

    Parameters

    Returns boolean

  • watch_closure(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

  • compat_control(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

    • g_iface: TypeInterface

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

    • property_name: 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

    • g_iface: 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

    • g_iface: TypeInterface

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

    Returns ParamSpec[]

  • 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

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

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