EMailSession

EMailSession

Functions

EMailSession * e_mail_session_new ()
ESourceRegistry * e_mail_session_get_registry ()
MailFolderCache * e_mail_session_get_folder_cache ()
CamelStore * e_mail_session_get_local_store ()
CamelStore * e_mail_session_get_vfolder_store ()
CamelFolder * e_mail_session_get_local_folder ()
const gchar * e_mail_session_get_local_folder_uri ()
GList * e_mail_session_get_available_junk_filters ()
EMailJunkFilter * e_mail_session_get_junk_filter_by_name ()
CamelFolder * e_mail_session_get_inbox_sync ()
void e_mail_session_get_inbox ()
CamelFolder * e_mail_session_get_inbox_finish ()
CamelFolder * e_mail_session_get_trash_sync ()
void e_mail_session_get_trash ()
CamelFolder * e_mail_session_get_trash_finish ()
CamelFolder * e_mail_session_uri_to_folder_sync ()
void e_mail_session_uri_to_folder ()
CamelFolder * e_mail_session_uri_to_folder_finish ()
EMVFolderContext * e_mail_session_create_vfolder_context ()
void e_mail_session_flush_outbox ()
void e_mail_session_schedule_outbox_flush ()
void e_mail_session_cancel_scheduled_outbox_flush ()
gboolean e_mail_session_mark_service_used_sync ()
void e_mail_session_unmark_service_used ()
void e_mail_session_emit_allow_auth_prompt ()
gboolean e_binding_transform_service_to_source ()
gboolean e_binding_transform_source_to_service ()
void mail_session_flush_filter_log ()
const gchar * mail_session_get_data_dir ()
const gchar * mail_session_get_cache_dir ()
const gchar * mail_session_get_config_dir ()

Types and Values

Description

Functions

e_mail_session_new ()

EMailSession *
e_mail_session_new (ESourceRegistry *registry);

e_mail_session_new is deprecated and should not be used in newly-written code.


e_mail_session_get_registry ()

ESourceRegistry *
e_mail_session_get_registry (EMailSession *session);

e_mail_session_get_registry is deprecated and should not be used in newly-written code.


e_mail_session_get_folder_cache ()

MailFolderCache *
e_mail_session_get_folder_cache (EMailSession *session);

e_mail_session_get_folder_cache is deprecated and should not be used in newly-written code.


e_mail_session_get_local_store ()

CamelStore *
e_mail_session_get_local_store (EMailSession *session);

e_mail_session_get_local_store is deprecated and should not be used in newly-written code.


e_mail_session_get_vfolder_store ()

CamelStore *
e_mail_session_get_vfolder_store (EMailSession *session);

e_mail_session_get_vfolder_store is deprecated and should not be used in newly-written code.


e_mail_session_get_local_folder ()

CamelFolder *
e_mail_session_get_local_folder (EMailSession *session,
                                 EMailLocalFolder type);

e_mail_session_get_local_folder is deprecated and should not be used in newly-written code.


e_mail_session_get_local_folder_uri ()

const gchar *
e_mail_session_get_local_folder_uri (EMailSession *session,
                                     EMailLocalFolder type);

e_mail_session_get_local_folder_uri is deprecated and should not be used in newly-written code.


e_mail_session_get_available_junk_filters ()

GList *
e_mail_session_get_available_junk_filters
                               (EMailSession *session);

e_mail_session_get_available_junk_filters is deprecated and should not be used in newly-written code.


e_mail_session_get_junk_filter_by_name ()

EMailJunkFilter *
e_mail_session_get_junk_filter_by_name
                               (EMailSession *session,
                                const gchar *filter_name);

e_mail_session_get_junk_filter_by_name is deprecated and should not be used in newly-written code.

Looks up an EMailJunkFilter extension by its filter name, as specified in its class structure. If no match is found, the function returns NULL.

Parameters

session

an EMailSession

 

filter_name

a junk filter name

 

Returns

an EMailJunkFilter, or NULL


e_mail_session_get_inbox_sync ()

CamelFolder *
e_mail_session_get_inbox_sync (EMailSession *session,
                               const gchar *service_uid,
                               GCancellable *cancellable,
                               GError **error);

e_mail_session_get_inbox_sync is deprecated and should not be used in newly-written code.


e_mail_session_get_inbox ()

void
e_mail_session_get_inbox (EMailSession *session,
                          const gchar *service_uid,
                          gint io_priority,
                          GCancellable *cancellable,
                          GAsyncReadyCallback callback,
                          gpointer user_data);

e_mail_session_get_inbox is deprecated and should not be used in newly-written code.


e_mail_session_get_inbox_finish ()

CamelFolder *
e_mail_session_get_inbox_finish (EMailSession *session,
                                 GAsyncResult *result,
                                 GError **error);

e_mail_session_get_inbox_finish is deprecated and should not be used in newly-written code.


e_mail_session_get_trash_sync ()

CamelFolder *
e_mail_session_get_trash_sync (EMailSession *session,
                               const gchar *service_uid,
                               GCancellable *cancellable,
                               GError **error);

e_mail_session_get_trash_sync is deprecated and should not be used in newly-written code.


e_mail_session_get_trash ()

void
e_mail_session_get_trash (EMailSession *session,
                          const gchar *service_uid,
                          gint io_priority,
                          GCancellable *cancellable,
                          GAsyncReadyCallback callback,
                          gpointer user_data);

