Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

connection_status: ServiceConnectionStatus
display_name: string
g_type_instance: TypeInstance
parent: any
password: string
priv: any
provider: Camel.Provider
proxy_resolver: Gio.ProxyResolver
session: Camel.Session
settings: Camel.Settings
state_filename: string

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

uid: string
name: string

Methods

  • Asynchronously attempts to authenticate service using mechanism and, if necessary, service's #CamelService:password property. The function makes only ONE attempt at authentication and does not loop.

    Generally this function should only be called from a #CamelSession subclass in order to implement its own authentication loop.

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

    Parameters

    • mechanism: string

      a SASL mechanism name, 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

  • Finishes the operation started with camel_service_authenticate().

    If the authentication attempt completed and the server accepted the credentials, the function returns #CAMEL_AUTHENTICATION_ACCEPTED.

    If the authentication attempt completed but the server rejected the credentials, the function returns #CAMEL_AUTHENTICATION_REJECTED.

    If the authentication attempt failed to complete due to a network communication issue or some other mishap, the function sets error and returns #CAMEL_AUTHENTICATION_ERROR.

    Parameters

    Returns AuthenticationResult

  • Attempts to authenticate service using mechanism and, if necessary, service's #CamelService:password property. The function makes only ONE attempt at authentication and does not loop.

    If the authentication attempt completed and the server accepted the credentials, the function returns #CAMEL_AUTHENTICATION_ACCEPTED.

    If the authentication attempt completed but the server rejected the credentials, the function returns #CAMEL_AUTHENTICATION_REJECTED.

    If the authentication attempt failed to complete due to a network communication issue or some other mishap, the function sets error and returns #CAMEL_AUTHENTICATION_ERROR.

    Generally this function should only be called from a #CamelSession subclass in order to implement its own authentication loop.

    Parameters

    • mechanism: string

      a SASL mechanism name, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns AuthenticationResult

  • 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

  • Returns if this folder (param info) should be checked for new mail or not. It should not look into sub infos (info->child) or next infos, it should return value only for the actual folder info. Default behavior is that all Inbox folders are intended to be refreshed.

    Parameters

    Returns boolean

  • Connects service to a remote server using the information in its #CamelService:settings instance.

    If a connect operation is already in progress when this function is called, its results will be reflected in this connect operation.

    Parameters

    Returns boolean

  • Asynchronously creates a new folder as a child of an existing folder. parent_name can be %NULL to create a new top-level folder.

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

    Parameters

    • parent_name: string

      name of the new folder's parent, or %NULL

    • folder_name: string

      name of the folder to create

    • 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

  • Creates a new folder as a child of an existing folder. parent_name can be %NULL to create a new top-level folder. The returned #CamelFolderInfo struct should be freed with camel_folder_info_free().

    Parameters

    • parent_name: string

      name of the new folder's parent, or %NULL

    • folder_name: string

      name of the folder to create

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns FolderInfo

  • delete_cached_folder(folder_name: string): void
  • Deletes local data for the given folder_name. The folder should be part of the opened folders.

    It doesn't delete the folder in the store (server) as such. Use camel_store_delete_folder(), or its synchronous variant, if you want to do that instead.

    Parameters

    • folder_name: string

      a folder full name to delete from the cache

    Returns void

  • Asynchronously deletes the folder described by folder_name. The folder must be empty.

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

    Parameters

    • folder_name: string

      name of the folder to delete

    • 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

  • delete_folder_sync(folder_name: string, cancellable: Gio.Cancellable): boolean
  • disconnect(id: number): void
  • disconnect_sync(clean: boolean, cancellable: Gio.Cancellable): boolean
  • Disconnect from the service. If clean is %FALSE, it should not try to do any synchronizing or other cleanup of the connection.

    If a disconnect operation is already in progress when this function is called, its results will be reflected in this disconnect operation.

    If any connect operations are in progress when this function is called, they will be cancelled.

    Parameters

    • clean: boolean

      whether or not to try to disconnect cleanly

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

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

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

    Returns string

  • Returns a #GPtrArray of all the opened folders for the store. The caller owns both the array and the folder references, so to free the array use:

    |[ g_ptr_array_foreach (array, (GFunc) g_object_unref, NULL); g_ptr_array_free (array, TRUE);

    
    

    Returns Camel.Folder[]

  • dup_password(): string
  • Thread-safe variation of camel_service_get_password(). Use this function when accessing service from multiple threads.

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

    Returns string

  • emit(sigName: "folder-subscribed", object: FolderInfo, ...args: any[]): void
  • emit(sigName: "folder-unsubscribed", object: FolderInfo, ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Emits the #CamelStore::folder-created signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    Parameters

    • folder_info: FolderInfo

      information about the created folder

    Returns void

  • Emits the #CamelStore::folder-deleted signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    Parameters

    • folder_info: FolderInfo

      information about the deleted folder

    Returns void

  • folder_info_stale(): void
  • Emits the #CamelStore::folder-info-stale signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_LOW.

    See the #CamelStore::folder-info-stale documentation for details on when to use this signal.

    This function is only intended for Camel providers.

    Returns void

  • folder_is_subscribed(folder_name: string): boolean
  • Find out if a folder has been subscribed to.

    Parameters

    • folder_name: string

      full path of the folder

    Returns boolean

  • Emits the #CamelStore::folder-opened signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    Parameters

    Returns void

  • folder_renamed(old_name: string, folder_info: FolderInfo): void
  • Emits the #CamelStore::folder-renamed signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    Parameters

    • old_name: string

      the old name of the folder

    • folder_info: FolderInfo

      information about the renamed folder

    Returns void

  • Emits the #CamelSubscribable::folder-subscribed signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    Parameters

    • folder_info: FolderInfo

      information about the subscribed folder

    Returns void

  • folder_unsubscribed(folder_info: FolderInfo): void
  • Emits the #CamelSubscribable::folder-unsubscribed signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    Parameters

    • folder_info: FolderInfo

      information about the unsubscribed folder

    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

  • 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_can_auto_save_changes(): boolean
  • 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_db(): DB
  • get_display_name(): string
  • Returns the display name for service, or %NULL if service has not been given a display name. The display name is intended for use in a user interface and should generally be given a user-defined name.

    Compare this with camel_service_get_name(), which returns a built-in description of the type of service (IMAP, SMTP, etc.).

    Returns string

  • get_flags(): number
  • Asynchronously gets a specific folder object from store by name.

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

    Parameters

    • folder_name: string

      name of the folder to get

    • flags: StoreGetFolderFlags

      folder flags (create, save body index, etc)

    • 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 fetches information about the folder structure of store, starting with top. For details of the behavior, see camel_store_get_folder_info_sync().

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

    Parameters

    • top: string

      the name of the folder to start from

    • flags: StoreGetFolderInfoFlags

      various CAMEL_STORE_FOLDER_INFO_* flags to control behavior

    • 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

  • This fetches information about the folder structure of store, starting with top, and returns a tree of #CamelFolderInfo structures. If flags includes %CAMEL_STORE_FOLDER_INFO_SUBSCRIBED, only subscribed folders will be listed. If the store doesn't support subscriptions, then it will list all folders. If flags includes %CAMEL_STORE_FOLDER_INFO_RECURSIVE, the returned tree will include all levels of hierarchy below top. If not, it will only include the immediate subfolders of top. If flags includes %CAMEL_STORE_FOLDER_INFO_FAST, the unread_message_count fields of some or all of the structures may be set to -1, if the store cannot determine that information quickly. If flags includes %CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL, don't include special virtual folders (such as vTrash or vJunk).

    The returned #CamelFolderInfo tree should be freed with camel_folder_info_free().

    The CAMEL_STORE_FOLDER_INFO_FAST flag should be considered deprecated; most backends will behave the same whether it is supplied or not. The only guaranteed way to get updated folder counts is to both open the folder and invoke camel_folder_refresh_info() it.

    Parameters

    • top: string

      the name of the folder to start from

    • flags: StoreGetFolderInfoFlags

      various CAMEL_STORE_FOLDER_INFO_* flags to control behavior

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns FolderInfo

  • Asynchronously gets the folder in store into which new mail is delivered.

    When the operation is finished, callback will be called. You can then call camel_store_get_inbox_folder_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

  • Asynchronously gets the folder in store into which junk is delivered.

    When the operation is finished, callback will be called. You can then call camel_store_get_junk_folder_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

  • get_name(brief: boolean): string
  • This gets the name of the service in a "friendly" (suitable for humans) form. If brief is %TRUE, this should be a brief description such as for use in the folder tree. If brief is %FALSE, it should be a more complete and mostly unambiguous description.

    Parameters

    • brief: boolean

      whether or not to use a briefer form

    Returns string

  • get_password(): string
  • get_permissions(): 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
  • 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

  • Asynchronously gets the folder in store into which trash is delivered.

    When the operation is finished, callback will be called. You can then call camel_store_get_trash_folder_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

  • get_uid(): string
  • get_user_cache_dir(): string
  • Returns the base directory under which to store cache data for service. The directory is formed by appending the directory returned by camel_session_get_user_cache_dir() with the service's #CamelService:uid value.

    Returns string

  • get_user_data_dir(): string
  • Returns the base directory under which to store user-specific data for service. The directory is formed by appending the directory returned by camel_session_get_user_data_dir() with the service's #CamelService:uid value.

    Returns 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

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • Runs initial setup for the store asynchronously.

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

    The store advertises support of this function by including CAMEL_STORE_SUPPORTS_INITIAL_SETUP in CamelStore::flags.

    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

  • initial_setup_finish(result: AsyncResult): [boolean, HashTable<string | number | symbol, string | number | boolean>]
  • Finishes the operation started with camel_store_initial_setup().

    The save_setup result, if not %NULL, should be freed using g_hash_table_destroy(). It's not an error to have it %NULL, it only means the store doesn't have anything to save.

    Parameters

    Returns [boolean, HashTable<string | number | symbol, string | number | boolean>]

  • initial_setup_sync(cancellable: Gio.Cancellable): [boolean, HashTable<string | number | symbol, string | number | boolean>]
  • Runs initial setup for the store. It's meant to preset some values the first time the account connects to the server after it had been created. The function should return %TRUE even if it didn't populate anything. The default implementation does just that.

    The save_setup result, if not %NULL, should be freed using g_hash_table_destroy(). It's not an error to have it %NULL, it only means the store doesn't have anything to save. Both the key and the value in the hash are newly allocated UTF-8 strings, owned by the hash table.

    The store advertises support of this function by including CAMEL_STORE_SUPPORTS_INITIAL_SETUP in CamelStore::flags.

    Parameters

    Returns [boolean, HashTable<string | number | symbol, string | number | boolean>]

  • is_floating(): boolean
  • maybe_run_db_maintenance(): boolean
  • migrate_files(): void
  • Performs any necessary file migrations for service. This should be called after installing or configuring the service's #CamelSettings, since it requires building a URL string for service.

    Returns void

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

  • Asynchronously obtains a list of authentication types supported by service.

    When the operation is finished, callback will be called. You can then call camel_service_query_auth_types_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

  • Adds task to a queue of waiting tasks with the same source object. Queued tasks execute one at a time in the order they were added. When task reaches the front of the queue, it will be dispatched by invoking task_func in a separate thread. If task is cancelled while queued, it will complete immediately with an appropriate error.

    This is primarily intended for use by #CamelStore, #CamelTransport and #CamelFolder to achieve ordered invocation of synchronous class methods.

    Parameters

    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

  • Returns the #GProxyResolver for service. If an application needs to override this, it should do so prior to calling functions on service that may require a network connection.

    The returned #GProxyResolver is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

    Returns Gio.ProxyResolver

  • 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 renames the folder described by old_name to new_name.

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

    Parameters

    • old_name: string

      the current name of the folder

    • new_name: string

      the new name of the folder

    • 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_folder_sync(old_name: string, new_name: string, cancellable: Gio.Cancellable): boolean
  • 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

  • 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_display_name(display_name: string): void
  • Assigns a UTF-8 display name to service. The display name is intended for use in a user interface and should generally be given a user-defined name.

    Compare this with camel_service_get_name(), which returns a built-in description of the type of service (IMAP, SMTP, etc.).

    Parameters

    • display_name: string

      a valid UTF-8 string, or %NULL

    Returns void

  • set_flags(flags: number): void
  • set_password(password: string): void
  • Sets the password for service. Use this function to cache the password in memory after obtaining it through camel_session_get_password(). Some SASL mechanisms use this when attempting to authenticate.

    Parameters

    • password: string

      the password for service

    Returns void

  • set_permissions(permissions: number): void
  • Sets permissions for the store, a bit-or of #CamelStorePermissionFlags

    Parameters

    • permissions: number

      permissions of the store, a bit-or of #CamelStorePermissionFlags

    Returns void

  • set_property(property_name: string, value?: any): void
  • Sets the #GProxyResolver for service. If an application needs to override this, it should do so prior to calling functions on service that may require a network connection.

    Parameters

    Returns void

  • Associates a new #CamelSettings instance with the service. The settings instance must match the settings type defined in #CamelServiceClass. If settings is %NULL, a new #CamelSettings instance of the appropriate type is created with all properties set to defaults.

    Parameters

    • settings: Camel.Settings

      an instance derviced from #CamelSettings, or %NULL

    Returns 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

  • 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

  • Asynchronously subscribes to the folder described by folder_name.

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

    Parameters

    • folder_name: string

      full path of the folder

    • 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

  • subscribe_folder_sync(folder_name: string, cancellable: Gio.Cancellable): boolean
  • Subscribes to the folder described by folder_name.

    Parameters

    • folder_name: string

      full path of the folder

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Synchronizes any changes that have been made to store and its folders with the real store asynchronously.

    When the operation is finished, callback will be called. You can then call camel_store_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

  • synchronize_sync(expunge: boolean, cancellable: Gio.Cancellable): boolean
  • 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

  • Asynchronously unsubscribes from the folder described by folder_name.

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

    Parameters

    • folder_name: string

      full path of the folder

    • 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

  • unsubscribe_folder_finish(result: AsyncResult): boolean
  • unsubscribe_folder_sync(folder_name: string, cancellable: Gio.Cancellable): boolean
  • Unsubscribes from the folder described by folder_name.

    Parameters

    • folder_name: string

      full path of the folder

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Attempts to authenticate service using mechanism and, if necessary, service's #CamelService:password property. The function makes only ONE attempt at authentication and does not loop.

    If the authentication attempt completed and the server accepted the credentials, the function returns #CAMEL_AUTHENTICATION_ACCEPTED.

    If the authentication attempt completed but the server rejected the credentials, the function returns #CAMEL_AUTHENTICATION_REJECTED.

    If the authentication attempt failed to complete due to a network communication issue or some other mishap, the function sets error and returns #CAMEL_AUTHENTICATION_ERROR.

    Generally this function should only be called from a #CamelSession subclass in order to implement its own authentication loop.

    virtual

    Parameters

    • mechanism: string

      a SASL mechanism name, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns AuthenticationResult

  • vfunc_can_refresh_folder(info: FolderInfo): boolean
  • Returns if this folder (param info) should be checked for new mail or not. It should not look into sub infos (info->child) or next infos, it should return value only for the actual folder info. Default behavior is that all Inbox folders are intended to be refreshed.

    virtual

    Parameters

    Returns boolean

  • Connects service to a remote server using the information in its #CamelService:settings instance.

    If a connect operation is already in progress when this function is called, its results will be reflected in this connect operation.

    virtual

    Parameters

    Returns boolean

  • vfunc_constructed(): void
  • Creates a new folder as a child of an existing folder. parent_name can be %NULL to create a new top-level folder. The returned #CamelFolderInfo struct should be freed with camel_folder_info_free().

    virtual

    Parameters

    • parent_name: string

      name of the new folder's parent, or %NULL

    • folder_name: string

      name of the folder to create

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns FolderInfo

  • vfunc_delete_folder_sync(folder_name: string, cancellable: Gio.Cancellable): boolean
  • vfunc_disconnect_sync(clean: boolean, cancellable: Gio.Cancellable): boolean
  • Disconnect from the service. If clean is %FALSE, it should not try to do any synchronizing or other cleanup of the connection.

    If a disconnect operation is already in progress when this function is called, its results will be reflected in this disconnect operation.

    If any connect operations are in progress when this function is called, they will be cancelled.

    virtual

    Parameters

    • clean: boolean

      whether or not to try to disconnect cleanly

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_folder_created(folder_info: FolderInfo): void
  • Emits the #CamelStore::folder-created signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    virtual

    Parameters

    • folder_info: FolderInfo

      information about the created folder

    Returns void

  • vfunc_folder_deleted(folder_info: FolderInfo): void
  • Emits the #CamelStore::folder-deleted signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    virtual

    Parameters

    • folder_info: FolderInfo

      information about the deleted folder

    Returns void

  • vfunc_folder_info_stale(): void
  • Emits the #CamelStore::folder-info-stale signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_LOW.

    See the #CamelStore::folder-info-stale documentation for details on when to use this signal.

    This function is only intended for Camel providers.

    virtual

    Returns void

  • vfunc_folder_is_subscribed(folder_name: string): boolean
  • Find out if a folder has been subscribed to.

    virtual

    Parameters

    • folder_name: string

      full path of the folder

    Returns boolean

  • Emits the #CamelStore::folder-opened signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    virtual

    Parameters

    Returns void

  • vfunc_folder_renamed(old_name: string, folder_info: FolderInfo): void
  • Emits the #CamelStore::folder-renamed signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    virtual

    Parameters

    • old_name: string

      the old name of the folder

    • folder_info: FolderInfo

      information about the renamed folder

    Returns void

  • vfunc_folder_subscribed(folder_info: FolderInfo): void
  • Emits the #CamelSubscribable::folder-subscribed signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    virtual

    Parameters

    • folder_info: FolderInfo

      information about the subscribed folder

    Returns void

  • vfunc_folder_unsubscribed(folder_info: FolderInfo): void
  • Emits the #CamelSubscribable::folder-unsubscribed signal from an idle source on the main loop. The idle source's priority is #G_PRIORITY_HIGH_IDLE.

    This function is only intended for Camel providers.

    virtual

    Parameters

    • folder_info: FolderInfo

      information about the unsubscribed folder

    Returns void

  • vfunc_get_can_auto_save_changes(): boolean
  • This fetches information about the folder structure of store, starting with top, and returns a tree of #CamelFolderInfo structures. If flags includes %CAMEL_STORE_FOLDER_INFO_SUBSCRIBED, only subscribed folders will be listed. If the store doesn't support subscriptions, then it will list all folders. If flags includes %CAMEL_STORE_FOLDER_INFO_RECURSIVE, the returned tree will include all levels of hierarchy below top. If not, it will only include the immediate subfolders of top. If flags includes %CAMEL_STORE_FOLDER_INFO_FAST, the unread_message_count fields of some or all of the structures may be set to -1, if the store cannot determine that information quickly. If flags includes %CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL, don't include special virtual folders (such as vTrash or vJunk).

    The returned #CamelFolderInfo tree should be freed with camel_folder_info_free().

    The CAMEL_STORE_FOLDER_INFO_FAST flag should be considered deprecated; most backends will behave the same whether it is supplied or not. The only guaranteed way to get updated folder counts is to both open the folder and invoke camel_folder_refresh_info() it.

    virtual

    Parameters

    • top: string

      the name of the folder to start from

    • flags: StoreGetFolderInfoFlags

      various CAMEL_STORE_FOLDER_INFO_* flags to control behavior

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns FolderInfo

  • vfunc_get_name(brief: boolean): string
  • This gets the name of the service in a "friendly" (suitable for humans) form. If brief is %TRUE, this should be a brief description such as for use in the folder tree. If brief is %FALSE, it should be a more complete and mostly unambiguous description.

    virtual

    Parameters

    • brief: boolean

      whether or not to use a briefer form

    Returns string

  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    virtual

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • vfunc_initial_setup_sync(cancellable: Gio.Cancellable): [boolean, HashTable<string | number | symbol, string | number | boolean>]
  • Runs initial setup for the store. It's meant to preset some values the first time the account connects to the server after it had been created. The function should return %TRUE even if it didn't populate anything. The default implementation does just that.

    The save_setup result, if not %NULL, should be freed using g_hash_table_destroy(). It's not an error to have it %NULL, it only means the store doesn't have anything to save. Both the key and the value in the hash are newly allocated UTF-8 strings, owned by the hash table.

    The store advertises support of this function by including CAMEL_STORE_SUPPORTS_INITIAL_SETUP in CamelStore::flags.

    virtual

    Parameters

    Returns [boolean, HashTable<string | number | symbol, string | number | 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_rename_folder_sync(old_name: string, new_name: string, cancellable: Gio.Cancellable): boolean
  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_state_read(fp: object): number
  • vfunc_state_write(fp: object): number
  • vfunc_subscribe_folder_sync(folder_name: string, cancellable: Gio.Cancellable): boolean
  • Subscribes to the folder described by folder_name.

    virtual

    Parameters

    • folder_name: string

      full path of the folder

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • vfunc_synchronize_sync(expunge: boolean, cancellable: Gio.Cancellable): boolean
  • vfunc_unsubscribe_folder_sync(folder_name: string, cancellable: Gio.Cancellable): boolean
  • Unsubscribes from the folder described by folder_name.

    virtual

    Parameters

    • folder_name: string

      full path of the folder

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    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