struct ESourceAuthentication

struct ESourceAuthentication;

Contains only private data that should be read and manipulated using the functions below.

Since 3.6

E_SOURCE_EXTENSION_AUTHENTICATION

#define E_SOURCE_EXTENSION_AUTHENTICATION "Authentication"

Pass this extension name to e_source_get_extension() to access ESourceAuthentication. This is also used as a group name in key files.

Since 3.6

e_source_authentication_required ()

gboolean            e_source_authentication_required    (ESourceAuthentication *extension);

This is a convenience function which returns whether authentication is required at all, regardless of the method used. This relies on the convention of setting "method" to "none" when authentication is not required.

Since 3.6

e_source_authentication_ref_connectable ()

GSocketConnectable * e_source_authentication_ref_connectable
                                                        (ESourceAuthentication *extension);

Returns a GSocketConnectable instance constructed from extension's "host" and "port" properties, or NULL if the "host" is not set.

The returned GSocketConnectable is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

Since 3.8

e_source_authentication_get_host ()

const gchar *       e_source_authentication_get_host    (ESourceAuthentication *extension);

Returns the host name used to authenticate to a remote account.

Since 3.6

e_source_authentication_dup_host ()

gchar *             e_source_authentication_dup_host    (ESourceAuthentication *extension);

Thread-safe variation of e_source_authentication_get_host(). Use this function when accessing extension from multiple threads.

The returned string should be freed with g_free() when no longer needed.

Since 3.6

e_source_authentication_set_host ()

void                e_source_authentication_set_host    (ESourceAuthentication *extension,
                                                         const gchar *host);

Sets the host name used to authenticate to a remote account.

The internal copy of host is automatically stripped of leading and trailing whitespace. If the resulting string is empty, NULL is set instead.

Since 3.6

e_source_authentication_get_method ()

const gchar *       e_source_authentication_get_method  (ESourceAuthentication *extension);

Returns the authentication method for a remote account. There are no pre-defined method names; backends are free to set this however they wish. If authentication is not required for a remote account, the convention is to set "method" to "none".

Since 3.6

e_source_authentication_dup_method ()

gchar *             e_source_authentication_dup_method  (ESourceAuthentication *extension);

Thread-safe variation of e_source_authentication_get_method(). Use this function when accessing extension from multiple threads.

The returned string should be freed with g_free() when no longer needed.

Since 3.6

e_source_authentication_set_method ()

void                e_source_authentication_set_method  (ESourceAuthentication *extension,
                                                         const gchar *method);

Sets the authentication method for a remote account. There are no pre-defined method names; backends are free to set this however they wish. If authentication is not required for a remote account, the convention is to set the method to "none". In keeping with that convention, "method" will be set to "none" if method is NULL or an empty string.

Since 3.6

e_source_authentication_get_port ()

guint16             e_source_authentication_get_port    (ESourceAuthentication *extension);

Returns the port number used to authenticate to a remote account.

Since 3.6

e_source_authentication_set_port ()

void                e_source_authentication_set_port    (ESourceAuthentication *extension,
                                                         guint16 port);

Sets the port number used to authenticate to a remote account.

Since 3.6

e_source_authentication_get_remember_password ()

gboolean            e_source_authentication_get_remember_password
                                                        (ESourceAuthentication *extension);

Returns whether to offer to remember the provided password by default in password prompts. This way, if the user unchecks the option it will be unchecked by default in future password prompts.

Since 3.10

e_source_authentication_set_remember_password ()

void                e_source_authentication_set_remember_password
                                                        (ESourceAuthentication *extension,
                                                         gboolean remember_password);

Sets whether to offer to remember the provided password by default in password prompts. This way, if the user unchecks the option it will be unchecked by default in future password prompts.

Since 3.10

e_source_authentication_get_user ()

const gchar *       e_source_authentication_get_user    (ESourceAuthentication *extension);

Returns the user name used to authenticate to a remote account.

Since 3.6

e_source_authentication_dup_user ()

gchar *             e_source_authentication_dup_user    (ESourceAuthentication *extension);

Thread-safe variation of e_source_authentication_get_user(). Use this function when accessing extension from multiple threads.

The returned string should be freed with g_free() when no longer needed.

Since 3.6

e_source_authentication_set_user ()

void                e_source_authentication_set_user    (ESourceAuthentication *extension,
                                                         const gchar *user);

Sets the user name used to authenticate to a remote account.

The internal copy of user is automatically stripped of leading and trailing whitespace. If the resulting string is empty, NULL is set instead.

Since 3.6

The "connectable" property

  "connectable"              GSocketConnectable*   : Read

A GSocketConnectable constructed from the host and port properties.

The "host" property

  "host"                     gchar*                : Read / Write / Construct

Host name for the remote account.

Default value: ""

The "method" property

  "method"                   gchar*                : Read / Write / Construct

Authentication method.

Default value: "none"

The "port" property

  "port"                     guint                 : Read / Write / Construct

Port number for the remote account.

Allowed values: <= 65535

Default value: 0

The "remember-password" property

  "remember-password"        gboolean              : Read / Write / Construct

Whether to offer to remember the password by default when prompted.

Default value: TRUE

The "user" property

  "user"                     gchar*                : Read / Write / Construct

User name for the remote account.

Default value: NULL