![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
struct CamelStore; CamelFolderInfo; #define CAMEL_FOLDER_NOSELECT #define CAMEL_FOLDER_NOINFERIORS #define CAMEL_FOLDER_CHILDREN #define CAMEL_FOLDER_NOCHILDREN #define CAMEL_FOLDER_SUBSCRIBED #define CAMEL_FOLDER_VIRTUAL #define CAMEL_FOLDER_SYSTEM #define CAMEL_FOLDER_VTRASH #define CAMEL_FOLDER_SHARED_TO_ME #define CAMEL_FOLDER_SHARED_BY_ME #define CAMEL_FOLDER_TYPE_MASK #define CAMEL_FOLDER_TYPE_BIT #define CAMEL_FOLDER_TYPE_NORMAL #define CAMEL_FOLDER_TYPE_INBOX #define CAMEL_FOLDER_TYPE_OUTBOX #define CAMEL_FOLDER_TYPE_TRASH #define CAMEL_FOLDER_TYPE_JUNK #define CAMEL_FOLDER_TYPE_SENT #define CAMEL_STORE_READ #define CAMEL_STORE_WRITE CamelRenameInfo; #define CAMEL_STORE_SUBSCRIPTIONS #define CAMEL_STORE_VTRASH #define CAMEL_STORE_FILTER_INBOX #define CAMEL_STORE_VJUNK #define CAMEL_STORE_PROXY #define CAMEL_STORE_FOLDER_CREATE #define CAMEL_STORE_FOLDER_EXCL #define CAMEL_STORE_FOLDER_BODY_INDEX #define CAMEL_STORE_FOLDER_PRIVATE #define CAMEL_STORE_FOLDER_CREATE_EXCL #define CAMEL_STORE_FOLDER_INFO_FAST #define CAMEL_STORE_FOLDER_INFO_RECURSIVE #define CAMEL_STORE_FOLDER_INFO_SUBSCRIBED #define CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL CamelFolder* camel_store_get_folder (CamelStore *store, const char *folder_name, guint32 flags, CamelException *ex); CamelFolder* camel_store_get_inbox (CamelStore *store, CamelException *ex); CamelFolder* camel_store_get_trash (CamelStore *store, CamelException *ex); CamelFolder* camel_store_get_junk (CamelStore *store, CamelException *ex); CamelFolderInfo* camel_store_create_folder (CamelStore *store, const char *parent_name, const char *folder_name, CamelException *ex); void camel_store_delete_folder (CamelStore *store, const char *folder_name, CamelException *ex); void camel_store_rename_folder (CamelStore *store, const char *old_name, const char *new_name, CamelException *ex); void camel_store_sync (CamelStore *store, int expunge, CamelException *ex); CamelFolderInfo* camel_store_get_folder_info (CamelStore *store, const char *top, guint32 flags, CamelException *ex); 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 *folders, const char *namespace, char separator, gboolean short_names); CamelFolderInfo* camel_folder_info_clone (CamelFolderInfo *fi); gboolean camel_store_supports_subscriptions (CamelStore *store); gboolean camel_store_folder_subscribed (CamelStore *store, const char *folder_name); void camel_store_subscribe_folder (CamelStore *store, const char *folder_name, CamelException *ex); void camel_store_unsubscribe_folder (CamelStore *store, const char *folder_name, CamelException *ex); void camel_store_noop (CamelStore *store, CamelException *ex); int camel_store_folder_uri_equal (CamelStore *store, const char *uri0, const char *uri1); gboolean camel_store_can_refresh_folder (CamelStore *store, CamelFolderInfo *info, CamelException *ex); CamelISubscribe; gboolean camel_isubscribe_subscribed (CamelStore *store, const char *name); void camel_isubscribe_subscribe (CamelStore *store, const char *folder_name, CamelException *ex); void camel_isubscribe_unsubscribe (CamelStore *store, const char *folder_name, CamelException *ex);
struct CamelStore { CamelService parent_object; struct _CamelStorePrivate *priv; CamelObjectBag *folders; guint32 flags; guint32 mode; };
typedef struct { struct _CamelFolderInfo *next; struct _CamelFolderInfo *parent; struct _CamelFolderInfo *child; char *uri; char *name; char *full_name; guint32 flags; gint32 unread; gint32 total; } CamelFolderInfo;
#define CAMEL_STORE_FOLDER_PRIVATE (1<<3) /* a private folder, that shouldn't show up in unmatched/folder info's, etc */
#define CAMEL_STORE_FOLDER_CREATE_EXCL (CAMEL_STORE_FOLDER_CREATE | CAMEL_STORE_FOLDER_EXCL)
#define CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL (1 << 3) /* don't include vTrash/vJunk folders */
CamelFolder* camel_store_get_folder (CamelStore *store, const char *folder_name, guint32 flags, CamelException *ex);
|
|
|
|
|
|
|
|
Returns : |
CamelFolder* camel_store_get_inbox (CamelStore *store, CamelException *ex);
|
|
|
|
Returns : |
CamelFolder* camel_store_get_trash (CamelStore *store, CamelException *ex);
|
|
|
|
Returns : |
CamelFolder* camel_store_get_junk (CamelStore *store, CamelException *ex);
|
|
|
|
Returns : |
CamelFolderInfo* camel_store_create_folder (CamelStore *store, const char *parent_name, const char *folder_name, CamelException *ex);
|
|
|
|
|
|
|
|
Returns : |
void camel_store_delete_folder (CamelStore *store, const char *folder_name, CamelException *ex);
|
|
|
|
|
void camel_store_rename_folder (CamelStore *store, const char *old_name, const char *new_name, CamelException *ex);
|
|
|
|
|
|
|
void camel_store_sync (CamelStore *store, int expunge, CamelException *ex);
|
|
|
|
|
CamelFolderInfo* camel_store_get_folder_info (CamelStore *store, const char *top, guint32 flags, CamelException *ex);
|
|
|
|
|
|
|
|
Returns : |
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_build (GPtrArray *folders, const char *namespace, char separator, gboolean short_names);
|
|
|
|
|
|
|
|
Returns : |
CamelFolderInfo* camel_folder_info_clone (CamelFolderInfo *fi);
|
|
Returns : |
gboolean camel_store_supports_subscriptions (CamelStore *store);
|
|
Returns : |
gboolean camel_store_folder_subscribed (CamelStore *store, const char *folder_name);
|
|
|
|
Returns : |
void camel_store_subscribe_folder (CamelStore *store, const char *folder_name, CamelException *ex);
|
|
|
|
|
void camel_store_unsubscribe_folder (CamelStore *store, const char *folder_name, CamelException *ex);
|
|
|
|
|
int camel_store_folder_uri_equal (CamelStore *store, const char *uri0, const char *uri1);
|
|
|
|
|
|
Returns : |
gboolean camel_store_can_refresh_folder (CamelStore *store, CamelFolderInfo *info, CamelException *ex);
|
|
|
|
|
|
Returns : |
typedef struct { CamelInterface iface; gboolean (*subscribed)(CamelStore *store, const char *folder_name); void (*subscribe)(CamelStore *store, const char *folder_name, CamelException *ex); void (*unsubscribe)(CamelStore *store, const char *folder_name, CamelException *ex); } CamelISubscribe;
gboolean camel_isubscribe_subscribed (CamelStore *store, const char *name);
|
|
|
|
Returns : |
void camel_isubscribe_subscribe (CamelStore *store, const char *folder_name, CamelException *ex);
|
|
|
|
|
void camel_isubscribe_unsubscribe (CamelStore *store, const char *folder_name, CamelException *ex);
|
|
|
|
|