CamelIMAPXSearch

CamelIMAPXSearch

Synopsis

struct              CamelIMAPXSearch;
CamelFolderSearch * camel_imapx_search_new              (void);
CamelIMAPXServer *  camel_imapx_search_ref_server       (CamelIMAPXSearch *search);
void                camel_imapx_search_set_server       (CamelIMAPXSearch *search,
                                                         CamelIMAPXServer *server);

Object Hierarchy

  GObject
   +----CamelObject
         +----CamelFolderSearch
               +----CamelIMAPXSearch

Properties

  "server"                   CamelIMAPXServer*     : Read / Write

Description

Details

struct CamelIMAPXSearch

struct CamelIMAPXSearch;

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

Since 3.8


camel_imapx_search_new ()

CamelFolderSearch * camel_imapx_search_new              (void);

Returns a new CamelIMAPXSearch instance.

The CamelIMAPXSearch must be given a "server" before it can issue server-side search requests. Otherwise it will fallback to the default CamelFolderSearch behavior.

Returns :

a new CamelIMAPXSearch

Since 3.8


camel_imapx_search_ref_server ()

CamelIMAPXServer *  camel_imapx_search_ref_server       (CamelIMAPXSearch *search);

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

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

search :

a CamelIMAPXSearch

Returns :

a CamelIMAPXServer, or NULL

Since 3.8


camel_imapx_search_set_server ()

void                camel_imapx_search_set_server       (CamelIMAPXSearch *search,
                                                         CamelIMAPXServer *server);

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

search :

a CamelIMAPXSearch

server :

a CamelIMAPXServer, or NULL

Since 3.8

Property Details

The "server" property

  "server"                   CamelIMAPXServer*     : Read / Write

Server proxy for server-side searches.