CamelImapStore
3
CAMEL Library

# CamelImapStore

## Synopsis

                        CamelImapMsg;
    struct              CamelImapStore;
    CamelImapMsg*       camel_imap_msg_new                  (void (receiveCamelImapStore *store, struct _CamelImapMsg *m) (),
                                                             void (freeCamelImapStore *store, struct _CamelImapMsg *m) (),
                                                             size_t size);
    void                camel_imap_msg_queue                (CamelImapStore *store,
                                                             CamelImapMsg *msg);
    #define             CAMEL_IMAP_STORE_NAMESPACE
    #define             CAMEL_IMAP_STORE_OVERRIDE_NAMESPACE
    #define             CAMEL_IMAP_STORE_CHECK_ALL
    #define             CAMEL_IMAP_STORE_FILTER_INBOX
    #define             CAMEL_IMAP_STORE_FILTER_JUNK
    #define             CAMEL_IMAP_STORE_FILTER_JUNK_INBOX
    #define             CAMEL_IMAP_FOLDER_MARKED
    #define             CAMEL_IMAP_FOLDER_UNMARKED
    enum                CamelImapServerLevel;
    #define             IMAP_CAPABILITY_IMAP4
    #define             IMAP_CAPABILITY_IMAP4REV1
    #define             IMAP_CAPABILITY_STATUS
    #define             IMAP_CAPABILITY_NAMESPACE
    #define             IMAP_CAPABILITY_UIDPLUS
    #define             IMAP_CAPABILITY_LITERALPLUS
    #define             IMAP_CAPABILITY_STARTTLS
    #define             IMAP_CAPABILITY_useful_lsub
    #define             IMAP_CAPABILITY_utf8_search
    #define             IMAP_CAPABILITY_XGWEXTENSIONS
    #define             IMAP_CAPABILITY_XGWMOVE
    #define             IMAP_CAPABILITY_LOGINDISABLED
    #define             IMAP_PARAM_OVERRIDE_NAMESPACE
    #define             IMAP_PARAM_CHECK_ALL
    #define             IMAP_PARAM_FILTER_INBOX
    #define             IMAP_PARAM_FILTER_JUNK
    #define             IMAP_PARAM_FILTER_JUNK_INBOX
    #define             IMAP_PARAM_SUBSCRIPTIONS
    #define             IMAP_FETCH_ALL_HEADERS
    #define             IMAP_FETCH_MAILING_LIST_HEADERS
    #define             IMAP_FETCH_MINIMAL_HEADERS
    gboolean            camel_imap_store_connected          (CamelImapStore *store,
                                                             CamelException *ex);
    ssize_t             camel_imap_store_readline           (CamelImapStore *store,
                                                             char **dest,
                                                             CamelException *ex);

## Description

## Details

### CamelImapMsg

    typedef struct {
    	EMsg msg;

    	void (*receive)(CamelImapStore *store, struct _CamelImapMsg *m);
    	void (*free)(CamelImapStore *store, struct _CamelImapMsg *m);
    } CamelImapMsg;

### struct CamelImapStore

    struct CamelImapStore {
    	CamelDiscoStore parent_object;

    	CamelStream *istream;
    	CamelStream *ostream;

    	struct _CamelImapStoreSummary *summary;

    	/* Information about the command channel / connection status */
    	guint connected:1;
    	guint preauthed:1;

    	/* broken server - don't use BODY, dont use partial fetches for message retrival */
    	guint braindamaged:1;
    	guint renaming:1;
    	/* broken server - wont let us append with custom flags even if the folder allows them */
    	guint nocustomappend:1;

    	char tag_prefix;
    	guint32 command;
    	CamelFolder *current_folder;

    	/* Information about the server */
    	CamelImapServerLevel server_level;
    	guint32 capabilities, parameters;
    	/* NB: namespace should be handled by summary->namespace */
    	char *namespace, dir_sep, *base_url, *storage_path;
    	GHashTable *authtypes;

    	time_t refresh_stamp;

    	guint32 headers;
    	char *custom_headers;
    };

### camel_imap_msg_new ()

    CamelImapMsg*       camel_imap_msg_new                  (void (receiveCamelImapStore *store, struct _CamelImapMsg *m) (),
                                                             void (freeCamelImapStore *store, struct _CamelImapMsg *m) (),
                                                             size_t size);

`receive` :

`free` :

`size` :

Returns :

### camel_imap_msg_queue ()

    void                camel_imap_msg_queue                (CamelImapStore *store,
                                                             CamelImapMsg *msg);

`store` :

`msg` :

### CAMEL_IMAP_STORE_NAMESPACE

    #define CAMEL_IMAP_STORE_NAMESPACE           (CAMEL_IMAP_STORE_ARG_NAMESPACE | CAMEL_ARG_STR)

### CAMEL_IMAP_STORE_OVERRIDE_NAMESPACE

    #define CAMEL_IMAP_STORE_OVERRIDE_NAMESPACE  (CAMEL_IMAP_STORE_ARG_OVERRIDE_NAMESPACE | CAMEL_ARG_INT)

