CamelIMAPXStoreSummary

CamelIMAPXStoreSummary

Synopsis

struct              CamelIMAPXStoreInfo;
struct              CamelIMAPXStoreNamespace;
                    CamelIMAPXNamespaceList;
struct              CamelIMAPXStoreSummary;
CamelIMAPXStoreSummary * camel_imapx_store_summary_new  (void);
CamelIMAPXStoreNamespace * camel_imapx_store_summary_namespace_find_by_path
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *path);
CamelIMAPXStoreNamespace * camel_imapx_store_summary_namespace_find_by_mailbox
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *mailbox);
gchar *             camel_imapx_store_summary_path_to_mailbox
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *path,
                                                         gchar dir_sep);
CamelIMAPXStoreInfo * camel_imapx_store_summary_mailbox (CamelIMAPXStoreSummary *s,
                                                         const gchar *mailbox_name);
CamelIMAPXStoreInfo * camel_imapx_store_summary_add_from_mailbox
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *mailbox,
                                                         gchar dir_sep);
gchar *             camel_imapx_store_summary_mailbox_from_path
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *path);

Object Hierarchy

  GObject
   +----CamelObject
         +----CamelStoreSummary
               +----CamelIMAPXStoreSummary

Description

Details

struct CamelIMAPXStoreInfo

struct CamelIMAPXStoreInfo {
	CamelStoreInfo info;
	gchar *mailbox_name;
	gchar separator;
};

struct CamelIMAPXStoreNamespace

struct CamelIMAPXStoreNamespace {
	CamelIMAPXStoreNamespace *next;
	gchar *prefix;		/* mailbox prefix, no trailing separator */
	gchar sep;		/* mailbox separator */
};

CamelIMAPXNamespaceList

typedef struct {
	CamelIMAPXStoreNamespace *personal;
	CamelIMAPXStoreNamespace *other;
	CamelIMAPXStoreNamespace *shared;
} CamelIMAPXNamespaceList;

struct CamelIMAPXStoreSummary

struct CamelIMAPXStoreSummary;

camel_imapx_store_summary_new ()

CamelIMAPXStoreSummary * camel_imapx_store_summary_new  (void);

Create a new CamelIMAPXStoreSummary object.

Returns :

A new CamelIMAPXStoreSummary widget.

camel_imapx_store_summary_namespace_find_by_path ()

CamelIMAPXStoreNamespace * camel_imapx_store_summary_namespace_find_by_path
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *path);

camel_imapx_store_summary_namespace_find_by_mailbox ()

CamelIMAPXStoreNamespace * camel_imapx_store_summary_namespace_find_by_mailbox
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *mailbox);

camel_imapx_store_summary_path_to_mailbox ()

gchar *             camel_imapx_store_summary_path_to_mailbox
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *path,
                                                         gchar dir_sep);

camel_imapx_store_summary_mailbox ()

CamelIMAPXStoreInfo * camel_imapx_store_summary_mailbox (CamelIMAPXStoreSummary *s,
                                                         const gchar *mailbox_name);

Retrieve a summary item by mailbox name.

A referenced to the summary item is returned, which may be ref'd or free'd as appropriate.

Returns :

The summary item, or NULL if the mailbox_name is not available. It must be freed using camel_store_summary_info_unref().

camel_imapx_store_summary_add_from_mailbox ()

CamelIMAPXStoreInfo * camel_imapx_store_summary_add_from_mailbox
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *mailbox,
                                                         gchar dir_sep);

camel_imapx_store_summary_mailbox_from_path ()

gchar *             camel_imapx_store_summary_mailbox_from_path
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *path);