Camel.OfflineStore¶

Subclasses:: None

Methods¶

Inherited:: Camel.Store (46), Camel.Service (32), Camel.Object (4), GObject.Object (37), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

	`dup_downsync_folders` ()
	`get_online` ()
	`prepare_for_offline_sync` (cancellable)
	`requires_downsync` ()
	`set_online` (online, io_priority, cancellable, callback, *user_data)
	`set_online_finish` (result)
	`set_online_sync` (online, cancellable)

Virtual Methods¶

Inherited:: Camel.Store (17), Camel.Service (5), Camel.Object (2), GObject.Object (7), Gio.Initable (1)

do_dup_downsync_folders ()

Properties¶

Inherited:: Camel.Service (8), Camel.Object (1)

Name	Type	Flags	Short Description
`online`	`bool`	r	Whether the store is online

Signals¶

Inherited:: Camel.Store (5), GObject.Object (1)

Fields¶

Inherited:: Camel.Store (5), GObject.Object (1)

Name	Type	Access	Description
parent	`Camel.Store`	r

Class Details¶

class Camel.OfflineStore(**kwargs)¶

Bases:: Camel.Store
Abstract:: No
Structure:: Camel.OfflineStoreClass

dup_downsync_folders()¶

Returns:: an array with folders to be checked for offline synchronization.
Return type:: [Camel.Folder]

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

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

New in version 3.28.

get_online()¶

Return type:: bool

Returns True if self is online.

New in version 2.24.

prepare_for_offline_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
Raises:: GLib.Error
Returns:: whether succeeded
Return type:: bool

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

New in version 2.22.

requires_downsync()¶

Return type:: bool

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

Returns True if the self requires synchronization for offline usage

New in version 3.12.

set_online(online, io_priority, cancellable, callback, *user_data)¶

Parameters:

online (bool) – True for online, False for offline
io_priority (int) – the I/O priority for the request
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the request is satisfied
user_data (object or None) – data to pass to the callback function

An asynchronous variant of Camel.OfflineStore.set_online_sync(). Call Camel.OfflineStore.set_online_finish() from within the callback.

New in version 3.26.

set_online_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: Whether succeeded.
Return type:: bool

Finishes the operation started with Camel.OfflineStore.set_online().

New in version 3.26.

set_online_sync(online, cancellable)¶

Parameters:

online (bool) – True for online, False for offline
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

Whether succeeded.

See: Camel.OfflineStore.set_online

Return type:

bool

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

do_dup_downsync_folders() virtual¶

Returns:: an array with folders to be checked for offline synchronization.
Return type:: [Camel.Folder]

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

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

New in version 3.28.

Property Details¶

Camel.OfflineStore.props.online¶

Name:: online
Type:: bool
Default Value:: False
Flags:: READABLE

Whether the store is online