### CAMEL_IMAP_STORE_CHECK_ALL

    #define CAMEL_IMAP_STORE_CHECK_ALL           (CAMEL_IMAP_STORE_ARG_CHECK_ALL | CAMEL_ARG_INT)

### CAMEL_IMAP_STORE_FILTER_INBOX

    #define CAMEL_IMAP_STORE_FILTER_INBOX        (CAMEL_IMAP_STORE_ARG_FILTER_INBOX | CAMEL_ARG_INT)

### CAMEL_IMAP_STORE_FILTER_JUNK

    #define CAMEL_IMAP_STORE_FILTER_JUNK         (CAMEL_IMAP_STORE_ARG_FILTER_JUNK | CAMEL_ARG_BOO)

### CAMEL_IMAP_STORE_FILTER_JUNK_INBOX

    #define CAMEL_IMAP_STORE_FILTER_JUNK_INBOX   (CAMEL_IMAP_STORE_ARG_FILTER_JUNK_INBOX | CAMEL_ARG_BOO)

### CAMEL_IMAP_FOLDER_MARKED

    #define CAMEL_IMAP_FOLDER_MARKED	     (1<<16)

### CAMEL_IMAP_FOLDER_UNMARKED

    #define CAMEL_IMAP_FOLDER_UNMARKED	     (1<<17)

### enum CamelImapServerLevel

    typedef enum {
    	IMAP_LEVEL_UNKNOWN,
    	IMAP_LEVEL_IMAP4,
    	IMAP_LEVEL_IMAP4REV1
    } CamelImapServerLevel;

### IMAP_CAPABILITY_IMAP4

    #define IMAP_CAPABILITY_IMAP4			(1 << 0)

### IMAP_CAPABILITY_IMAP4REV1

    #define IMAP_CAPABILITY_IMAP4REV1		(1 << 1)

### IMAP_CAPABILITY_STATUS

    #define IMAP_CAPABILITY_STATUS			(1 << 2)

### IMAP_CAPABILITY_NAMESPACE

    #define IMAP_CAPABILITY_NAMESPACE		(1 << 3)

### IMAP_CAPABILITY_UIDPLUS

    #define IMAP_CAPABILITY_UIDPLUS			(1 << 4)

### IMAP_CAPABILITY_LITERALPLUS

    #define IMAP_CAPABILITY_LITERALPLUS		(1 << 5)

### IMAP_CAPABILITY_STARTTLS

    #define IMAP_CAPABILITY_STARTTLS                (1 << 6)

### IMAP_CAPABILITY_useful_lsub

    #define IMAP_CAPABILITY_useful_lsub		(1 << 7)

### IMAP_CAPABILITY_utf8_search

    #define IMAP_CAPABILITY_utf8_search		(1 << 8)

### IMAP_CAPABILITY_XGWEXTENSIONS

    #define IMAP_CAPABILITY_XGWEXTENSIONS		(1 << 9)

### IMAP_CAPABILITY_XGWMOVE

    #define IMAP_CAPABILITY_XGWMOVE			(1 << 10)

### IMAP_CAPABILITY_LOGINDISABLED

    #define IMAP_CAPABILITY_LOGINDISABLED		(1 << 11)

### IMAP_PARAM_OVERRIDE_NAMESPACE

    #define IMAP_PARAM_OVERRIDE_NAMESPACE		(1 << 0)

### IMAP_PARAM_CHECK_ALL

    #define IMAP_PARAM_CHECK_ALL			(1 << 1)

### IMAP_PARAM_FILTER_INBOX

    #define IMAP_PARAM_FILTER_INBOX			(1 << 2)

### IMAP_PARAM_FILTER_JUNK

    #define IMAP_PARAM_FILTER_JUNK			(1 << 3)

### IMAP_PARAM_FILTER_JUNK_INBOX

    #define IMAP_PARAM_FILTER_JUNK_INBOX		(1 << 4)

### IMAP_PARAM_SUBSCRIPTIONS

    #define IMAP_PARAM_SUBSCRIPTIONS		(1 << 5)

### IMAP_FETCH_ALL_HEADERS

    #define IMAP_FETCH_ALL_HEADERS 1

### IMAP_FETCH_MAILING_LIST_HEADERS

    #define IMAP_FETCH_MAILING_LIST_HEADERS 2 /* Fetches Minimal and Mailing List Headers. Default behavior */

### IMAP_FETCH_MINIMAL_HEADERS

    #define IMAP_FETCH_MINIMAL_HEADERS 3

### camel_imap_store_connected ()

    gboolean            camel_imap_store_connected          (CamelImapStore *store,
                                                             CamelException *ex);

`store` :

`ex` :

Returns :

### camel_imap_store_readline ()

    ssize_t             camel_imap_store_readline           (CamelImapStore *store,
                                                             char **dest,
                                                             CamelException *ex);

`store` :

`dest` :

`ex` :

Returns :