e_mail_session_get_trash is deprecated and should not be used in newly-written code.


e_mail_session_get_trash_finish ()

CamelFolder *
e_mail_session_get_trash_finish (EMailSession *session,
                                 GAsyncResult *result,
                                 GError **error);

e_mail_session_get_trash_finish is deprecated and should not be used in newly-written code.


e_mail_session_uri_to_folder_sync ()

CamelFolder *
e_mail_session_uri_to_folder_sync (EMailSession *session,
                                   const gchar *folder_uri,
                                   CamelStoreGetFolderFlags flags,
                                   GCancellable *cancellable,
                                   GError **error);

e_mail_session_uri_to_folder_sync is deprecated and should not be used in newly-written code.


e_mail_session_uri_to_folder ()

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);

e_mail_session_uri_to_folder is deprecated and should not be used in newly-written code.


e_mail_session_uri_to_folder_finish ()

CamelFolder *
e_mail_session_uri_to_folder_finish (EMailSession *session,
                                     GAsyncResult *result,
                                     GError **error);

e_mail_session_uri_to_folder_finish is deprecated and should not be used in newly-written code.


e_mail_session_create_vfolder_context ()

EMVFolderContext *
e_mail_session_create_vfolder_context (EMailSession *session);

e_mail_session_create_vfolder_context is deprecated and should not be used in newly-written code.


e_mail_session_flush_outbox ()

void
e_mail_session_flush_outbox (EMailSession *session);

e_mail_session_flush_outbox is deprecated and should not be used in newly-written code.


e_mail_session_schedule_outbox_flush ()

void
e_mail_session_schedule_outbox_flush (EMailSession *session,
                                      gint delay_minutes);

e_mail_session_schedule_outbox_flush is deprecated and should not be used in newly-written code.


e_mail_session_cancel_scheduled_outbox_flush ()

void
e_mail_session_cancel_scheduled_outbox_flush
                               (EMailSession *session);

e_mail_session_cancel_scheduled_outbox_flush is deprecated and should not be used in newly-written code.


e_mail_session_mark_service_used_sync ()

gboolean
e_mail_session_mark_service_used_sync (EMailSession *session,
                                       CamelService *service,
                                       GCancellable *cancellable);

e_mail_session_mark_service_used_sync is deprecated and should not be used in newly-written code.

Marks the service as being used. If it is already in use, then waits for its release. The only reasons for a failure are either invalid parameters being passed in the function or the wait being cancelled. Use e_mail_session_unmark_service_used() to notice the session that that the service is no longer being used by the caller.

Parameters

session

an EMailSession

 

service

a CamelService

 

cancellable

a GCancellable, or NULL.

[allow none]

Returns

Whether successfully waited for the service .

Since: 3.16


e_mail_session_unmark_service_used ()

void
e_mail_session_unmark_service_used (EMailSession *session,
                                    CamelService *service);

e_mail_session_unmark_service_used is deprecated and should not be used in newly-written code.

Frees a "use lock" on the service , thus it can be used by others. If anything is waiting for it in e_mail_session_mark_service_used_sync(), then it is woken up.

Parameters

session

an EMailSession

 

service

a CamelService

 

Since: 3.16


e_mail_session_emit_allow_auth_prompt ()

void
e_mail_session_emit_allow_auth_prompt (EMailSession *session,
                                       ESource *source);

e_mail_session_emit_allow_auth_prompt is deprecated and should not be used in newly-written code.

Emits 'allow-auth-prompt' on session for source . This lets any listeners know to enable credentials prompt for this source .

Parameters

session

an EMailSession

 

source

an ESource

 

Since: 3.16


e_binding_transform_service_to_source ()

gboolean
e_binding_transform_service_to_source (GBinding *binding,
                                       const GValue *source_value,
                                       GValue *target_value,
                                       gpointer session);

e_binding_transform_service_to_source is deprecated and should not be used in newly-written code.


e_binding_transform_source_to_service ()

gboolean
e_binding_transform_source_to_service (GBinding *binding,
                                       const GValue *source_value,
                                       GValue *target_value,
                                       gpointer session);

e_binding_transform_source_to_service is deprecated and should not be used in newly-written code.


mail_session_flush_filter_log ()

void
mail_session_flush_filter_log (EMailSession *session);

mail_session_flush_filter_log is deprecated and should not be used in newly-written code.


mail_session_get_data_dir ()

const gchar *
mail_session_get_data_dir (void);

mail_session_get_data_dir is deprecated and should not be used in newly-written code.


mail_session_get_cache_dir ()

const gchar *
mail_session_get_cache_dir (void);

mail_session_get_cache_dir is deprecated and should not be used in newly-written code.


mail_session_get_config_dir ()

const gchar *
mail_session_get_config_dir (void);

mail_session_get_config_dir is deprecated and should not be used in newly-written code.

Types and Values

E_MAIL_SESSION_LOCAL_UID

#define E_MAIL_SESSION_LOCAL_UID   "local" /* "On This Computer" */

E_MAIL_SESSION_LOCAL_UID is deprecated and should not be used in newly-written code.


E_MAIL_SESSION_VFOLDER_UID

#define E_MAIL_SESSION_VFOLDER_UID "vfolder" /* "Search Folders" */

E_MAIL_SESSION_VFOLDER_UID is deprecated and should not be used in newly-written code.