| Camel Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
#include <camel/camel.h> struct CamelIMAPXNamespace; enum CamelIMAPXNamespaceCategory; CamelIMAPXNamespace * camel_imapx_namespace_new (CamelIMAPXNamespaceCategory category,const gchar *prefix,gchar separator); gboolean camel_imapx_namespace_equal (CamelIMAPXNamespace *namespace_a,CamelIMAPXNamespace *namespace_b); CamelIMAPXNamespaceCategory camel_imapx_namespace_get_category (CamelIMAPXNamespace *namespace_); const gchar * camel_imapx_namespace_get_prefix (CamelIMAPXNamespace *namespace_); gchar camel_imapx_namespace_get_separator (CamelIMAPXNamespace *namespace_);
CamelIMAPXNamespace encapsulates an IMAP namespace, which consists of a namespace category (personal/other users/shared), a mailbox prefix string, and a mailbox separator character.
struct CamelIMAPXNamespace;
Contains only private data that should be read and manipulated using the functions below.
Since 3.12
typedef enum {
CAMEL_IMAPX_NAMESPACE_PERSONAL,
CAMEL_IMAPX_NAMESPACE_OTHER_USERS,
CAMEL_IMAPX_NAMESPACE_SHARED
} CamelIMAPXNamespaceCategory;
Refer to RFC 2342 for more detailed namespace class descriptions.
CamelIMAPXNamespace * camel_imapx_namespace_new (CamelIMAPXNamespaceCategory category,const gchar *prefix,gchar separator);
Creates a new CamelIMAPXNamespace from category, prefix and separator.
|
a CamelIMAPXNamespaceCategory |
|
a mailbox prefix string |
|
a mailbox path separator character |
Returns : |
a new CamelIMAPXNamespace |
Since 3.12
gboolean camel_imapx_namespace_equal (CamelIMAPXNamespace *namespace_a,CamelIMAPXNamespace *namespace_b);
Returns whether namespace_a and namespace_b are equivalent, meaning
they share the same category, prefix string, and path separator character.
|
a CamelIMAPXNamespace |
|
another CamelIMAPXNamespace |
Returns : |
TRUE if namespace_a and namespace_b are equal |
Since 3.12
CamelIMAPXNamespaceCategory camel_imapx_namespace_get_category
(CamelIMAPXNamespace *namespace_);
Returns the CamelIMAPXNamespaceCategory for namespace.
|
a CamelIMAPXNamespace |
Returns : |
a CamelIMAPXNamespaceCategory |
Since 3.12
const gchar * camel_imapx_namespace_get_prefix (CamelIMAPXNamespace *namespace_);
Returns the mailbox prefix string for namespace.
|
a CamelIMAPXNamespace |
Returns : |
a mailbox prefix string |
Since 3.12
gchar camel_imapx_namespace_get_separator (CamelIMAPXNamespace *namespace_);
Returns the mailbox path separator charactor for namespace.
|
a CamelIMAPXNamespace |
Returns : |
the mailbox path separator character |
Since 3.12