![]() |
![]() |
![]() |
Evolution-Data-Server Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
ESourceMailAccountESourceMailAccount — ESource extension for an email account |
#include <libedataserver/libedataserver.h> #define E_SOURCE_EXTENSION_MAIL_ACCOUNT struct ESourceMailAccount; struct ESourceMailAccountClass; const gchar * e_source_mail_account_get_identity_uid (ESourceMailAccount *extension
); gchar * e_source_mail_account_dup_identity_uid (ESourceMailAccount *extension
); void e_source_mail_account_set_identity_uid (ESourceMailAccount *extension
,const gchar *identity_uid
); gchar * e_source_mail_account_dup_archive_folder (ESourceMailAccount *extension
); const gchar * e_source_mail_account_get_archive_folder (ESourceMailAccount *extension
); void e_source_mail_account_set_archive_folder (ESourceMailAccount *extension
,const gchar *archive_folder
); gboolean e_source_mail_account_get_needs_initial_setup (ESourceMailAccount *extension
); void e_source_mail_account_set_needs_initial_setup (ESourceMailAccount *extension
,gboolean needs_initial_setup
);
The ESourceMailAccount extension identifies the ESource as a mail account and also links to a default "mail identity" to use. See ESourceMailIdentity for more information about identities.
Access the extension as follows:
1 2 3 4 5 |
#include <libedataserver/libedataserver.h> ESourceMailAccount *extension; extension = e_source_get_extension (source, E_SOURCE_EXTENSION_MAIL_ACCOUNT); |
#define E_SOURCE_EXTENSION_MAIL_ACCOUNT "Mail Account"
Pass this extension name to e_source_get_extension()
to access
ESourceMailAccount. This is also used as a group name in key files.
Since 3.6
struct ESourceMailAccount { ESourceBackend parent; ESourceMailAccountPrivate *priv; };
Contains only private data that should be read and manipulated using the functions below.
Since 3.6
struct ESourceMailAccountClass { ESourceBackendClass parent_class; };
const gchar * e_source_mail_account_get_identity_uid
(ESourceMailAccount *extension
);
Returns the "uid" of the ESource that describes the mail identity to be used for this account.
|
an ESourceMailAccount |
Returns : |
the mail identity "uid" |
Since 3.6
gchar * e_source_mail_account_dup_identity_uid
(ESourceMailAccount *extension
);
Thread-safe variation of e_source_mail_account_get_identity_uid()
.
Use this function when accessing extension
from multiple threads.
The returned string should be freed with g_free()
when no longer needed.
|
an ESourceMailAccount |
Returns : |
a newly-allocated copy of "identity-uid" |
Since 3.6
void e_source_mail_account_set_identity_uid (ESourceMailAccount *extension
,const gchar *identity_uid
);
Sets the "uid" of the ESource that describes the mail identity to be used for this account.
|
an ESourceMailAccount |
|
the mail identity "uid", or NULL . [allow-none]
|
Since 3.6
gchar * e_source_mail_account_dup_archive_folder
(ESourceMailAccount *extension
);
Thread-safe variation of e_source_mail_account_get_archive_folder()
.
Use this function when accessing extension
from multiple threads.
The returned string should be freed with g_free()
when no longer needed.
|
an ESourceMailAccount |
Returns : |
a newly-allocated copy of "archive-folder" |
Since 3.16
const gchar * e_source_mail_account_get_archive_folder
(ESourceMailAccount *extension
);
Returns a string identifying the archive folder. The format of the identifier string is defined by the client application.
|
an ESourceMailAccount |
Returns : |
an identifier of the archive folder |
Since 3.16
void e_source_mail_account_set_archive_folder (ESourceMailAccount *extension
,const gchar *archive_folder
);
Sets the folder for sent messages by an identifier string. The format of the identifier string is defined by the client application.
The internal copy of archive_folder
is automatically stripped of leading
and trailing whitespace. If the resulting string is empty, NULL
is set
instead.
|
an ESourceMailAccount |
|
an identifier for the archive folder, or NULL . [allow-none]
|
Since 3.16
gboolean e_source_mail_account_get_needs_initial_setup
(ESourceMailAccount *extension
);
Check whether the mail account needs to do its initial setup.
|
an ESourceMailAccount |
Returns : |
TRUE , when the account needs to run its initial setup |
Since 3.20
void e_source_mail_account_set_needs_initial_setup (ESourceMailAccount *extension
,gboolean needs_initial_setup
);
Sets whether the account needs to run its initial setup.
|
an ESourceMailAccount |
|
value to set |
Since 3.20