Class

CamelOfflineStore

Description [src]

class Camel.OfflineStore : Camel.Store
  implements Gio.Initable {
  CamelOfflineStorePrivate* priv
}

Base class for offline-capable mail stores.

CamelOfflineStore is a CamelStore subclass that any remote backend supporting offline operation should extend instead of CamelStore directly.

It adds a network availability state (online / offline) that client code can query and change via camel_offline_store_get_online() and camel_offline_store_set_online(). When going offline, the base class implementation synchronises all CamelOfflineFolder instances that are currently active.

Backends using CamelOfflineStore should also provide CamelOfflineFolder-based folders for any folders representing remote data, so that the per-folder offline sync behaviour can be controlled.

Hierarchy

Ancestors

Implements

GInitable

Instance methods

camel_offline_store_dup_downsync_folders

Returns a GPtrArray of CamelFolder objects which should be checked for offline synchronization. Free the returned pointer with the below calls, when no longer needed:.

since: 3.28

camel_offline_store_get_online

Returns TRUE if store is online.

since: 2.24

camel_offline_store_prepare_for_offline_sync

Downloads messages for offline, when setup to do so and when the host is reachable.

since: 2.22

camel_offline_store_requires_downsync

Check whether the store requires synchronization for offline usage. This is not blocking, it only checks settings on the store and its currently opened folders.

since: 3.12

camel_offline_store_set_online

An asynchronous variant of camel_offline_store_set_online_sync(). Call camel_offline_store_set_online_finish() from within the callback.

since: 3.26

camel_offline_store_set_online_finish

Finishes the operation started with camel_offline_store_set_online().

since: 3.26

camel_offline_store_set_online_sync

Sets the online/offline state of store according to online.

Methods inherited from CamelStore (46)

Please see CamelStore for a full list of methods.

Methods inherited from CamelService (30)

Please see CamelService for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GInitable (1)

g_initable_init

Initializes the object implementing the interface.

Properties

Camel.OfflineStore:online

Whether the store is online.

Properties inherited from CamelService (9)

Camel.Service:connection-status

The connection status for the service.

Camel.Service:display-name

The display name for the service.

Camel.Service:password

The password for the service.

Camel.Service:provider

The CamelProvider for the service.

Camel.Service:proxy-resolver

The proxy resolver for the service.

Camel.Service:session

A CamelSession instance.

Camel.Service:settings

A CamelSettings instance.

Camel.Service:uid

The unique identity of the service.

Camel.Service:with-proxy-resolver

Private property, to not create GProxyResolver in the tests.

Signals

Signals inherited from CamelStore (5)

CamelStore::folder-created

No description available.

CamelStore::folder-deleted

No description available.

CamelStore::folder-info-stale

This signal indicates significant changes have occurred to the folder hierarchy of store, and that previously fetched CamelFolderInfo data should be considered stale.

CamelStore::folder-opened

No description available.

CamelStore::folder-renamed

No description available.

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct CamelOfflineStoreClass {
  CamelStoreClass parent_class;
  GPtrArray* (* dup_downsync_folders) (
    CamelOfflineStore* store
  );
  gpointer reserved;
  
}

No description available.

Class members

parent_class: CamelStoreClass: No description available.
dup_downsync_folders: GPtrArray* (* dup_downsync_folders) ( CamelOfflineStore* store ): No description available.
reserved: gpointer: No description available.

Virtual methods

Camel.OfflineStoreClass.dup_downsync_folders

Returns a GPtrArray of CamelFolder objects which should be checked for offline synchronization. Free the returned pointer with the below calls, when no longer needed:.

since: 3.28