CamelDiscoFolder

CamelDiscoFolder

Functions

Properties

gboolean offline-sync Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── CamelObject
        ╰── CamelFolder
            ╰── CamelDiscoFolder

Description

Functions

camel_disco_folder_get_offline_sync ()

gboolean
camel_disco_folder_get_offline_sync (CamelDiscoFolder *disco_folder);

camel_disco_folder_get_offline_sync is deprecated and should not be used in newly-written code.

Parameters

disco_folder

a CamelDiscoFolder

 

Since 2.32


camel_disco_folder_set_offline_sync ()

void
camel_disco_folder_set_offline_sync (CamelDiscoFolder *disco_folder,
                                     gboolean offline_sync);

camel_disco_folder_set_offline_sync is deprecated and should not be used in newly-written code.

Parameters

disco_folder

a CamelDiscoFolder

 

offline_sync

whether to synchronize for offline use

 

Since 2.32


camel_disco_folder_expunge_uids ()

gboolean
camel_disco_folder_expunge_uids (CamelFolder *folder,
                                 GPtrArray *uids,
                                 GCancellable *cancellable,
                                 GError **error);

camel_disco_folder_expunge_uids is deprecated and should not be used in newly-written code.

This expunges the messages in uids from folder . It should take whatever steps are needed to avoid expunging any other messages, although in some cases it may not be possible to avoid expunging messages that are marked deleted by another client at the same time as the expunge_uids call is running.

Parameters

folder

a (disconnectable) folder

 

uids

array of UIDs to expunge

 

cancellable

optional GCancellable object, or NULL

 

error

return location for a GError, or NULL

 

Returns

TRUE on success, FALSE on failure


camel_disco_folder_cache_message ()

gboolean
camel_disco_folder_cache_message (CamelDiscoFolder *disco_folder,
                                  const gchar *uid,
                                  GCancellable *cancellable,
                                  GError **error);

camel_disco_folder_cache_message is deprecated and should not be used in newly-written code.

Requests that disco_folder cache message uid to disk.

Parameters

disco_folder

the folder

 

uid

the UID of the message to cache

 

cancellable

optional GCancellable object, or NULL

 

error

return location for a GError, or NULL

 

Returns

TRUE on success, FALSE on failure


camel_disco_folder_prepare_for_offline ()

gboolean
camel_disco_folder_prepare_for_offline
                               (CamelDiscoFolder *disco_folder,
                                const gchar *expression,
                                GCancellable *cancellable,
                                GError **error);

camel_disco_folder_prepare_for_offline is deprecated and should not be used in newly-written code.

This prepares disco_folder for offline operation, by downloading the bodies of all messages described by expression (using the same syntax as camel_folder_search_by_expression() ).

Parameters

disco_folder

the folder

 

expression

an expression describing messages to synchronize, or NULL if all messages should be sync'ed.

 

cancellable

optional GCancellable object, or NULL

 

error

return location for a GError, or NULL

 

Returns

TRUE on success, FALSE on failure

Types and Values

struct CamelDiscoFolder

struct CamelDiscoFolder;

CamelDiscoFolder is deprecated and should not be used in newly-written code.

Property Details

The “offline-sync” property

  “offline-sync”             gboolean

Copy folder content locally for _offline operation.

Flags: Read / Write

Default value: FALSE