Method

CamelJunkFiltersynchronize

since: 3.2

Declaration [src]

gboolean
camel_junk_filter_synchronize (
  CamelJunkFilter* junk_filter,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Instructs junk_filter to flush any in-memory caches to disk, if applicable. When filtering many messages, delaying this step until all messages have been classified can improve performance.

If an error occurs, the function sets error and returns FALSE.

Available since: 3.2

Parameters

cancellable

Type: GCancellable

Optional GCancellable object, or NULL.

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 a NULL GError*.
The argument will be left initialized to NULL by 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.

Return value

Type: gboolean

TRUE if junk_filter was successfully synchronized.