| Camel Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
struct CamelSasl; CamelSasl * camel_sasl_new (const,gchar *service_nameconst,gchar *mechanismCamelService *service);gboolean camel_sasl_try_empty_password_sync (CamelSasl *sasl,,GCancellable *cancellable);GError **errorvoid camel_sasl_try_empty_password (CamelSasl *sasl,,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback);gpointer user_datagboolean camel_sasl_try_empty_password_finish (CamelSasl *sasl,,GAsyncResult *result);GError **errorgboolean camel_sasl_get_authenticated (CamelSasl *sasl);void camel_sasl_set_authenticated (CamelSasl *sasl,); constgboolean authenticatedgchar * camel_sasl_get_mechanism (CamelSasl *sasl); CamelService * camel_sasl_get_service (CamelSasl *sasl); constgchar * camel_sasl_get_service_name (CamelSasl *sasl);GByteArray * camel_sasl_challenge_sync (CamelSasl *sasl,,GByteArray *token,GCancellable *cancellable);GError **errorvoid camel_sasl_challenge (CamelSasl *sasl,,GByteArray *token,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback);gpointer user_dataGByteArray * camel_sasl_challenge_finish (CamelSasl *sasl,,GAsyncResult *result);GError **errorgchar * camel_sasl_challenge_base64_sync (CamelSasl *sasl,const,gchar *token,GCancellable *cancellable);GError **errorvoid camel_sasl_challenge_base64 (CamelSasl *sasl,const,gchar *token,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback);gpointer user_datagchar * camel_sasl_challenge_base64_finish (CamelSasl *sasl,,GAsyncResult *result);GError **errorGList * camel_sasl_authtype_list (); CamelServiceAuthType * camel_sasl_authtype (gboolean include_plainconst);gchar *mechanism
GObject +----CamelObject +----CamelSasl +----CamelSaslAnonymous +----CamelSaslCramMd5 +----CamelSaslDigestMd5 +----CamelSaslGssapi +----CamelSaslLogin +----CamelSaslNTLM +----CamelSaslPlain +----CamelSaslPOPB4SMTP
"authenticated"gboolean : Read / Write "mechanism"gchar * : Read / Write / Construct Only "service" CamelService* : Read / Write / Construct Only "service-name"gchar * : Read / Write / Construct Only
CamelSasl * camel_sasl_new (const,gchar *service_nameconst,gchar *mechanismCamelService *service);
|
the SASL service name |
|
the SASL mechanism |
|
the CamelService that will be using this SASL |
Returns : |
a new CamelSasl object for the given service_name,
mechanism, and service, or NULL |
gboolean camel_sasl_try_empty_password_sync (CamelSasl *sasl,,GCancellable *cancellable);GError **error
|
a CamelSasl object |
|
optional NULL |
|
return location for a NULL |
Returns : |
whether or not sasl can attempt to authenticate without a
password being provided by the caller. This will be TRUEneed_password flag set in its description. |
Since 3.2
void camel_sasl_try_empty_password (CamelSasl *sasl,,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback);gpointer user_data
Asynchronously determine whether sasl can be used for password-less
authentication, for example single-sign-on using system credentials.
When the operation is finished, callback will be called. You can then
call camel_sasl_try_empty_password_finish() to get the result of the
operation.
|
a CamelSasl |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.2
gboolean camel_sasl_try_empty_password_finish (CamelSasl *sasl,,GAsyncResult *result);GError **error
Finishes the operation started with camel_sasl_try_empty_password().
|
a CamelSasl |
|
a |
|
return location for a NULL |
Returns : |
the SASL response. If an error occurred, error will also be set. |
Since 3.2
gboolean camel_sasl_get_authenticated (CamelSasl *sasl);
|
a CamelSasl |
Returns : |
whether or not sasl has successfully authenticated the
user. This will be TRUE |
void camel_sasl_set_authenticated (CamelSasl *sasl,);gboolean authenticated
|
a CamelSasl |
|
whether we have successfully authenticated |
Since 2.32
constgchar * camel_sasl_get_mechanism (CamelSasl *sasl);
|
a CamelSasl |
Since 2.32
CamelService * camel_sasl_get_service (CamelSasl *sasl);
|
a CamelSasl |
Since 2.32
constgchar * camel_sasl_get_service_name (CamelSasl *sasl);
|
a CamelSasl |
Since 2.32
GByteArray * camel_sasl_challenge_sync (CamelSasl *sasl,,GByteArray *token,GCancellable *cancellable);GError **error
If token is NULLNULLtoken is a challenge from the server, and
the return value is the response.
Free the returned g_byte_array_free()
|
a CamelSasl |
|
a token, or NULL |
|
optional NULL |
|
return location for a NULL |
Returns : |
the SASL response or NULLerror will
also be set. |
void camel_sasl_challenge (CamelSasl *sasl,,GByteArray *token,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback);gpointer user_data
If token is NULLNULLtoken is a challenge from the
server, and the asynchronous result is the response.
When the operation is finished, callback will be called. You can then
call camel_sasl_challenge_finish() to get the result of the operation.
|
a CamelSasl |
|
a token, or NULL |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
GByteArray * camel_sasl_challenge_finish (CamelSasl *sasl,,GAsyncResult *result);GError **error
Finishes the operation started with camel_sasl_challenge(). Free the
returned g_byte_array_free()
|
a CamelSasl |
|
a |
|
return location for a NULL |
Returns : |
the SASL response or NULLerror will
also be set. |
Since 3.0
gchar * camel_sasl_challenge_base64_sync (CamelSasl *sasl,const,gchar *token,GCancellable *cancellable);GError **error
As with camel_sasl_challenge_sync(), but the challenge token and the
response are both base64-encoded.
|
a CamelSasl |
|
a base64-encoded token |
|
optional NULL |
|
return location for a NULL |
Returns : |
the base64-encoded response |
Since 3.0
void camel_sasl_challenge_base64 (CamelSasl *sasl,const,gchar *token,gint io_priority,GCancellable *cancellable,GAsyncReadyCallback callback);gpointer user_data
As with camel_sasl_challenge(), but the challenge token and the
response are both base64-encoded.
When the operation is finished, callback will be called. You can
then call camel_store_challenge_base64_finish()
|
a CamelSasl |
|
a base64-encoded token |
|
the I/O priority of the request |
|
optional NULL |
|
a |
|
data to pass to the callback function |
Since 3.0
gchar * camel_sasl_challenge_base64_finish (CamelSasl *sasl,,GAsyncResult *result);GError **error
Finishes the operation started with camel_sasl_challenge_base64().
|
a CamelSasl |
|
a |
|
return location for a NULL |
Returns : |
the base64-encoded response |
Since 3.0
GList * camel_sasl_authtype_list ();gboolean include_plain
|
whether or not to include the PLAIN mechanism |
Returns : |
a |
CamelServiceAuthType * camel_sasl_authtype (const gchar *mechanism);
|
the SASL mechanism to get an authtype for |
Returns : |
a CamelServiceAuthType for the given mechanism, if it is supported. |