Virtual Method
CamelStoresearch_multimailbox_sync
unstable since: 3.62
Declaration [src]
gboolean
search_multimailbox_sync (
CamelStore* store,
GPtrArray* folders,
const gchar* search_key,
const GPtrArray* words,
GHashTable** out_results,
GCancellable* cancellable,
GError** error
)
Description [src]
Runs search across multiple mailboxes in a single operation. Returns G_IO_ERROR_NOT_SUPPORTED when the store does not support this operation.
Available since: 3.62
Parameters
folders-
Type: An array of
CamelFolder*Array of folders to search.
The data is owned by the caller of the method. search_key-
Type:
const gchar*Search key (e.g. BODY).
The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string. words-
Type: An array of
utf8Words/phrases to search.
The data is owned by the caller of the method. Each element is a NUL terminated UTF-8 string. out_results-
Type:
GHashTableReturn location for a %GHashTable mapping folder names (gchar) to arrays of matching UID strings (
GPtrArrayof gchar).The argument will be set by the function. The caller of the method takes ownership of the returned data container, but not the data inside it. cancellable-
Type:
GCancellableA
GCancellable, orNULL.The argument can be NULL.The data is owned by the caller of the method. error-
Type:
GError **The return location for a recoverable error.
The argument can be NULL.If the return location is not NULL, then you must initialize it to aNULLGError*.The argument will be left initialized to NULLby the virtual function if there are no errors.In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.