Method

CamelFoldersynchronize_sync

since: 3.0

Declaration [src]

gboolean
camel_folder_synchronize_sync (
  CamelFolder* folder,
  gboolean expunge,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Synchronizes any changes that have been made to folder to its backing store, optionally expunging deleted messages as well.

Available since: 3.0

Parameters

expunge

Type: gboolean

Whether to expunge after synchronizing.

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 on success, FALSE on error.