CamelOfflineFolder

CamelOfflineFolder

Synopsis

struct              CamelOfflineFolder;
gboolean            camel_offline_folder_get_offline_sync
                                                        (CamelOfflineFolder *folder);
void                camel_offline_folder_set_offline_sync
                                                        (CamelOfflineFolder *folder,
                                                         gboolean offline_sync);
gboolean            camel_offline_folder_downsync_sync  (CamelOfflineFolder *folder,
                                                         const gchar *expression,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                camel_offline_folder_downsync       (CamelOfflineFolder *folder,
                                                         const gchar *expression,
                                                         gint io_priority,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            camel_offline_folder_downsync_finish
                                                        (CamelOfflineFolder *folder,
                                                         GAsyncResult *result,
                                                         GError **error);

Object Hierarchy

  GObject
   +----CamelObject
         +----CamelFolder
               +----CamelOfflineFolder
                     +----CamelIMAPXFolder

Properties

  "offline-sync"             gboolean              : Read / Write

Description

Details

struct CamelOfflineFolder

struct CamelOfflineFolder;

camel_offline_folder_get_offline_sync ()

gboolean            camel_offline_folder_get_offline_sync
                                                        (CamelOfflineFolder *folder);

folder :

a CamelOfflineFolder

Since 2.32


camel_offline_folder_set_offline_sync ()

void                camel_offline_folder_set_offline_sync
                                                        (CamelOfflineFolder *folder,
                                                         gboolean offline_sync);

folder :

a CamelOfflineFolder

offline_sync :

whether to synchronize for offline use

Since 2.32


camel_offline_folder_downsync_sync ()

gboolean            camel_offline_folder_downsync_sync  (CamelOfflineFolder *folder,
                                                         const gchar *expression,
                                                         GCancellable *cancellable,
                                                         GError **error);

Synchronizes messages in folder described by the search expression to the local machine for offline availability.

folder :

a CamelOfflineFolder

expression :

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

cancellable :

optional GCancellable object, or NULL

error :

return location for a GError, or NULL

Returns :

TRUE on success, FALSE on error

Since 3.0


camel_offline_folder_downsync ()

void                camel_offline_folder_downsync       (CamelOfflineFolder *folder,
                                                         const gchar *expression,
                                                         gint io_priority,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

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.

folder :

a CamelOfflineFolder

expression :

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

io_priority :

the I/O priority of the request

cancellable :

optional GCancellable object, or NULl

callback :

a GAsyncReadyCallback to call when the request is satisfied

user_data :

data to pass to the callback function

Since 3.0


camel_offline_folder_downsync_finish ()

gboolean            camel_offline_folder_downsync_finish
                                                        (CamelOfflineFolder *folder,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes the operation started with camel_offline_folder_downsync().

folder :

a CamelOfflineFolder

result :

a GAsyncResult

error :

return location for a GError, or NULL

Returns :

TRUE on success, FALSE on error

Since 3.0

Property Details

The "offline-sync" property

  "offline-sync"             gboolean              : Read / Write

Copy folder content locally for _offline operation.

Default value: FALSE