| Camel Reference Manual | ||||
|---|---|---|---|---|
struct CamelSession; gboolean (*CamelTimeoutCallback) (gpointer data); enum CamelSessionAlertType; CamelSessionThreadOps; CamelSessionThreadMsg; void camel_session_construct (CamelSession *session, const char *storage_path); CamelService* camel_session_get_service (CamelSession *session, const char *url_string, CamelProviderType type, CamelException *ex); CamelService* camel_session_get_service_connected (CamelSession *session, const char *url_string, CamelProviderType type, CamelException *ex); #define camel_session_get_store (session, url_string, ex) #define camel_session_get_transport (session, url_string, ex) char* camel_session_get_storage_path (CamelSession *session, CamelService *service, CamelException *ex); char* camel_session_get_password (CamelSession *session, CamelService *service, const char *domain, const char *prompt, const char *item, guint32 flags, CamelException *ex); void camel_session_forget_password (CamelSession *session, CamelService *service, const char *domain, const char *item, CamelException *ex); gboolean camel_session_alert_user (CamelSession *session, CamelSessionAlertType type, const char *prompt, gboolean cancel); char* camel_session_build_password_prompt (const char *type, const char *user, const char *host); gboolean camel_session_is_online (CamelSession *session); void camel_session_set_online (CamelSession *session, gboolean online); CamelFilterDriver* camel_session_get_filter_driver (CamelSession *session, const char *type, CamelException *ex); gboolean camel_session_check_junk (CamelSession *session); void camel_session_set_check_junk (CamelSession *session, gboolean check_junk); void* camel_session_thread_msg_new (CamelSession *session, CamelSessionThreadOps *ops, unsigned int size); void camel_session_thread_msg_free (CamelSession *session, CamelSessionThreadMsg *msg); int camel_session_thread_queue (CamelSession *session, CamelSessionThreadMsg *msg, int flags); void camel_session_thread_wait (CamelSession *session, int id); gboolean camel_session_get_network_state (CamelSession *session); void camel_session_set_network_state (CamelSession *session, gboolean network_state); const GHashTable* camel_session_get_junk_headers (CamelSession *session); void camel_session_set_junk_headers (CamelSession *session, const char **headers, const char **values, int len); gboolean camel_session_lookup_addressbook (CamelSession *session, const char *name);
struct CamelSession {
CamelObject parent_object;
struct _CamelSessionPrivate *priv;
char *storage_path;
CamelJunkPlugin *junk_plugin;
guint online:1;
guint check_junk:1;
guint network_state:1;
};
typedef enum {
CAMEL_SESSION_ALERT_INFO,
CAMEL_SESSION_ALERT_WARNING,
CAMEL_SESSION_ALERT_ERROR
} CamelSessionAlertType;
typedef struct {
void (*receive)(CamelSession *session, struct _CamelSessionThreadMsg *m);
void (*free)(CamelSession *session, struct _CamelSessionThreadMsg *m);
} CamelSessionThreadOps;
typedef struct {
EMsg msg;
int id;
CamelException ex;
CamelSessionThreadOps *ops;
struct _CamelOperation *op;
CamelSession *session;
void *data; /* free for implementation to define, not used by camel, do not use in client code */
/* user fields follow */
} CamelSessionThreadMsg;
void camel_session_construct (CamelSession *session, const char *storage_path);
|
|
|
CamelService* camel_session_get_service (CamelSession *session, const char *url_string, CamelProviderType type, CamelException *ex);
|
|
|
|
|
|
|
|
Returns : |
CamelService* camel_session_get_service_connected (CamelSession *session, const char *url_string, CamelProviderType type, CamelException *ex);
|
|
|
|
|
|
|
|
Returns : |
#define camel_session_get_store(session, url_string, ex)
|
|
|
|
|
#define camel_session_get_transport(session, url_string, ex)
|
|
|
|
|
char* camel_session_get_storage_path (CamelSession *session, CamelService *service, CamelException *ex);
|
|
|
|
|
|
Returns : |
char* camel_session_get_password (CamelSession *session, CamelService *service, const char *domain, const char *prompt, const char *item, guint32 flags, CamelException *ex);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Returns : |
void camel_session_forget_password (CamelSession *session, CamelService *service, const char *domain, const char *item, CamelException *ex);
|
|
|
|
|
|
|
|
|
gboolean camel_session_alert_user (CamelSession *session, CamelSessionAlertType type, const char *prompt, gboolean cancel);
|
|
|
|
|
|
|
|
Returns : |
char* camel_session_build_password_prompt (const char *type,
const char *user,
const char *host);
|
|
|
|
|
|
Returns : |
gboolean camel_session_is_online (CamelSession *session);
|
|
Returns : |
void camel_session_set_online (CamelSession *session, gboolean online);
|
|
|
CamelFilterDriver* camel_session_get_filter_driver (CamelSession *session, const char *type, CamelException *ex);
|
|
|
|
|
|
Returns : |
gboolean camel_session_check_junk (CamelSession *session);
|
|
Returns : |
void camel_session_set_check_junk (CamelSession *session, gboolean check_junk);
|
|
|
void* camel_session_thread_msg_new (CamelSession *session, CamelSessionThreadOps *ops, unsigned int size);
|
|
|
|
|
|
Returns : |
void camel_session_thread_msg_free (CamelSession *session, CamelSessionThreadMsg *msg);
|
|
|
int camel_session_thread_queue (CamelSession *session, CamelSessionThreadMsg *msg, int flags);
|
|
|
|
|
|
Returns : |
void camel_session_thread_wait (CamelSession *session, int id);
|
|
|
gboolean camel_session_get_network_state (CamelSession *session);
|
|
Returns : |
void camel_session_set_network_state (CamelSession *session, gboolean network_state);
|
|
|
const GHashTable* camel_session_get_junk_headers (CamelSession *session);
|
|
Returns : |
void camel_session_set_junk_headers (CamelSession *session, const char **headers, const char **values, int len);
|
|
|
|
|
|
|
gboolean camel_session_lookup_addressbook (CamelSession *session, const char *name);
|
|
|
|
Returns : |