Top | ![]() |
![]() |
![]() |
![]() |
ESourceAuthenticationESourceAuthentication — ESource extension for authentication settings |
GSocketConnectable * | connectable | Read |
gchar * | host | Read / Write / Construct |
gchar * | method | Read / Write / Construct |
guint | port | Read / Write / Construct |
gboolean | remember-password | Read / Write / Construct |
gchar * | user | Read / Write / Construct |
The ESourceAuthentication extension tracks authentication settings for a user account on a remote server.
Access the extension as follows:
#include <libedataserver/libedataserver.h> ESourceAuthentication *extension; extension = e_source_get_extension (source, E_SOURCE_EXTENSION_AUTHENTICATION);
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
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
const gchar *
e_source_authentication_get_host (ESourceAuthentication *extension
);
Returns the host name used to authenticate to a remote account.
Since 3.6
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
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
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
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
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
guint16
e_source_authentication_get_port (ESourceAuthentication *extension
);
Returns the port number used to authenticate to a remote account.
Since 3.6
void e_source_authentication_set_port (ESourceAuthentication *extension
,guint16 port
);
Sets the port number used to authenticate to a remote account.
Since 3.6
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
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
const gchar *
e_source_authentication_get_user (ESourceAuthentication *extension
);
Returns the user name used to authenticate to a remote account.
Since 3.6
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
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
struct ESourceAuthentication;
Contains only private data that should be read and manipulated using the functions below.
Since 3.6
#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
“connectable”
property“connectable” GSocketConnectable *
A GSocketConnectable constructed from the host and port properties.
Flags: Read
“host”
property“host” gchar *
Host name for the remote account.
Flags: Read / Write / Construct
Default value: ""
“method”
property“method” gchar *
Authentication method.
Flags: Read / Write / Construct
Default value: "none"
“port”
property“port” guint
Port number for the remote account.
Flags: Read / Write / Construct
Allowed values: <= 65535
Default value: 0
“remember-password”
property“remember-password” gboolean
Whether to offer to remember the password by default when prompted.
Flags: Read / Write / Construct
Default value: TRUE
“user”
property“user” gchar *
User name for the remote account.
Flags: Read / Write / Construct
Default value: NULL