e_credentials_new ()

ECredentials *
e_credentials_new (void);

FIXME: Document me.

Since: 3.2

e_credentials_new_strv ()

ECredentials *
e_credentials_new_strv (const gchar * const *strv);

FIXME: Document me.

Since: 3.2

e_credentials_new_args ()

ECredentials *
e_credentials_new_args (const gchar *key,
                        ...);

FIXME: Document me.

Since: 3.2

e_credentials_new_clone ()

ECredentials *
e_credentials_new_clone (const ECredentials *credentials);

FIXME: Document me.

Since: 3.2

e_credentials_free ()

void
e_credentials_free (ECredentials *credentials);

FIXME: Document me.

Since: 3.2

e_credentials_to_strv ()

gchar **
e_credentials_to_strv (const ECredentials *credentials);

Returns NULL-terminated array of strings with keys and encoded values; To read them back pass this pointer to e_credentials_new(). As it returns newly allocated string then this should be freed with g_strfreev() when no longer needed.

Since: 3.2

e_credentials_set ()

void
e_credentials_set (ECredentials *credentials,
                   const gchar *key,
                   const gchar *value);

Sets value for key , if value is NULL or an empty string then key is removed. The value is supposed to be in a clear form (unencoded). key cannot contain colon.

Since: 3.2

e_credentials_get ()

gchar *
e_credentials_get (const ECredentials *credentials,
                   const gchar *key);

FIXME: Document me.

Since: 3.2

e_credentials_peek ()

const gchar *
e_credentials_peek (ECredentials *credentials,
                    const gchar *key);

Peeks at the value for key , in a clear form. The returned value is valid until free of the credentials structure or until the key value is rewritten by e_credentials_set().

Since: 3.2

e_credentials_equal ()

gboolean
e_credentials_equal (const ECredentials *credentials1,
                     const ECredentials *credentials2);

Returns whether two ECredential structures contain the same keys with same values.

Since: 3.2

e_credentials_equal_keys ()

gboolean
e_credentials_equal_keys (const ECredentials *credentials1,
                          const ECredentials *credentials2,
                          const gchar *key1,
                          ...);

Returns whether two ECredentials structures have the same keys. Key names are NULL-terminated.

Since: 3.2

e_credentials_has_key ()

gboolean
e_credentials_has_key (const ECredentials *credentials,
                       const gchar *key);

Returns whether credentials contains key .

Since: 3.2

e_credentials_keys_size ()

guint
e_credentials_keys_size (const ECredentials *credentials);

Returns the number of keys in credentials .

Since: 3.2

e_credentials_list_keys ()

GSList *
e_credentials_list_keys (const ECredentials *credentials);

Returns a newly-allocated GSList of key names stored in credentials . The key names are internal credentials values and should not be modified or freed. Free the list with g_slist_free() when no longer needed.

Since: 3.2

e_credentials_clear ()

void
e_credentials_clear (ECredentials *credentials);

FIXME: Document me.

Since: 3.2

e_credentials_clear_peek ()

void
e_credentials_clear_peek (ECredentials *credentials);

FIXME: Document me.

Since: 3.2

e_credentials_util_safe_free_string ()

void
e_credentials_util_safe_free_string (gchar *str);

FIXME Document me.

Since: 3.2

e_credentials_util_prompt_flags_to_string ()

gchar *
e_credentials_util_prompt_flags_to_string
                               (guint prompt_flags);

FIXME: Document me.

Since: 3.2

e_credentials_util_string_to_prompt_flags ()

guint
e_credentials_util_string_to_prompt_flags
                               (const gchar *prompt_flags_string);

FIXME: Document me.

Since: 3.2

struct ECredentials

struct ECredentials {
	ECredentialsPrivate *priv;
};

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

Since: 3.2

E_CREDENTIALS_KEY_USERNAME

#define E_CREDENTIALS_KEY_USERNAME "username"

FIXME Docment me.

Since: 3.2

E_CREDENTIALS_KEY_PASSWORD

#define E_CREDENTIALS_KEY_PASSWORD "password"

FIXME Document me.

Since: 3.2

E_CREDENTIALS_KEY_AUTH_METHOD

#define E_CREDENTIALS_KEY_AUTH_METHOD "auth-method"

FIXME Document me.

Since: 3.2

E_CREDENTIALS_KEY_PROMPT_TITLE

#define E_CREDENTIALS_KEY_PROMPT_TITLE "prompt-title"

FIXME Document me.

Since: 3.2

E_CREDENTIALS_KEY_PROMPT_TEXT

#define E_CREDENTIALS_KEY_PROMPT_TEXT "prompt-text"

FIXME: Document me.

Since: 3.2

E_CREDENTIALS_KEY_PROMPT_REASON

#define E_CREDENTIALS_KEY_PROMPT_REASON "prompt-reason"

FIXME: Document me.

Since: 3.2

E_CREDENTIALS_KEY_PROMPT_KEY

#define E_CREDENTIALS_KEY_PROMPT_KEY "prompt-key"

FIXME: Document me.

Since: 3.2

E_CREDENTIALS_KEY_PROMPT_FLAGS

#define E_CREDENTIALS_KEY_PROMPT_FLAGS "prompt-flags"

FIXME Document me.

Since: 3.2

E_CREDENTIALS_KEY_FOREIGN_REQUEST

#define E_CREDENTIALS_KEY_FOREIGN_REQUEST "foreign-request"

Set to "1" when the ECredentials is used to authenticate other than current EClient.

Since: 3.4

enum ECredentialsPromptFlags

FIXME Document me.

Since: 3.2

ECredentialsPrivate

typedef struct _ECredentialsPrivate ECredentialsPrivate;