| Camel Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Prerequisites | Properties | ||||
CamelNetworkSettings; const gchar * camel_network_settings_get_auth_mechanism (CamelNetworkSettings *settings); gchar * camel_network_settings_dup_auth_mechanism (CamelNetworkSettings *settings); void camel_network_settings_set_auth_mechanism (CamelNetworkSettings *settings,const gchar *auth_mechanism); const gchar * camel_network_settings_get_host (CamelNetworkSettings *settings); gchar * camel_network_settings_dup_host (CamelNetworkSettings *settings); void camel_network_settings_set_host (CamelNetworkSettings *settings,const gchar *host); guint16 camel_network_settings_get_port (CamelNetworkSettings *settings); void camel_network_settings_set_port (CamelNetworkSettings *settings,guint16 port); enum CamelNetworkSecurityMethod; CamelNetworkSecurityMethod camel_network_settings_get_security_method (CamelNetworkSettings *settings); void camel_network_settings_set_security_method (CamelNetworkSettings *settings,CamelNetworkSecurityMethod method); const gchar * camel_network_settings_get_user (CamelNetworkSettings *settings); gchar * camel_network_settings_dup_user (CamelNetworkSettings *settings); void camel_network_settings_set_user (CamelNetworkSettings *settings,const gchar *user);
"auth-mechanism" gchar* : Read / Write / Construct "host" gchar* : Read / Write / Construct "port" guint : Read / Write / Construct "security-method" CamelNetworkSecurityMethod : Read / Write / Construct "user" gchar* : Read / Write / Construct
const gchar * camel_network_settings_get_auth_mechanism
(CamelNetworkSettings *settings);
Returns the mechanism name used to authenticate to a network service. Often this refers to a SASL mechanism such as "LOGIN" or "GSSAPI".
|
a CamelNetworkSettings |
Returns : |
the authentication mechanism name |
Since 3.4
gchar * camel_network_settings_dup_auth_mechanism
(CamelNetworkSettings *settings);
Thread-safe variation of camel_network_settings_get_auth_mechanism().
Use this function when accessing settings from a worker thread.
The returned string should be freed with g_free() when no longer needed.
|
a CamelNetworkSettings |
Returns : |
a newly-allocated copy of "auth-mechanism" |
Since 3.4
void camel_network_settings_set_auth_mechanism (CamelNetworkSettings *settings,const gchar *auth_mechanism);
Sets the mechanism name used to authenticate to a network service. Often this refers to a SASL mechanism such as "LOGIN" or "GSSAPI". The "auth-mechanism" property is automatically stripped of leading and trailing whitespace.
|
a CamelNetworkSettings |
|
an authentication mechanism name, or NULL
|
Since 3.4
const gchar * camel_network_settings_get_host (CamelNetworkSettings *settings);
Returns the host name used to authenticate to a network service.
|
a CamelNetworkSettings |
Returns : |
the host name of a network service |
Since 3.4
gchar * camel_network_settings_dup_host (CamelNetworkSettings *settings);
Thread-safe variation of camel_network_settings_get_host().
Use this function when accessing settings from a worker thread.
The returned string should be freed with g_free() when no longer needed.
|
a CamelNetworkSettings |
Returns : |
a newly-allocated copy of "host" |
Since 3.4
void camel_network_settings_set_host (CamelNetworkSettings *settings,const gchar *host);
Sets the host name used to authenticate to a network service. The "host" property is automatically stripped of leading and trailing whitespace.
|
a CamelNetworkSettings |
|
a host name, or NULL
|
Since 3.4
guint16 camel_network_settings_get_port (CamelNetworkSettings *settings);
Returns the port number used to authenticate to a network service.
|
a CamelNetworkSettings |
Returns : |
the port number of a network service |
Since 3.4
void camel_network_settings_set_port (CamelNetworkSettings *settings,guint16 port);
Sets the port number used to authenticate to a network service.
|
a CamelNetworkSettings |
|
a port number |
Since 3.4
typedef enum {
CAMEL_NETWORK_SECURITY_METHOD_NONE,
CAMEL_NETWORK_SECURITY_METHOD_SSL_ON_ALTERNATE_PORT,
CAMEL_NETWORK_SECURITY_METHOD_STARTTLS_ON_STANDARD_PORT
} CamelNetworkSecurityMethod;
Methods for establishing an encrypted (or unencrypted) network connection.
| Use an unencrypted network connection. | |
| Use SSL by connecting to an alternate port number. | |
| Use SSL or TLS by connecting to the standard port and invoking STARTTLS before authenticating. This is the recommended method. |
Since 3.2
CamelNetworkSecurityMethod camel_network_settings_get_security_method
(CamelNetworkSettings *settings);
Returns the method used to establish a secure (or unsecure) network connection.
|
a CamelNetworkSettings |
Returns : |
the security method |
Since 3.2
void camel_network_settings_set_security_method (CamelNetworkSettings *settings,CamelNetworkSecurityMethod method);
Sets the method used to establish a secure (or unsecure) network connection. Note that changing this setting has no effect on an already-established network connection.
|
a CamelNetworkSettings |
|
the security method |
Since 3.2
const gchar * camel_network_settings_get_user (CamelNetworkSettings *settings);
Returns the user name used to authenticate to a network service.
|
a CamelNetworkSettings |
Returns : |
the user name of a network service |
Since 3.4
gchar * camel_network_settings_dup_user (CamelNetworkSettings *settings);
Thread-safe variation of camel_network_settings_get_user().
Use this function when accessing settings from a worker thread.
The returned string should be freed with g_free() when no longer needed.
|
a CamelNetworkSettings |
Returns : |
a newly-allocated copy of "user" |
Since 3.4
void camel_network_settings_set_user (CamelNetworkSettings *settings,const gchar *user);
Sets the user name used to authenticate to a network service. The "user" property is automatically stripped of leading and trailing whitespace.
|
a CamelNetworkSettings |
|
a user name, or NULL
|
Since 3.4
"auth-mechanism" property "auth-mechanism" gchar* : Read / Write / Construct
Authentication mechanism name.
Default value: NULL
"host" property "host" gchar* : Read / Write / Construct
Host name for the network service.
Default value: "localhost"
"port" property "port" guint : Read / Write / Construct
Port number for the network service.
Allowed values: <= 65535
Default value: 0
"security-method" property"security-method" CamelNetworkSecurityMethod : Read / Write / Construct
Method used to establish a network connection.
Default value: CAMEL_NETWORK_SECURITY_METHOD_STARTTLS_ON_STANDARD_PORT