![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
struct CamelSasl; CamelSasl * camel_sasl_new (const gchar *service_name
,const gchar *mechanism
,CamelService *service
); gboolean camel_sasl_get_authenticated (CamelSasl *sasl
); void camel_sasl_set_authenticated (CamelSasl *sasl
,gboolean authenticated
); const gchar * camel_sasl_get_mechanism (CamelSasl *sasl
); CamelService * camel_sasl_get_service (CamelSasl *sasl
); const gchar * camel_sasl_get_service_name (CamelSasl *sasl
); GByteArray * camel_sasl_challenge_sync (CamelSasl *sasl
,GByteArray *token
,GCancellable *cancellable
,GError **error
); void camel_sasl_challenge (CamelSasl *sasl
,GByteArray *token
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); GByteArray * camel_sasl_challenge_finish (CamelSasl *sasl
,GAsyncResult *result
,GError **error
); gchar * camel_sasl_challenge_base64_sync (CamelSasl *sasl
,const gchar *token
,GCancellable *cancellable
,GError **error
); void camel_sasl_challenge_base64 (CamelSasl *sasl
,const gchar *token
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gchar * camel_sasl_challenge_base64_finish (CamelSasl *sasl
,GAsyncResult *result
,GError **error
); GList * camel_sasl_authtype_list (gboolean include_plain
); CamelServiceAuthType * camel_sasl_authtype (const gchar *mechanism
);
GObject +----CamelObject +----CamelSasl +----CamelSaslAnonymous +----CamelSaslCramMd5 +----CamelSaslDigestMd5 +----CamelSaslGssapi +----CamelSaslLogin +----CamelSaslNTLM +----CamelSaslPlain +----CamelSaslPOPB4SMTP
CamelSasl * camel_sasl_new (const gchar *service_name
,const gchar *mechanism
,CamelService *service
);
void camel_sasl_set_authenticated (CamelSasl *sasl
,gboolean authenticated
);
|
a CamelSasl |
|
whether we have successfully authenticated |
Since 2.32
const gchar * camel_sasl_get_mechanism (CamelSasl *sasl
);
|
a CamelSasl |
Since 2.32
CamelService * camel_sasl_get_service (CamelSasl *sasl
);
|
a CamelSasl |
Since 2.32
const gchar * 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 NULL
, generate the initial SASL message to send to
the server. (This will be NULL
if the client doesn't initiate the
exchange.) Otherwise, token
is a challenge from the server, and
the return value is the response.
Free the returned GByteArray with g_byte_array_free()
.
void camel_sasl_challenge (CamelSasl *sasl
,GByteArray *token
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
If token
is NULL
, asynchronously generate the initial SASL message
to send to the server. (This will be NULL
if the client doesn't
initiate the exchange.) Otherwise, token
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 GCancellable object, or NULL
|
|
a GAsyncReadyCallback to call when the request is satisfied |
|
data to pass to the callback function |
Since 2.92
GByteArray * camel_sasl_challenge_finish (CamelSasl *sasl
,GAsyncResult *result
,GError **error
);
Finishes the operation started with camel_sasl_challenge()
. Free the
returned GByteArray with g_byte_array_free()
.
|
a CamelSasl |
|
a GAsyncResult |
|
return location for a GError, or NULL
|
Returns : |
the SASL response or NULL . If an error occurred, error will
also be set. |
Since 2.92
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 GCancellable object, or NULL
|
|
return location for a GError, or NULL
|
Returns : |
the base64-encoded response |
Since 2.92
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()
to get the result of
the operation.
|
a CamelSasl |
|
a base64-encoded token |
|
the I/O priority of the request |
|
optional GCancellable object, or NULL
|
|
a GAsyncReadyCallback to call when the request is satisfied |
|
data to pass to the callback function |
Since 2.92
gchar * camel_sasl_challenge_base64_finish (CamelSasl *sasl
,GAsyncResult *result
,GError **error
);
Finishes the operation started with camel_sasl_challenge_base64()
.
|
a CamelSasl |
|
a GAsyncResult |
|
return location for a GError, or NULL
|
Returns : |
the base64-encoded response |
Since 2.92
GList * camel_sasl_authtype_list (gboolean include_plain
);
|
whether or not to include the PLAIN mechanism |
Returns : |
a GList of SASL-supported authtypes. The caller must free the list, but not the contents. |
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. |