Top |
Functions
Properties
MailFolderCache * | folder-cache | Read |
CamelStore * | local-store | Read |
ESourceRegistry * | registry | Read / Write / Construct Only |
CamelStore * | vfolder-store | Read |
Signals
void | allow-auth-prompt | Run First |
void | flush-outbox | Run First |
void | refresh-service | Run Last |
void | store-added | Run First |
void | store-removed | Run First |
Functions
e_mail_session_get_registry ()
ESourceRegistry *
e_mail_session_get_registry (EMailSession *session
);
e_mail_session_get_folder_cache ()
MailFolderCache *
e_mail_session_get_folder_cache (EMailSession *session
);
e_mail_session_get_local_store ()
CamelStore *
e_mail_session_get_local_store (EMailSession *session
);
e_mail_session_get_vfolder_store ()
CamelStore *
e_mail_session_get_vfolder_store (EMailSession *session
);
e_mail_session_get_local_folder ()
CamelFolder * e_mail_session_get_local_folder (EMailSession *session
,EMailLocalFolder type
);
e_mail_session_get_local_folder_uri ()
const gchar * e_mail_session_get_local_folder_uri (EMailSession *session
,EMailLocalFolder type
);
e_mail_session_get_available_junk_filters ()
GList *
e_mail_session_get_available_junk_filters
(EMailSession *session
);
e_mail_session_get_junk_filter_by_name ()
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
.
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 ()
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_finish ()
CamelFolder * e_mail_session_get_inbox_finish (EMailSession *session
,GAsyncResult *result
,GError **error
);
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 ()
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_finish ()
CamelFolder * e_mail_session_get_trash_finish (EMailSession *session
,GAsyncResult *result
,GError **error
);
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 ()
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_finish ()
CamelFolder * e_mail_session_uri_to_folder_finish (EMailSession *session
,GAsyncResult *result
,GError **error
);
e_mail_session_create_vfolder_context ()
EMVFolderContext *
e_mail_session_create_vfolder_context (EMailSession *session
);
e_mail_session_schedule_outbox_flush ()
void e_mail_session_schedule_outbox_flush (EMailSession *session
,gint delay_minutes
);
e_mail_session_cancel_scheduled_outbox_flush ()
void
e_mail_session_cancel_scheduled_outbox_flush
(EMailSession *session
);
e_mail_session_mark_service_used_sync ()
gboolean e_mail_session_mark_service_used_sync (EMailSession *session
,CamelService *service
,GCancellable *cancellable
);
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] |
Since: 3.16
e_mail_session_unmark_service_used ()
void e_mail_session_unmark_service_used (EMailSession *session
,CamelService *service
);
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.
Since: 3.16
e_mail_session_emit_allow_auth_prompt ()
void e_mail_session_emit_allow_auth_prompt (EMailSession *session
,ESource *source
);
Emits 'allow-auth-prompt' on session
for source
. This lets
any listeners know to enable credentials prompt for this source
.
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_source_to_service ()
gboolean e_binding_transform_source_to_service (GBinding *binding
,const GValue *source_value
,GValue *target_value
,gpointer session
);
Property Details
The “registry”
property
“registry” ESourceRegistry *
Data source registry.
Flags: Read / Write / Construct Only
Signal Details
The “allow-auth-prompt”
signal
void user_function (EMailSession *emailsession, ESource *arg1, gpointer user_data)
Flags: Run First
The “flush-outbox”
signal
void user_function (EMailSession *session, gpointer user_data)
Emitted if the send folder should be flushed.
Flags: Run First
The “refresh-service”
signal
void user_function (EMailSession *session, CamelService *service, gpointer user_data)
Emitted when service
should be refreshed.
Parameters
session |
the EMailSession that emitted the signal |
|
service |
a CamelService |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
The “store-added”
signal
void user_function (EMailSession *session, CamelStore *store, gpointer user_data)
Emitted when a store is added
Parameters
session |
the EMailSession that emitted the signal |
|
store |
a CamelStore |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
The “store-removed”
signal
void user_function (EMailSession *session, CamelStore *source, gpointer user_data)
This signal is emitted with e_mail_session_emit_allow_auth_prompt()
to let
any listeners know to enable credentials prompt for the given source
.
Parameters
session |
the EMailSession that emitted the signal |
|
source |
an ESource |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
Since: 3.16