Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

description: string

The folder's description.

display_name: string

The folder's display name.

full_name: string

The folder's fully qualified name.

g_type_instance: TypeInstance
mark_seen: Camel.ThreeState

A #CamelThreeState persistent option of the folder, which can override global option to mark messages as seen after certain interval.

mark_seen_timeout: number

Timeout in milliseconds for marking messages as seen.

offline_sync: Camel.ThreeState
parent: Camel.Folder
parent_store: Camel.Store

The #CamelStore to which the folder belongs.

state_filename: string

The file in which to store persistent property values for this instance.

name: string

Methods

  • Appends message to folder asynchronously. Only the flag and tag data from info are used. If info is %NULL, no flags or tags will be set.

    When the operation is finished, callback will be called. You can then call camel_folder_append_message_finish() to get the result of the operation.

    Parameters

    • message: MimeMessage

      a #CamelMimeMessage

    • info: MessageInfo

      a #CamelMessageInfo with additional flags/etc to set on the new message, or %NULL

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • append_message_finish(result: AsyncResult): [boolean, string]
  • 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

  • can_downsync(): boolean
  • Checks whether the folder can run downsync according to its settings (camel_offline_folder_get_offline_sync()) and to the parent's #CamelOfflineStore settings (camel_offline_settings_get_stay_synchronized()).

    Returns boolean

  • cmp_uids(uid1: string, uid2: string): number
  • Compares two uids. The return value meaning is the same as in any other compare function.

    Note that the default compare function expects a decimal number at the beginning of a uid, thus if provider uses different uid values, then it should subclass this function.

    Parameters

    • uid1: string

      The first uid.

    • uid2: string

      the second uid.

    Returns number

  • connect(sigName: "notify::offline-sync", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::description", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::display-name", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::full-name", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::mark-seen", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::mark-seen-timeout", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::parent-store", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::state-filename", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "notify::offline-sync", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::description", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::display-name", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::full-name", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::mark-seen", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::mark-seen-timeout", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::parent-store", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::state-filename", callback: (($obj: OfflineFolder, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • count_by_expression(expression: string, cancellable: Gio.Cancellable): number
  • delete(): void
  • Marks folder as deleted and performs any required cleanup.

    This also emits the #CamelFolder::deleted signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    Returns void

  • disconnect(id: number): void
  • Synchronizes messages in folder described by the search expression to the local machine asynchronously for offline availability.

    When the operation is finished, callback will be called. You can then call camel_offline_folder_downsync_finish() to get the result of the operation.

    Parameters

    • expression: string

      search expression describing which set of messages to downsync (%NULL for all)

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • downsync_sync(expression: string, cancellable: Gio.Cancellable): boolean
  • Synchronizes messages in folder described by the search expression to the local machine for offline availability.

    Parameters

    • expression: string

      search expression describing which set of messages to downsync (%NULL for all)

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • dup_description(): string
  • Thread-safe variation of camel_folder_get_description(). Use this function when accessing folder from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • dup_display_name(): string
  • Thread-safe variation of camel_folder_get_display_name(). Use this function when accessing folder from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • dup_full_name(): string
  • Thread-safe variation of camel_folder_get_full_name(). Use this function when accessing folder from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • emit(sigName: "notify::offline-sync", ...args: any[]): void
  • emit(sigName: "notify::description", ...args: any[]): void
  • emit(sigName: "notify::display-name", ...args: any[]): void
  • emit(sigName: "notify::full-name", ...args: any[]): void
  • emit(sigName: "notify::mark-seen", ...args: any[]): void
  • emit(sigName: "notify::mark-seen-timeout", ...args: any[]): void
  • emit(sigName: "notify::parent-store", ...args: any[]): void
  • emit(sigName: "notify::state-filename", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Asynchronously deletes messages which have been marked as "DELETED".

    When the operation is finished, callback will be called. You can then call camel_folder_expunge_finish() to get the result of the operation.

    Parameters

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns 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

  • free_deep(array: string[]): void
  • Frees the provided array and its contents. Used by #CamelFolder subclasses as an implementation for free_uids when the provided information was created explicitly by the corresponding get_ call.

    Parameters

    • array: string[]

      an array of uids

    Returns void

  • free_shallow(array: string[]): void
  • Frees the provided array but not its contents. Used by #CamelFolder subclasses as an implementation for free_uids or free_summary when the returned array needs to be freed but its contents come from "static" information.

    Parameters

    • array: string[]

      an array of uids or #CamelMessageInfo

    Returns void

  • free_uids(array: string[]): void
  • freeze(): void
  • Freezes the folder so that a series of operation can be performed without "folder_changed" signals being emitted. When the folder is later thawed with camel_folder_thaw(), the suppressed signals will be emitted.

    Returns 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_data(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

  • get_deleted_message_count(): number
  • get_description(): string
  • get_display_name(): string
  • get_filename(uid: string): string
  • get_flags(): number
  • get_frozen_count(): number
  • get_full_name(): string
  • get_mark_seen_timeout(): number
  • Asynchronously gets the message corresponding to message_uid from folder.

    When the operation is finished, callback will be called. You can then call camel_folder_get_message_finish() to get the result of the operation.

    Parameters

    • message_uid: string

      the message UID

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Gets the message corresponding to message_uid from the folder cache, if available locally. This should not do any network I/O, only check if message is already downloaded and return it quickly, not being blocked by the folder's lock. Returning NULL is not considered as an error, it just means that the message is still to-be-downloaded.

    Note: This function is called automatically within camel_folder_get_message_sync().

    Parameters

    • message_uid: string

      the message UID

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns MimeMessage

  • get_message_count(): number
  • get_message_flags(uid: string): number
  • get_message_user_flag(uid: string, name: string): boolean
  • get_message_user_tag(uid: string, name: string): string
  • get_parent_store(): object
  • get_permanent_flags(): number
  • 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
  • Asynchronously gets a list of known quotas for folder.

    When the operation is finished, callback will be called. You can then call camel_folder_get_quota_info_finish() to get the result of the operation.

    Parameters

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Finishes the operation started with camel_folder_get_quota_info(). Free the returned #CamelFolderQuotaInfo struct with camel_folder_quota_info_free().

    If quotas are not supported for folder, the function returns %NULL and sets error to #G_IO_ERROR_NOT_SUPPORTED.

    Parameters

    Returns FolderQuotaInfo

  • Gets a list of known quotas for folder. Free the returned #CamelFolderQuotaInfo struct with camel_folder_quota_info_free().

    If quotas are not supported for folder, the function returns %NULL and sets error to #G_IO_ERROR_NOT_SUPPORTED.

    Parameters

    Returns FolderQuotaInfo

  • get_state_filename(): string
  • Returns the name of the file in which persistent property values for object are stored. The file is used by camel_object_state_write() and camel_object_state_read() to save and restore object state.

    Returns string

  • get_summary(): string[]
  • get_uids(): string[]
  • Get the list of UIDs available in a folder. This routine is useful for finding what messages are available when the folder does not support summaries. The returned array should not be modified, and must be freed by passing it to camel_folder_free_uids().

    Returns string[]

  • get_uncached_uids(uids: string[]): string[]
  • Returns the known-uncached uids from a list of uids. It may return uids which are locally cached but should never filter out a uid which is not locally cached. Free the result by called camel_folder_free_uids(). Frees the array of UIDs returned by camel_folder_get_uids().

    Parameters

    • uids: string[]

      the array of uids to filter down to uncached ones.

    Returns string[]

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

  • has_summary_capability(): boolean
  • is_floating(): boolean
  • is_frozen(): boolean
  • lock(): void
  • 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

  • prepare_content_refresh(): void
  • Delete the local cache of all messages between these uids.

    When the operation is finished, callback will be called. You can then call camel_folder_purge_message_cache_finish() to get the result of the operation.

    Parameters

    • start_uid: string

      the start message UID

    • end_uid: string

      the end message UID

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • purge_message_cache_finish(result: AsyncResult): boolean
  • purge_message_cache_sync(start_uid: string, end_uid: string, cancellable: Gio.Cancellable): boolean
  • 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

  • Asynchronously synchronizes a folder's summary with its backing store.

    When the operation is finished, callback will be called. You can then call camel_folder_refresh_info_finish() to get the result of the operation.

    Parameters

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • rename(new_name: string): void
  • Marks folder as renamed.

    This also emits the #CamelFolder::renamed signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    NOTE: This is an internal function used by camel stores, no locking is performed on the folder.

    Parameters

    • new_name: string

      new name for the folder

    Returns void

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

  • search_by_expression(expression: string, cancellable: Gio.Cancellable): string[]
  • search_by_uids(expression: string, uids: string[], cancellable: Gio.Cancellable): string[]
  • search_free(result: string[]): void
  • Free the result of a search as gotten by camel_folder_search_by_expression() or camel_folder_search_by_uids().

    Parameters

    • result: string[]

      search results to free

    Returns void

  • 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_description(description: string): void
  • set_display_name(display_name: string): void
  • set_flags(folder_flags: number): void
  • set_full_name(full_name: string): void
  • set_lock_async(skip_folder_lock: boolean): void
  • Sets whether folder locking (camel_folder_lock() and camel_folder_unlock()) should be used. When set to %FALSE, the two functions do nothing and simply return.

    Parameters

    • skip_folder_lock: boolean

      a value to set

    Returns void

  • set_mark_seen_timeout(timeout: number): void
  • Sets the timeout in milliseconds for marking messages as seen in this folder. Whether the timeout is used depends on camel_folder_get_mark_seen().

    Parameters

    • timeout: number

      a timeout in milliseconds

    Returns void

  • set_message_flags(uid: string, mask: number, set: number): boolean
  • Sets those flags specified by mask to the values specified by set on the indicated message. (This may or may not persist after the folder or store is closed. See camel_folder_get_permanent_flags())

    E.g. to set the deleted flag and clear the draft flag, use camel_folder_set_message_flags (folder, uid, CAMEL_MESSAGE_DELETED|CAMEL_MESSAGE_DRAFT, CAMEL_MESSAGE_DELETED);

    Parameters

    • uid: string

      the UID of a message in folder

    • mask: number

      a mask of #CamelMessageFlags bit-or values to use

    • set: number

      the flags to ser, also bit-or of #CamelMessageFlags

    Returns boolean

  • set_message_user_flag(uid: string, name: string, value: boolean): void
  • set_message_user_tag(uid: string, name: string, value: string): void
  • The %CAMEL_THREE_STATE_INCONSISTENT means what the parent store has set.

    Parameters

    • offline_sync: Camel.ThreeState

      whether to synchronize for offline use, as a #CamelThreeState enum

    Returns void

  • set_property(property_name: string, value?: any): void
  • set_state_filename(state_filename: string): void
  • Sets the name of the file in which persistent property values for object are stored. The file is used by camel_object_state_write() and camel_object_state_read() to save and restore object state.

    Parameters

    • state_filename: string

      path to a local file

    Returns void

  • sort_uids(uids: string[]): void
  • state_read(): number
  • state_write(): number
  • steal_data(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

  • 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

  • Synchronizes any changes that have been made to folder to its backing store asynchronously, optionally expunging deleted messages as well.

    When the operation is finished, callback will be called. You can then call camel_folder_synchronize_finish() to get the result of the operation.

    Parameters

    • expunge: boolean

      whether to expunge after synchronizing

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Asynchronously ensure that a message identified by message_uid has been synchronized in folder so that calling camel_folder_get_message() on it later will work in offline mode.

    When the operation is finished, callback will be called. You can then call camel_folder_synchronize_message_finish() to get the result of the operation.

    Parameters

    • message_uid: string

      a message UID

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • synchronize_message_finish(result: AsyncResult): boolean
  • synchronize_message_sync(message_uid: string, cancellable: Gio.Cancellable): boolean
  • Ensure that a message identified by message_uid has been synchronized in folder so that calling camel_folder_get_message() on it later will work in offline mode.

    Parameters

    • message_uid: string

      a message UID

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • synchronize_sync(expunge: boolean, cancellable: Gio.Cancellable): boolean
  • Synchronizes any changes that have been made to folder to its backing store, optionally expunging deleted messages as well.

    Parameters

    • expunge: boolean

      whether to expunge after synchronizing

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Sets a #CamelFolderSummary of the folder. It consumes the summary.

    This is supposed to be called only by the descendants of the #CamelFolder and only at the construction time. Calling this function twice yeilds to an error.

    Parameters

    Returns void

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

  • Asynchronously copies or moves messages from one folder to another. If the source or destination folders have the same parent store, this may be more efficient than using camel_folder_append_message().

    When the operation is finished, callback will be called. You can then call camel_folder_transfer_messages_to_finish() to get the result of the operation.

    Parameters

    • message_uids: string[]

      message UIDs in source

    • destination: Camel.Folder

      the destination #CamelFolder

    • delete_originals: boolean

      whether or not to delete the original messages

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • transfer_messages_to_finish(result: AsyncResult): [boolean, string[]]
  • transfer_messages_to_sync(message_uids: string[], destination: Camel.Folder, delete_originals: boolean, cancellable: Gio.Cancellable): [boolean, string[]]
  • Copies or moves messages from one folder to another. If the source and destination folders have the same parent_store, this may be more efficient than using camel_folder_append_message_sync().

    Parameters

    • message_uids: string[]

      message UIDs in source

    • destination: Camel.Folder

      the destination #CamelFolder

    • delete_originals: boolean

      whether or not to delete the original messages

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string[]]

  • unlock(): 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_cmp_uids(uid1: string, uid2: string): number
  • Compares two uids. The return value meaning is the same as in any other compare function.

    Note that the default compare function expects a decimal number at the beginning of a uid, thus if provider uses different uid values, then it should subclass this function.

    virtual

    Parameters

    • uid1: string

      The first uid.

    • uid2: string

      the second uid.

    Returns number

  • vfunc_constructed(): void
  • vfunc_count_by_expression(expression: string, cancellable: Gio.Cancellable): number
  • vfunc_delete_(): void
  • vfunc_deleted(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_downsync_sync(expression: string, cancellable: Gio.Cancellable): boolean
  • Synchronizes messages in folder described by the search expression to the local machine for offline availability.

    virtual

    Parameters

    • expression: string

      search expression describing which set of messages to downsync (%NULL for all)

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • vfunc_finalize(): void
  • vfunc_free_uids(array: string[]): void
  • vfunc_freeze(): void
  • Freezes the folder so that a series of operation can be performed without "folder_changed" signals being emitted. When the folder is later thawed with camel_folder_thaw(), the suppressed signals will be emitted.

    virtual

    Returns void

  • vfunc_get_filename(uid: string): string
  • Gets the message corresponding to message_uid from the folder cache, if available locally. This should not do any network I/O, only check if message is already downloaded and return it quickly, not being blocked by the folder's lock. Returning NULL is not considered as an error, it just means that the message is still to-be-downloaded.

    Note: This function is called automatically within camel_folder_get_message_sync().

    virtual

    Parameters

    • message_uid: string

      the message UID

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns MimeMessage

  • vfunc_get_message_count(): number
  • vfunc_get_message_flags(uid: string): number
  • vfunc_get_message_user_flag(uid: string, name: string): boolean
  • vfunc_get_message_user_tag(uid: string, name: string): string
  • vfunc_get_permanent_flags(): number
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_get_summary(): string[]
  • vfunc_get_uids(): string[]
  • Get the list of UIDs available in a folder. This routine is useful for finding what messages are available when the folder does not support summaries. The returned array should not be modified, and must be freed by passing it to camel_folder_free_uids().

    virtual

    Returns string[]

  • vfunc_get_uncached_uids(uids: string[]): string[]
  • Returns the known-uncached uids from a list of uids. It may return uids which are locally cached but should never filter out a uid which is not locally cached. Free the result by called camel_folder_free_uids(). Frees the array of UIDs returned by camel_folder_get_uids().

    virtual

    Parameters

    • uids: string[]

      the array of uids to filter down to uncached ones.

    Returns string[]

  • vfunc_has_search_capability(): boolean
  • vfunc_is_frozen(): 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

  • vfunc_prepare_content_refresh(): void
  • vfunc_purge_message_cache_sync(start_uid: string, end_uid: string, cancellable: Gio.Cancellable): boolean
  • vfunc_rename(new_name: string): void
  • Marks folder as renamed.

    This also emits the #CamelFolder::renamed signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    NOTE: This is an internal function used by camel stores, no locking is performed on the folder.

    virtual

    Parameters

    • new_name: string

      new name for the folder

    Returns void

  • vfunc_renamed(old_name: string): void
  • vfunc_search_by_expression(expression: string, cancellable: Gio.Cancellable): string[]
  • vfunc_search_by_uids(expression: string, uids: string[], cancellable: Gio.Cancellable): string[]
  • vfunc_search_free(result: string[]): void
  • vfunc_set_message_flags(uid: string, mask: number, set: number): boolean
  • Sets those flags specified by mask to the values specified by set on the indicated message. (This may or may not persist after the folder or store is closed. See camel_folder_get_permanent_flags())

    E.g. to set the deleted flag and clear the draft flag, use camel_folder_set_message_flags (folder, uid, CAMEL_MESSAGE_DELETED|CAMEL_MESSAGE_DRAFT, CAMEL_MESSAGE_DELETED);

    virtual

    Parameters

    • uid: string

      the UID of a message in folder

    • mask: number

      a mask of #CamelMessageFlags bit-or values to use

    • set: number

      the flags to ser, also bit-or of #CamelMessageFlags

    Returns boolean

  • vfunc_set_message_user_flag(uid: string, name: string, value: boolean): void
  • vfunc_set_message_user_tag(uid: string, name: string, value: string): void
  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_sort_uids(uids: string[]): void
  • vfunc_state_read(fp: object): number
  • vfunc_state_write(fp: object): number
  • vfunc_synchronize_message_sync(message_uid: string, cancellable: Gio.Cancellable): boolean
  • vfunc_synchronize_sync(expunge: boolean, cancellable: Gio.Cancellable): boolean
  • Synchronizes any changes that have been made to folder to its backing store, optionally expunging deleted messages as well.

    virtual

    Parameters

    • expunge: boolean

      whether to expunge after synchronizing

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • vfunc_thaw(): void
  • vfunc_transfer_messages_to_sync(message_uids: string[], destination: Camel.Folder, delete_originals: boolean, cancellable: Gio.Cancellable): [boolean, string[]]
  • Copies or moves messages from one folder to another. If the source and destination folders have the same parent_store, this may be more efficient than using camel_folder_append_message_sync().

    virtual

    Parameters

    • message_uids: string[]

      message UIDs in source

    • destination: Camel.Folder

      the destination #CamelFolder

    • delete_originals: boolean

      whether or not to delete the original messages

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string[]]

  • 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