Camel.NetworkSettings¶

Implementations:: None

Methods¶

	`dup_auth_mechanism` ()
	`dup_host` ()
	`dup_host_ensure_ascii` ()
	`dup_user` ()
	`get_auth_mechanism` ()
	`get_host` ()
	`get_port` ()
	`get_security_method` ()
	`get_user` ()
	`set_auth_mechanism` (auth_mechanism)
	`set_host` (host)
	`set_port` (port)
	`set_security_method` (method)
	`set_user` (user)

Virtual Methods¶

None

Properties¶

Name	Type	Flags	Short Description
`auth-mechanism`	`str`	r/w/c	Authentication mechanism name
`host`	`str`	r/w/c	Host name for the network service
`port`	`int`	r/w/c	Port number for the network service
`security-method`	`Camel.NetworkSecurityMethod`	r/w/c	Method used to establish a network connection
`user`	`str`	r/w/c	User name for the network account

Signals¶

None

Fields¶

None

Class Details¶

class Camel.NetworkSettings¶

Bases:: GObject.GInterface
Structure:: Camel.NetworkSettingsInterface

New in version 3.2.

dup_auth_mechanism()¶

Returns:: a newly-allocated copy of Camel.NetworkSettings :auth-mechanism
Return type:: str or None

Thread-safe variation of Camel.NetworkSettings.get_auth_mechanism(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.4.

dup_host()¶

Returns:: a newly-allocated copy of Camel.NetworkSettings :host
Return type:: str

Thread-safe variation of Camel.NetworkSettings.get_host(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.4.

dup_host_ensure_ascii()¶

Returns:: a newly-allocated copy of Camel.NetworkSettings :host with only ASCII letters.
Return type:: str

Just like Camel.NetworkSettings.dup_host(), only makes sure that the returned host name will be converted into its ASCII form in case of IDNA value.

New in version 3.16.

dup_user()¶

Returns:: a newly-allocated copy of Camel.NetworkSettings :user
Return type:: str

Thread-safe variation of Camel.NetworkSettings.get_user(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.4.

get_auth_mechanism()¶

Returns:: the authentication mechanism name
Return type:: str or None

Returns the mechanism name used to authenticate to a network service. Often this refers to a SASL mechanism such as “LOGIN” or “GSSAPI”.

New in version 3.4.

get_host()¶

Returns:: the host name of a network service
Return type:: str

Returns the host name used to authenticate to a network service.

New in version 3.4.

get_port()¶

Returns:: the port number of a network service
Return type:: int

Returns the port number used to authenticate to a network service.

New in version 3.4.

get_security_method()¶

Returns:: the security method
Return type:: Camel.NetworkSecurityMethod

Returns the method used to establish a secure (or unsecure) network connection.

New in version 3.2.

get_user()¶

Returns:: the user name of a network service
Return type:: str

Returns the user name used to authenticate to a network service.

New in version 3.4.

set_auth_mechanism(auth_mechanism)¶

Parameters:: auth_mechanism (str or None) – an authentication mechanism name, or None

Sets the mechanism name used to authenticate to a network service. Often this refers to a SASL mechanism such as “LOGIN” or “GSSAPI”. The Camel.NetworkSettings :auth-mechanism property is automatically stripped of leading and trailing whitespace.

New in version 3.4.

set_host(host)¶

Parameters:: host (str or None) – a host name, or None

Sets the host name used to authenticate to a network service. The Camel.NetworkSettings :host property is automatically stripped of leading and trailing whitespace.

New in version 3.4.

set_port(port)¶

Parameters:: port (int) – a port number

Sets the port number used to authenticate to a network service.

New in version 3.4.

set_security_method(method)¶

Parameters:: method (Camel.NetworkSecurityMethod) – the security 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.

New in version 3.2.

set_user(user)¶

Parameters:: user (str or None) – a user name, or None

Sets the user name used to authenticate to a network service. The Camel.NetworkSettings :user property is automatically stripped of leading and trailing whitespace.

New in version 3.4.

Property Details¶

Camel.NetworkSettings.props.auth_mechanism¶

Name:: auth-mechanism
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Authentication mechanism name

Camel.NetworkSettings.props.host¶

Name:: host
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT

Host name for the network service

Camel.NetworkSettings.props.port¶

Name:: port
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT

Port number for the network service

Camel.NetworkSettings.props.security_method¶

Name:: security-method
Type:: Camel.NetworkSecurityMethod
Default Value:: Camel.NetworkSecurityMethod.STARTTLS_ON_STANDARD_PORT
Flags:: READABLE, WRITABLE, CONSTRUCT

Method used to establish a network connection

Camel.NetworkSettings.props.user¶

Name:: user
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

User name for the network account