camel_imapx_search_new ()

CamelFolderSearch *
camel_imapx_search_new (CamelIMAPXStore *imapx_store);

Returns a new CamelIMAPXSearch instance.

Since 3.8

camel_imapx_search_ref_store ()

CamelIMAPXStore *
camel_imapx_search_ref_store (CamelIMAPXSearch *search);

Returns a CamelIMAPXStore to use for server-side searches, or NULL when the store is offline.

The returned CamelIMAPXStore is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

Since 3.8

camel_imapx_search_set_store ()

void
camel_imapx_search_set_store (CamelIMAPXSearch *search,
                              CamelIMAPXStore *imapx_store);

Sets a CamelIMAPXStore to use for server-side searches. Generally this is set for the duration of a single search when online, and then reset to NULL.

Since 3.8

camel_imapx_search_set_cancellable_and_error ()

void
camel_imapx_search_set_cancellable_and_error
                               (CamelIMAPXSearch *search,
                                GCancellable *cancellable,
                                GError **error);

Sets cancellable and error to use for server-side searches. This way the search can return accurate errors and be eventually cancelled by a user.

Note: The caller is responsible to keep alive both cancellable and error for the whole run of the search and reset them both to NULL after the search is finished.

Since 3.16

struct CamelIMAPXSearch

struct CamelIMAPXSearch;

Contains only private data that should be read and manipulated using the functions below.

Since 3.8

The “store” property

  “store”                    CamelIMAPXStore *

IMAPX Store for server-side searches.

Flags: Read / Write