![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
CamelSasl; GByteArray * camel_sasl_challenge (CamelSasl *sasl
,GByteArray *token
,CamelException *ex
); gchar * camel_sasl_challenge_base64 (CamelSasl *sasl
,const gchar *token
,CamelException *ex
); 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
); 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
"authenticated" gboolean : Read / Write "mechanism" gchar* : Read / Write / Construct Only "service" CamelService* : Read / Write / Construct Only "service-name" gchar* : Read / Write / Construct Only
GByteArray * camel_sasl_challenge (CamelSasl *sasl
,GByteArray *token
,CamelException *ex
);
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.
|
a CamelSasl object |
|
a token, or NULL
|
|
a CamelException |
Returns : |
the SASL response or NULL . If an error occurred, ex will
also be set.
|
gchar * camel_sasl_challenge_base64 (CamelSasl *sasl
,const gchar *token
,CamelException *ex
);
As with camel_sasl_challenge, but the challenge token
and the
response are both base64-encoded.
|
a CamelSasl object |
|
a base64-encoded token |
|
a CamelException |
Returns : |
the base64 encoded challenge string |
CamelSasl * camel_sasl_new (const gchar *service_name
,const gchar *mechanism
,CamelService *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 if the mechanism is not
supported.
|
gboolean camel_sasl_get_authenticated (CamelSasl *sasl
);
|
a CamelSasl object |
Returns : |
whether or not sasl has successfully authenticated the
user. This will be TRUE after it returns the last needed response.
The caller must still pass that information on to the server and
verify that it has accepted it.
|
void camel_sasl_set_authenticated (CamelSasl *sasl
,gboolean authenticated
);
|
a CamelSasl |
|
whether we have successfully authenticated |
Since 3.0
const gchar * camel_sasl_get_mechanism (CamelSasl *sasl
);
|
a CamelSasl |
Returns : |
Since 3.0
CamelService * camel_sasl_get_service (CamelSasl *sasl
);
|
a CamelSasl |
Returns : |
Since 3.0
const gchar * camel_sasl_get_service_name (CamelSasl *sasl
);
|
a CamelSasl |
Returns : |
Since 3.0
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. |