![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Known Derived Interfaces | Signals |
struct CamelStore; #define CAMEL_STORE_ERROR enum CamelStoreError; #define CAMEL_FOLDER_TYPE_MASK #define CAMEL_FOLDER_TYPE_BIT enum CamelFolderInfoFlags; CamelFolderInfo; enum CamelStoreFlags; enum CamelStorePermissionFlags; enum CamelStoreGetFolderFlags; #define CAMEL_STORE_FOLDER_CREATE_EXCL enum CamelStoreGetFolderInfoFlags;void camel_store_folder_created (CamelStore *store
,CamelFolderInfo *folder_info
);void camel_store_folder_deleted (CamelStore *store
,CamelFolderInfo *folder_info
);void camel_store_folder_opened (CamelStore *store
,CamelFolder *folder
);void camel_store_folder_renamed (CamelStore *store
,const
,gchar *old_nameCamelFolderInfo *folder_info
);void camel_store_free_folder_info (CamelStore *store
,CamelFolderInfo *fi
);void camel_store_free_folder_info_full (CamelStore *store
,CamelFolderInfo *fi
);void camel_store_free_folder_info_nop (CamelStore *store
,CamelFolderInfo *fi
); CamelFolderInfo * camel_folder_info_new (void
);void camel_folder_info_free (CamelFolderInfo *fi
); CamelFolderInfo * camel_folder_info_build (,
GPtrArray *foldersconst
,gchar *namespace,
gchar separator); CamelFolderInfo * camel_folder_info_clone (
gboolean short_namesCamelFolderInfo *fi
);gboolean camel_store_can_refresh_folder (CamelStore *store
,CamelFolderInfo *info
,); enum CamelStoreLock;
GError **errorvoid camel_store_lock (CamelStore *store
,CamelStoreLock lock
);void camel_store_unlock (CamelStore *store
,CamelStoreLock lock
); CamelFolder * camel_store_get_folder_sync (CamelStore *store
,const
,gchar *folder_nameCamelStoreGetFolderFlags flags
,,
GCancellable *cancellable);
GError **errorvoid camel_store_get_folder (CamelStore *store
,const
,gchar *folder_nameCamelStoreGetFolderFlags flags
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback); CamelFolder * camel_store_get_folder_finish (
gpointer user_dataCamelStore *store
,,
GAsyncResult *result); CamelFolderInfo * camel_store_get_folder_info_sync (
GError **errorCamelStore *store
,const
,gchar *topCamelStoreGetFolderInfoFlags flags
,,
GCancellable *cancellable);
GError **errorvoid camel_store_get_folder_info (CamelStore *store
,const
,gchar *topCamelStoreGetFolderInfoFlags flags
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback); CamelFolderInfo * camel_store_get_folder_info_finish (
gpointer user_dataCamelStore *store
,,
GAsyncResult *result); CamelFolder * camel_store_get_inbox_folder_sync (
GError **errorCamelStore *store
,,
GCancellable *cancellable);
GError **errorvoid camel_store_get_inbox_folder (CamelStore *store
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback); CamelFolder * camel_store_get_inbox_folder_finish (
gpointer user_dataCamelStore *store
,,
GAsyncResult *result); CamelFolder * camel_store_get_junk_folder_sync (
GError **errorCamelStore *store
,,
GCancellable *cancellable);
GError **errorvoid camel_store_get_junk_folder (CamelStore *store
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback); CamelFolder * camel_store_get_junk_folder_finish (
gpointer user_dataCamelStore *store
,,
GAsyncResult *result); CamelFolder * camel_store_get_trash_folder_sync (
GError **errorCamelStore *store
,,
GCancellable *cancellable);
GError **errorvoid camel_store_get_trash_folder (CamelStore *store
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback); CamelFolder * camel_store_get_trash_folder_finish (
gpointer user_dataCamelStore *store
,,
GAsyncResult *result); CamelFolderInfo * camel_store_create_folder_sync (
GError **errorCamelStore *store
,const
,gchar *parent_nameconst
,gchar *folder_name,
GCancellable *cancellable);
GError **errorvoid camel_store_create_folder (CamelStore *store
,const
,gchar *parent_nameconst
,gchar *folder_name,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback); CamelFolderInfo * camel_store_create_folder_finish (
gpointer user_dataCamelStore *store
,,
GAsyncResult *result);
GError **errorgboolean camel_store_delete_folder_sync (CamelStore *store
,const
,gchar *folder_name,
GCancellable *cancellable);
GError **errorvoid camel_store_delete_folder (CamelStore *store
,const
,gchar *folder_name,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_datagboolean camel_store_delete_folder_finish (CamelStore *store
,,
GAsyncResult *result);
GError **errorgboolean camel_store_rename_folder_sync (CamelStore *store
,const
,gchar *old_nameconst
,gchar *new_name,
GCancellable *cancellable);
GError **errorvoid camel_store_rename_folder (CamelStore *store
,const
,gchar *old_nameconst
,gchar *new_name,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_datagboolean camel_store_rename_folder_finish (CamelStore *store
,,
GAsyncResult *result);
GError **errorgboolean camel_store_synchronize_sync (CamelStore *store
,,
gboolean expunge,
GCancellable *cancellable);
GError **errorvoid camel_store_synchronize (CamelStore *store
,,
gboolean expunge,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_datagboolean camel_store_synchronize_finish (CamelStore *store
,,
GAsyncResult *result);
GError **errorgboolean camel_store_noop_sync (CamelStore *store
,,
GCancellable *cancellable);
GError **errorvoid camel_store_noop (CamelStore *store
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_datagboolean camel_store_noop_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
GObject +----CamelObject +----CamelService +----CamelStore +----CamelDiscoStore +----CamelOfflineStore +----CamelVeeStore
"folder-created" :"folder-deleted" : Run First
"folder-opened" : Run First
"folder-renamed" : Run First
Run First
typedef enum { CAMEL_STORE_ERROR_INVALID, CAMEL_STORE_ERROR_NO_FOLDER } CamelStoreError;
Since 2.32
typedef enum { /*< flags >*/ CAMEL_FOLDER_NOSELECT = 1 << 0, CAMEL_FOLDER_NOINFERIORS = 1 << 1, CAMEL_FOLDER_CHILDREN = 1 << 2, CAMEL_FOLDER_NOCHILDREN = 1 << 3, CAMEL_FOLDER_SUBSCRIBED = 1 << 4, CAMEL_FOLDER_VIRTUAL = 1 << 5, CAMEL_FOLDER_SYSTEM = 1 << 6, CAMEL_FOLDER_VTRASH = 1 << 7, CAMEL_FOLDER_SHARED_TO_ME = 1 << 8, CAMEL_FOLDER_SHARED_BY_ME = 1 << 9, CAMEL_FOLDER_TYPE_NORMAL = 0 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_TYPE_INBOX = 1 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_TYPE_OUTBOX = 2 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_TYPE_TRASH = 3 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_TYPE_JUNK = 4 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_TYPE_SENT = 5 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_TYPE_CONTACTS = 6 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_TYPE_EVENTS = 7 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_TYPE_MEMOS = 8 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_TYPE_TASKS = 9 << CAMEL_FOLDER_TYPE_BIT, CAMEL_FOLDER_READONLY = 1 << 16, CAMEL_FOLDER_CHECK_FOR_NEW = 1 << 17, CAMEL_FOLDER_FLAGGED = 1 << 18, CAMEL_FOLDER_FLAGS_LAST = 1 << 24 /*< skip >*/ } CamelFolderInfoFlags;
These flags are abstractions. It's up to the CamelProvider to give them suitable interpretations. Use CAMEL_FOLDER_TYPE_MASK to isolate the folder's type.
The folder cannot contain messages. | |
The folder cannot have child folders. | |
The folder has children (not yet fully implemented). | |
The folder does not have children (not yet fully implemented). | |
The folder is subscribed. | |
The folder is virtual. Messages cannot be copied or moved to virtual folders since they are only queries of other folders. | |
The folder is a built-in "system" folder. System folders cannot be renamed or deleted. | |
The folder is a virtual trash folder. It cannot be copied to, and can only be moved to if in an existing folder. | |
A folder being shared by someone else. | |
A folder being shared by the user. | |
The folder is a normal folder. | |
The folder is an inbox folder. | |
The folder is an outbox folder. | |
The folder shows deleted messages. | |
The folder shows junk messages. | |
The folder shows sent messages. | |
The folder contains contacts, instead of mail messages. | |
The folder contains calendar events, instead of mail messages. | |
The folder contains memos, instead of mail messages. | |
The folder contains tasks, instead of mail messages. | |
typedef struct { struct _CamelFolderInfo *next; struct _CamelFolderInfo *parent; struct _CamelFolderInfo *child; gchar *full_name; gchar *display_name; CamelFolderInfoFlags flags; gint32 unread; gint32 total; } CamelFolderInfo;
typedef enum { /*< flags >*/ CAMEL_STORE_VTRASH = 1 << 0, CAMEL_STORE_VJUNK = 1 << 1, CAMEL_STORE_PROXY = 1 << 2, CAMEL_STORE_IS_MIGRATING = 1 << 3, CAMEL_STORE_REAL_JUNK_FOLDER = 1 << 4, CAMEL_STORE_CAN_EDIT_FOLDERS = 1 << 5, CAMEL_STORE_USE_CACHE_DIR = 1 << 6 } CamelStoreFlags;
typedef enum { /*< flags >*/ CAMEL_STORE_READ = 1 << 0, CAMEL_STORE_WRITE = 1 << 1 } CamelStorePermissionFlags;
typedef enum { CAMEL_STORE_FOLDER_CREATE = 1 << 0, CAMEL_STORE_FOLDER_EXCL = 1 << 1, CAMEL_STORE_FOLDER_BODY_INDEX = 1 << 2, CAMEL_STORE_FOLDER_PRIVATE = 1 << 3 /* a private folder that should not show up in unmatched, folder info's, etc. */ } CamelStoreGetFolderFlags;
typedef enum { /*< flags >*/ CAMEL_STORE_FOLDER_INFO_FAST = 1 << 0, CAMEL_STORE_FOLDER_INFO_RECURSIVE = 1 << 1, CAMEL_STORE_FOLDER_INFO_SUBSCRIBED = 1 << 2, CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL = 1 << 3, CAMEL_STORE_FOLDER_INFO_SUBSCRIPTION_LIST = 1 << 4 } CamelStoreGetFolderInfoFlags;
Do not include virtual trash or junk folders. | |
Fetch only the subscription list. Clients should use this flag for requesting the list of folders available for subscription. Used in Exchange / IMAP connectors for public folder fetching. |
void camel_store_folder_created (CamelStore *store
,CamelFolderInfo *folder_info
);
Emits the "folder-created" signal from an idle source on
the main loop. The idle source's priority is
This function is only intended for Camel providers.
|
a CamelStore |
|
information about the created folder |
Since 2.32
void camel_store_folder_deleted (CamelStore *store
,CamelFolderInfo *folder_info
);
Emits the "folder-deleted" signal from an idle source on
the main loop. The idle source's priority is
This function is only intended for Camel providers.
|
a CamelStore |
|
information about the deleted folder |
Since 2.32
void camel_store_folder_opened (CamelStore *store
,CamelFolder *folder
);
Emits the "folder-opened" signal from an idle source on
the main loop. The idle source's priority is
This function is only intended for Camel providers.
|
a CamelStore |
|
the CamelFolder that was opened |
Since 3.0
void camel_store_folder_renamed (CamelStore *store
,const
,gchar *old_nameCamelFolderInfo *folder_info
);
Emits the "folder-renamed" signal from an idle source on
the main loop. The idle source's priority is
This function is only intended for Camel providers.
|
a CamelStore |
|
the old name of the folder |
|
information about the renamed folder |
Since 2.32
void camel_store_free_folder_info (CamelStore *store
,CamelFolderInfo *fi
);
Frees the data returned by camel_store_get_folder_info()
. If fi
is NULL
|
a CamelStore |
|
a CamelFolderInfo as gotten via camel_store_get_folder_info()
|
void camel_store_free_folder_info_full (CamelStore *store
,CamelFolderInfo *fi
);
An implementation for
|
a CamelStore |
|
a CamelFolderInfo as gotten via camel_store_get_folder_info()
|
void camel_store_free_folder_info_nop (CamelStore *store
,CamelFolderInfo *fi
);
An implementation for
|
a CamelStore |
|
a CamelFolderInfo as gotten via camel_store_get_folder_info()
|
CamelFolderInfo * camel_folder_info_new (void
);
Allocates a new CamelFolderInfo instance. Free it with
camel_folder_info_free()
.
Returns : |
a new CamelFolderInfo instance |
Since 2.22
void camel_folder_info_free (CamelFolderInfo *fi
);
Frees fi
.
|
a CamelFolderInfo |
CamelFolderInfo * camel_folder_info_build (,
GPtrArray *foldersconst
,gchar *namespace,
gchar separator);
gboolean short_names
camel_folder_info_build
is deprecated and should not be used in newly-written code.
This takes an array of folders and attaches them together according
to the hierarchy described by their full_names and separator
. If
namespace
is non-NULL
camel_folder_info_build()
will create additional CamelFolderInfo with
NULL
short_names
is used in constructing the names of these intermediate folders.
NOTE: This is deprected, do not use this. FIXME: remove this/move it to imap, which is the only user of it now.
|
an array of CamelFolderInfo |
|
an ignorable prefix on the folder names |
|
the hieararchy separator character |
|
TRUE separator in the full name. FALSE |
Returns : |
the top level of the tree of linked folder info. |
CamelFolderInfo * camel_folder_info_clone (CamelFolderInfo *fi
);
Clones fi
recursively.
|
a CamelFolderInfo |
Returns : |
the cloned CamelFolderInfo tree. |
gboolean camel_store_can_refresh_folder (CamelStore *store
,CamelFolderInfo *info
,);
GError **error
Returns if this folder (param info) should be checked for new mail or not. It should not look into sub infos (info->child) or next infos, it should return value only for the actual folder info. Default behavior is that all Inbox folders are intended to be refreshed.
|
a CamelStore |
|
a CamelFolderInfo |
|
return location for a NULL |
Returns : |
whether folder should be checked for new mails |
Since 2.22
void camel_store_lock (CamelStore *store
,CamelStoreLock lock
);
Locks store
's lock
. Unlock it with camel_store_unlock()
.
|
a CamelStore |
|
lock type to lock |
Since 2.32
void camel_store_unlock (CamelStore *store
,CamelStoreLock lock
);
Unlocks store
's lock
, previously locked with camel_store_lock()
.
|
a CamelStore |
|
lock type to unlock |
Since 2.32
CamelFolder * camel_store_get_folder_sync (CamelStore *store
,const
,gchar *folder_nameCamelStoreGetFolderFlags flags
,,
GCancellable *cancellable);
GError **error
Gets a specific folder object from store
by name.
|
a CamelStore |
|
name of the folder to get |
|
folder flags (create, save body index, etc) |
|
optional NULL |
|
return location for a NULL |
Returns : |
the requested CamelFolder object, or NULL |
Since 3.0
void camel_store_get_folder (CamelStore *store
,const
,gchar *folder_nameCamelStoreGetFolderFlags flags
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Asynchronously gets a specific folder object from store
by name.
When the operation is finished, callback
will be called. You can then
call camel_store_get_folder_finish()
to get the result of the operation.
|
a CamelStore |
|
name of the folder to get |
|
folder flags (create, save body index, etc) |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
CamelFolder * camel_store_get_folder_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_get_folder()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
the requested CamelFolder object, or NULL |
Since 3.0
CamelFolderInfo * camel_store_get_folder_info_sync (CamelStore *store
,const
,gchar *topCamelStoreGetFolderInfoFlags flags
,,
GCancellable *cancellable);
GError **error
This fetches information about the folder structure of store
,
starting with top
, and returns a tree of CamelFolderInfo
structures. If flags
includes CAMEL_STORE_FOLDER_INFO_SUBSCRIBED
,
only subscribed folders will be listed. If the store doesn't support
subscriptions, then it will list all folders. If flags
includes
CAMEL_STORE_FOLDER_INFO_RECURSIVE
, the returned tree will include
all levels of hierarchy below top
. If not, it will only include
the immediate subfolders of top
. If flags
includes
CAMEL_STORE_FOLDER_INFO_FAST
, the unread_message_count fields of
some or all of the structures may be set to -1
flags
includes
CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL
, don't include special virtual
folders (such as vTrash or vJunk).
The returned CamelFolderInfo tree should be freed with
camel_store_free_folder_info()
.
The CAMEL_STORE_FOLDER_INFO_FAST flag should be considered
deprecated; most backends will behave the same whether it is
supplied or not. The only guaranteed way to get updated folder
counts is to both open the folder and invoke refresh_info()
|
a CamelStore |
|
the name of the folder to start from |
|
various CAMEL_STORE_FOLDER_INFO_* flags to control behavior |
|
optional NULL |
|
return location for a NULL |
Returns : |
a CamelFolderInfo tree, or NULL |
Since 3.0
void camel_store_get_folder_info (CamelStore *store
,const
,gchar *topCamelStoreGetFolderInfoFlags flags
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Asynchronously fetches information about the folder structure of store
,
starting with top
. For details of the behavior, see
camel_store_get_folder_info_sync()
.
When the operation is finished, callback
will be called. You can
then call camel_store_get_folder_info_finish()
to get the result of
the operation.
|
a CamelStore |
|
the name of the folder to start from |
|
various CAMEL_STORE_FOLDER_INFO_* flags to control behavior |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
CamelFolderInfo * camel_store_get_folder_info_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_get_folder_info()
.
The returned CamelFolderInfo tree should be freed with
camel_store_free_folder_info()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
a CamelFolderInfo tree, or NULL |
Since 3.0
CamelFolder * camel_store_get_inbox_folder_sync (CamelStore *store
,,
GCancellable *cancellable);
GError **error
Gets the folder in store
into which new mail is delivered.
|
a CamelStore |
|
optional NULL |
|
return location for a NULL |
Returns : |
the inbox folder for store , or NULL |
Since 3.0
void camel_store_get_inbox_folder (CamelStore *store
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Asynchronously gets the folder in store
into which new mail is delivered.
When the operation is finished, callback
will be called. You can
then call camel_store_get_inbox_folder_finish()
to get the result of
the operation.
|
a CamelStore |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
CamelFolder * camel_store_get_inbox_folder_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_get_inbox_folder()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
the inbox folder for store , or NULL |
Since 3.0
CamelFolder * camel_store_get_junk_folder_sync (CamelStore *store
,,
GCancellable *cancellable);
GError **error
Gets the folder in store
into which junk is delivered.
|
a CamelStore |
|
optional NULL |
|
return location for a NULL |
Returns : |
the junk folder for store , or NULL |
Since 3.0
void camel_store_get_junk_folder (CamelStore *store
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Asynchronously gets the folder in store
into which junk is delivered.
When the operation is finished, callback
will be called. You can
then call camel_store_get_junk_folder_finish()
to get the result of
the operation.
|
a CamelStore |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
CamelFolder * camel_store_get_junk_folder_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_get_junk_folder()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
the junk folder for store , or NULL |
Since 3.0
CamelFolder * camel_store_get_trash_folder_sync (CamelStore *store
,,
GCancellable *cancellable);
GError **error
Gets the folder in store
into which trash is delivered.
|
a CamelStore |
|
optional NULL |
|
return location for a NULL |
Returns : |
the trash folder for store , or NULL |
Since 3.0
void camel_store_get_trash_folder (CamelStore *store
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Asynchronously gets the folder in store
into which trash is delivered.
When the operation is finished, callback
will be called. You can
then call camel_store_get_trash_folder_finish()
to get the result of
the operation.
|
a CamelStore |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
CamelFolder * camel_store_get_trash_folder_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_get_trash_folder()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
the trash folder for store , or NULL |
Since 3.0
CamelFolderInfo * camel_store_create_folder_sync (CamelStore *store
,const
,gchar *parent_nameconst
,gchar *folder_name,
GCancellable *cancellable);
GError **error
Creates a new folder as a child of an existing folder.
parent_name
can be NULL
camel_store_free_folder_info()
.
|
a CamelStore |
|
name of the new folder's parent, or NULL |
|
name of the folder to create |
|
optional NULL |
|
return location for a NULL |
Returns : |
info about the created folder, or NULL |
Since 3.0
void camel_store_create_folder (CamelStore *store
,const
,gchar *parent_nameconst
,gchar *folder_name,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Asynchronously creates a new folder as a child of an existing folder.
parent_name
can be NULL
When the operation is finished, callback
will be called. You can then
call camel_store_create_folder_finish()
to get the result of the operation.
|
a CamelStore |
|
name of the new folder's parent, or NULL |
|
name of the folder to create |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
CamelFolderInfo * camel_store_create_folder_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_create_folder()
.
The returned CamelFolderInfo struct should be freed with
camel_store_free_folder_info()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
info about the created folder, or NULL |
Since 3.0
gboolean camel_store_delete_folder_sync (CamelStore *store
,const
,gchar *folder_name,
GCancellable *cancellable);
GError **error
Deletes the folder described by folder_name
. The folder must be empty.
|
a CamelStore |
|
name of the folder to delete |
|
optional NULL |
|
return location for a NULL |
Returns : |
TRUE FALSE |
Since 3.0
void camel_store_delete_folder (CamelStore *store
,const
,gchar *folder_name,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Asynchronously deletes the folder described by folder_name
. The
folder must be empty.
When the operation is finished, callback
will be called. You can then
call camel_store_delete_folder_finish()
to get the result of the operation.
|
a CamelStore |
|
name of the folder to delete |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
gboolean camel_store_delete_folder_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_delete_folder()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
TRUE FALSE |
Since 3.0
gboolean camel_store_rename_folder_sync (CamelStore *store
,const
,gchar *old_nameconst
,gchar *new_name,
GCancellable *cancellable);
GError **error
Renames the folder described by old_name
to new_name
.
|
a CamelStore |
|
the current name of the folder |
|
the new name of the folder |
|
optional NULL |
|
return location for a NULL |
Returns : |
TRUE FALSE |
Since 3.0
void camel_store_rename_folder (CamelStore *store
,const
,gchar *old_nameconst
,gchar *new_name,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Asynchronously renames the folder described by old_name
to new_name
.
When the operation is finished, callback
will be called. You can then
call camel_store_rename_folder_finish()
to get the result of the operation.
|
a CamelStore |
|
the current name of the folder |
|
the new name of the folder |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
gboolean camel_store_rename_folder_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_rename_folder()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
TRUE FALSE |
Since 3.0
gboolean camel_store_synchronize_sync (CamelStore *store
,,
gboolean expunge,
GCancellable *cancellable);
GError **error
Synchronizes any changes that have been made to store
and its folders
with the real store.
|
a CamelStore |
|
whether to expunge after synchronizing |
|
optional NULL |
|
return location for a NULL |
Returns : |
TRUE FALSE |
Since 3.0
void camel_store_synchronize (CamelStore *store
,,
gboolean expunge,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Synchronizes any changes that have been made to store
and its folders
with the real store asynchronously.
When the operation is finished, callback
will be called. You can then
call camel_store_synchronize_finish()
to get the result of the operation.
|
a CamelStore |
|
whether to expunge after synchronizing |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
gboolean camel_store_synchronize_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_synchronize()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
TRUE FALSE |
Since 3.0
gboolean camel_store_noop_sync (CamelStore *store
,,
GCancellable *cancellable);
GError **error
Pings store
so its connection doesn't time out.
|
a CamelStore |
|
optional NULL |
|
return location for a NULL |
Returns : |
TRUE FALSE |
Since 3.0
void camel_store_noop (CamelStore *store
,,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback);
gpointer user_data
Pings store
asynchronously so its connection doesn't time out.
When the operation is finished, callback
will be called. You can then
call camel_store_noop_finish()
to get the result of the operation.
|
a CamelStore |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
gboolean camel_store_noop_finish (CamelStore *store
,,
GAsyncResult *result);
GError **error
Finishes the operation started with camel_store_noop()
.
|
a CamelStore |
|
a |
|
return location for a NULL |
Returns : |
TRUE FALSE |
Since 3.0
"folder-created"
signalvoid user_function (CamelStore *camelstore,gpointer arg1,gpointer user_data) :Run First
"folder-deleted"
signalvoid user_function (CamelStore *camelstore,gpointer arg1,gpointer user_data) :Run First
"folder-opened"
signalvoid user_function (CamelStore *camelstore, CamelFolder *arg1,gpointer user_data) :Run First
"folder-renamed"
signalvoid user_function (CamelStore *camelstore,gchar *arg1,gpointer arg2,gpointer user_data) :Run First