| Evolution Mail Engine Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals | ||||
struct EMailSession; #define E_MAIL_SESSION_LOCAL_UID #define E_MAIL_SESSION_VFOLDER_UID EMailSession * e_mail_session_new (ESourceRegistry *registry); ESourceRegistry * e_mail_session_get_registry (EMailSession *session); MailFolderCache * e_mail_session_get_folder_cache (EMailSession *session); CamelStore * e_mail_session_get_local_store (EMailSession *session); CamelStore * e_mail_session_get_vfolder_store (EMailSession *session); enum EMailLocalFolder; CamelFolder * e_mail_session_get_local_folder (EMailSession *session,EMailLocalFolder type); const gchar * e_mail_session_get_local_folder_uri (EMailSession *session,EMailLocalFolder type); GList * e_mail_session_get_available_junk_filters (EMailSession *session); EMailJunkFilter * e_mail_session_get_junk_filter_by_name (EMailSession *session,const gchar *filter_name); CamelFolder * e_mail_session_get_inbox_sync (EMailSession *session,const gchar *service_uid,GCancellable *cancellable,GError **error); void e_mail_session_get_inbox (EMailSession *session,const gchar *service_uid,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); CamelFolder * e_mail_session_get_inbox_finish (EMailSession *session,GAsyncResult *result,GError **error); CamelFolder * e_mail_session_get_trash_sync (EMailSession *session,const gchar *service_uid,GCancellable *cancellable,GError **error); void e_mail_session_get_trash (EMailSession *session,const gchar *service_uid,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); CamelFolder * e_mail_session_get_trash_finish (EMailSession *session,GAsyncResult *result,GError **error); CamelFolder * e_mail_session_uri_to_folder_sync (EMailSession *session,const gchar *folder_uri,CamelStoreGetFolderFlags flags,GCancellable *cancellable,GError **error); void e_mail_session_uri_to_folder (EMailSession *session,const gchar *folder_uri,CamelStoreGetFolderFlags flags,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); CamelFolder * e_mail_session_uri_to_folder_finish (EMailSession *session,GAsyncResult *result,GError **error); EMVFolderContext * e_mail_session_create_vfolder_context (EMailSession *session); gboolean e_binding_transform_service_to_source (GBinding *binding,const GValue *source_value,GValue *target_value,gpointer session); gboolean e_binding_transform_source_to_service (GBinding *binding,const GValue *source_value,GValue *target_value,gpointer session); void mail_session_flush_filter_log (EMailSession *session); const gchar * mail_session_get_data_dir (void); const gchar * mail_session_get_cache_dir (void); const gchar * mail_session_get_config_dir (void);
"folder-cache" MailFolderCache* : Read "local-store" CamelStore* : Read "registry" ESourceRegistry* : Read / Write / Construct Only "vfolder-store" CamelStore* : Read
"flush-outbox" :Run First"refresh-service" :Run Last"store-added" :Run First"store-removed" :Run First
ESourceRegistry * e_mail_session_get_registry (EMailSession *session);
MailFolderCache * e_mail_session_get_folder_cache (EMailSession *session);
CamelStore * e_mail_session_get_local_store (EMailSession *session);
CamelStore * e_mail_session_get_vfolder_store (EMailSession *session);
typedef enum {
E_MAIL_LOCAL_FOLDER_INBOX,
E_MAIL_LOCAL_FOLDER_DRAFTS,
E_MAIL_LOCAL_FOLDER_OUTBOX,
E_MAIL_LOCAL_FOLDER_SENT,
E_MAIL_LOCAL_FOLDER_TEMPLATES,
E_MAIL_LOCAL_FOLDER_LOCAL_INBOX,
E_MAIL_NUM_LOCAL_FOLDERS
} EMailLocalFolder;
CamelFolder * e_mail_session_get_local_folder (EMailSession *session,EMailLocalFolder type);
const gchar * e_mail_session_get_local_folder_uri (EMailSession *session,EMailLocalFolder type);
GList * e_mail_session_get_available_junk_filters
(EMailSession *session);
EMailJunkFilter * e_mail_session_get_junk_filter_by_name (EMailSession *session,const gchar *filter_name);
Looks up an EMailJunkFilter extension by its filter name, as specified
in its class structure. If no match is found, the function returns NULL.
|
an EMailSession |
|
a junk filter name |
Returns : |
an EMailJunkFilter, or NULL
|
CamelFolder * e_mail_session_get_inbox_sync (EMailSession *session,const gchar *service_uid,GCancellable *cancellable,GError **error);
void e_mail_session_get_inbox (EMailSession *session,const gchar *service_uid,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
CamelFolder * e_mail_session_get_inbox_finish (EMailSession *session,GAsyncResult *result,GError **error);
CamelFolder * e_mail_session_get_trash_sync (EMailSession *session,const gchar *service_uid,GCancellable *cancellable,GError **error);
void e_mail_session_get_trash (EMailSession *session,const gchar *service_uid,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
CamelFolder * e_mail_session_get_trash_finish (EMailSession *session,GAsyncResult *result,GError **error);
CamelFolder * e_mail_session_uri_to_folder_sync (EMailSession *session,const gchar *folder_uri,CamelStoreGetFolderFlags flags,GCancellable *cancellable,GError **error);
void e_mail_session_uri_to_folder (EMailSession *session,const gchar *folder_uri,CamelStoreGetFolderFlags flags,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
CamelFolder * e_mail_session_uri_to_folder_finish (EMailSession *session,GAsyncResult *result,GError **error);
EMVFolderContext * e_mail_session_create_vfolder_context
(EMailSession *session);
gboolean e_binding_transform_service_to_source (GBinding *binding,const GValue *source_value,GValue *target_value,gpointer session);
gboolean e_binding_transform_source_to_service (GBinding *binding,const GValue *source_value,GValue *target_value,gpointer session);
"registry" property "registry" ESourceRegistry* : Read / Write / Construct Only
Data source registry.
"flush-outbox" signalvoid user_function (EMailSession *session,
gpointer user_data) : Run First
Emitted if the send folder should be flushed.
|
the email session |
|
user data set when the signal handler was connected. |
"refresh-service" signalvoid user_function (EMailSession *session,
CamelService *service,
gpointer user_data) : Run Last
Emitted when service should be refreshed.
|
the EMailSession that emitted the signal |
|
a CamelService |
|
user data set when the signal handler was connected. |
"store-added" signalvoid user_function (EMailSession *session,
CamelStore *store,
gpointer user_data) : Run First
Emitted when a store is added
|
the EMailSession that emitted the signal |
|
a CamelStore |
|
user data set when the signal handler was connected. |
"store-removed" signalvoid user_function (EMailSession *session,
CamelStore *store,
gpointer user_data) : Run First
Emitted when a store is removed
|
the EMailSession that emitted the signal |
|
a CamelStore |
|
user data set when the signal handler was connected. |