## CamelDiscoFolder

CamelDiscoFolder

## Synopsis

                        CamelDiscoFolder;
    gboolean            camel_disco_folder_get_offline_sync (CamelDiscoFolder *disco_folder);
    void                camel_disco_folder_set_offline_sync (CamelDiscoFolder *disco_folder,
                                                             gboolean offline_sync);
    gboolean            camel_disco_folder_expunge_uids     (CamelFolder *folder,
                                                             GPtrArray *uids,
                                                             GError **error);
    gboolean            camel_disco_folder_cache_message    (CamelDiscoFolder *disco_folder,
                                                             const gchar *uid,
                                                             GError **error);
    gboolean            camel_disco_folder_prepare_for_offline
                                                            (CamelDiscoFolder *disco_folder,
                                                             const gchar *expression,
                                                             GError **error);

## Object Hierarchy

      GObject
       +----CamelObject
             +----CamelFolder
                   +----CamelDiscoFolder

## Properties

      "offline-sync"             gboolean              : Read / Write

## Description

## Details

### CamelDiscoFolder

    typedef struct _CamelDiscoFolder CamelDiscoFolder;

### Warning

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

### camel_disco_folder_get_offline_sync ()

    gboolean            camel_disco_folder_get_offline_sync (CamelDiscoFolder *disco_folder);

### Warning

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

`disco_folder` : | a CamelDiscoFolder
Returns : |

Since 2.32

### camel_disco_folder_set_offline_sync ()

    void                camel_disco_folder_set_offline_sync (CamelDiscoFolder *disco_folder,
                                                             gboolean offline_sync);

### Warning

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

`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,
                                                             GError **error);

### Warning

`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.

`folder` : | a (disconnectable) folder
`uids` : | array of UIDs to expunge
`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,
                                                             GError **error);

### Warning

`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.

`disco_folder` : | the folder
`uid` : | the UID of the message to cache
`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,
                                                             GError **error);

### Warning

`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()` ).

`disco_folder` : | the folder
`expression` : | an expression describing messages to synchronize, or `NULL` if all messages should be sync'ed.
`error` : | return location for a GError, or `NULL`
Returns : | `TRUE` on success, `FALSE` on failure

## Property Details

### The `"offline-sync"` property

      "offline-sync"             gboolean              : Read / Write

Copy folder content locally for offline operation.

Default value: FALSE