CamelIMAPXStoreSummary

CamelIMAPXStoreSummary

Synopsis

struct              CamelIMAPXStoreInfo;
struct              CamelIMAPXStoreNamespace;
                    CamelIMAPXNamespaceList;
struct              CamelIMAPXStoreSummary;
CamelIMAPXStoreSummary * camel_imapx_store_summary_new  (void);
CamelIMAPXStoreNamespace * camel_imapx_store_summary_namespace_new
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name,
                                                         gchar dir_sep);
void                camel_imapx_store_summary_namespace_set
                                                        (CamelIMAPXStoreSummary *s,
                                                         CamelIMAPXStoreNamespace *ns);
CamelIMAPXStoreNamespace * camel_imapx_store_summary_namespace_find_path
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *path);
CamelIMAPXStoreNamespace * camel_imapx_store_summary_namespace_find_full
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name);
gchar *             camel_imapx_store_summary_full_to_path
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name,
                                                         gchar dir_sep);
gchar *             camel_imapx_store_summary_path_to_full
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *path,
                                                         gchar dir_sep);
CamelIMAPXStoreInfo * camel_imapx_store_summary_full_name
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name);
CamelIMAPXStoreInfo * camel_imapx_store_summary_add_from_full
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name,
                                                         gchar dir_sep);
gchar *             camel_imapx_store_summary_full_from_path
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *path);
void                camel_imapx_store_summary_set_namespaces
                                                        (CamelIMAPXStoreSummary *summary,
                                                         const CamelIMAPXNamespaceList *nsl);
#define             camel_imapx_store_info_full_name    (s,
                                                         i)

Object Hierarchy

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

Description

Details

struct CamelIMAPXStoreInfo

struct CamelIMAPXStoreInfo {
	CamelStoreInfo info;
	gchar *full_name;
};

struct CamelIMAPXStoreNamespace

struct CamelIMAPXStoreNamespace {
	CamelIMAPXStoreNamespace *next;
	gchar *path;		/* display path */
	gchar *full_name; /* real name */
	gchar sep;		/* directory 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_new ()

CamelIMAPXStoreNamespace * camel_imapx_store_summary_namespace_new
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name,
                                                         gchar dir_sep);

camel_imapx_store_summary_namespace_set ()

void                camel_imapx_store_summary_namespace_set
                                                        (CamelIMAPXStoreSummary *s,
                                                         CamelIMAPXStoreNamespace *ns);

camel_imapx_store_summary_namespace_find_path ()

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

camel_imapx_store_summary_namespace_find_full ()

CamelIMAPXStoreNamespace * camel_imapx_store_summary_namespace_find_full
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name);

camel_imapx_store_summary_full_to_path ()

gchar *             camel_imapx_store_summary_full_to_path
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name,
                                                         gchar dir_sep);

camel_imapx_store_summary_path_to_full ()

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

camel_imapx_store_summary_full_name ()

CamelIMAPXStoreInfo * camel_imapx_store_summary_full_name
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name);

Retrieve a summary item by full 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 full_name name is not available. It must be freed using camel_store_summary_info_free().

camel_imapx_store_summary_add_from_full ()

CamelIMAPXStoreInfo * camel_imapx_store_summary_add_from_full
                                                        (CamelIMAPXStoreSummary *s,
                                                         const gchar *full_name,
                                                         gchar dir_sep);

camel_imapx_store_summary_full_from_path ()

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

camel_imapx_store_summary_set_namespaces ()

void                camel_imapx_store_summary_set_namespaces
                                                        (CamelIMAPXStoreSummary *summary,
                                                         const CamelIMAPXNamespaceList *nsl);

camel_imapx_store_info_full_name()

#define             camel_imapx_store_info_full_name(s, i)