Method
CamelFilterDriverfilter_folder
Declaration [src]
gint
camel_filter_driver_filter_folder (
CamelFilterDriver* driver,
CamelFolder* folder,
CamelUIDCache* cache,
GPtrArray* uids,
gboolean remove,
GCancellable* cancellable,
GError** error
)
Parameters
folder-
Type:
CamelFolderCamelFolder to be filtered.
The data is owned by the caller of the method. cache-
Type:
CamelUIDCacheUID cache (needed for POP folders).
The data is owned by the caller of the method. uids-
Type: An array of
utf8Message uids to be filtered or
NULL(as a shortcut to filter all messages).The argument can be NULL.The data is owned by the caller of the method. Each element is a NUL terminated UTF-8 string. remove-
Type:
gbooleanTRUE to mark filtered messages as deleted.
cancellable-
Type:
GCancellableOptional
GCancellableobject, 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 method 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.