## CamelIMAPXFolder

CamelIMAPXFolder

## Synopsis

    struct              CamelIMAPXFolder;
    CamelFolder *       camel_imapx_folder_new              (CamelStore *parent,
                                                             const gchar *path,
                                                             const gchar *raw,
                                                             GError **error);
    gchar **            camel_imapx_folder_dup_quota_root_names
                                                            (CamelIMAPXFolder *folder);
    void                camel_imapx_folder_set_quota_root_names
                                                            (CamelIMAPXFolder *folder,
                                                             const gchar **quota_root_names);
    void                camel_imapx_folder_add_move_to_real_junk
                                                            (CamelIMAPXFolder *folder,
                                                             const gchar *message_uid);
    void                camel_imapx_folder_add_move_to_real_trash
                                                            (CamelIMAPXFolder *folder,
                                                             const gchar *message_uid);
    void                camel_imapx_folder_invalidate_local_cache
                                                            (CamelIMAPXFolder *folder,
                                                             guint64 new_uidvalidity);
    void                camel_imapx_folder_process_status_response
                                                            (CamelIMAPXFolder *folder,
                                                             CamelIMAPXStatusResponse *response);

## Object Hierarchy

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

## Properties

      "apply-filters"            gboolean              : Read / Write
      "quota-root-names"         GStrv                 : Read / Write

## Description

## Details

### struct CamelIMAPXFolder

    struct CamelIMAPXFolder;

### camel_imapx_folder_new ()

    CamelFolder *       camel_imapx_folder_new              (CamelStore *parent,
                                                             const gchar *path,
                                                             const gchar *raw,
                                                             GError **error);

### camel_imapx_folder_dup_quota_root_names ()

    gchar **            camel_imapx_folder_dup_quota_root_names
                                                            (CamelIMAPXFolder *folder);

### camel_imapx_folder_set_quota_root_names ()

    void                camel_imapx_folder_set_quota_root_names
                                                            (CamelIMAPXFolder *folder,
                                                             const gchar **quota_root_names);

### camel_imapx_folder_add_move_to_real_junk ()

    void                camel_imapx_folder_add_move_to_real_junk
                                                            (CamelIMAPXFolder *folder,
                                                             const gchar *message_uid);

Adds `message_uid` to a pool of messages to be moved to a real junk folder the next time `folder` is explicitly synchronized by way of `camel_folder_synchronize()` or `camel_folder_synchronize_sync()`.

This only applies when using a real folder to track junk messages, as specified by the "use-real-junk-path" setting.

`folder` : | a CamelIMAPXFolder
`message_uid` : | a message UID

Since 3.8

### camel_imapx_folder_add_move_to_real_trash ()

    void                camel_imapx_folder_add_move_to_real_trash
                                                            (CamelIMAPXFolder *folder,
                                                             const gchar *message_uid);

Adds `message_uid` to a pool of messages to be moved to a real trash folder the next time `folder` is explicitly synchronized by way of `camel_folder_synchronize()` or `camel_folder_synchronize_sync()`.

This only applies when using a real folder to track deleted messages, as specified by the "use-real-trash-path" setting.

`folder` : | a CamelIMAPXFolder
`message_uid` : | a message UID

Since 3.8

### camel_imapx_folder_invalidate_local_cache ()

    void                camel_imapx_folder_invalidate_local_cache
                                                            (CamelIMAPXFolder *folder,
                                                             guint64 new_uidvalidity);

Call this function when the IMAP server reports a different UIDVALIDITY value than what is presently cached. This means all cached message UIDs are now invalid and must be discarded.

The local cache for `folder` is reset and the `new_uidvalidity` value is recorded in the newly-reset cache.

`folder` : | a CamelIMAPXFolder
`new_uidvalidity` : | the new UIDVALIDITY value

Since 3.10

### camel_imapx_folder_process_status_response ()

    void                camel_imapx_folder_process_status_response
                                                            (CamelIMAPXFolder *folder,
                                                             CamelIMAPXStatusResponse *response);

Updates `folder`'s local status information from `response`.

`folder` : | a CamelIMAPXFolder
`response` : | a CamelIMAPXStatusResponse

Since 3.10

## Property Details

### The `"apply-filters"` property

      "apply-filters"            gboolean              : Read / Write

Apply message _filters to this folder.

Default value: FALSE

### The `"quota-root-names"` property

      "quota-root-names"         GStrv                 : Read / Write

Quota root names for this folder.