EDataServer.SourceMailIdentity

EDataServer.SourceMailIdentity

EDataServer.SourceMailIdentity¶

Subclasses:: None

Methods¶

Inherited:: EDataServer.SourceExtension (4), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`dup_address` ()
	`dup_aliases` ()
	`dup_name` ()
	`dup_organization` ()
	`dup_reply_to` ()
	`dup_signature_uid` ()
	`get_address` ()
	`get_aliases` ()
	`get_aliases_as_hash_table` ()
	`get_name` ()
	`get_organization` ()
	`get_reply_to` ()
	`get_signature_uid` ()
	`set_address` (address)
	`set_aliases` (aliases)
	`set_name` (name)
	`set_organization` (organization)
	`set_reply_to` (reply_to)
	`set_signature_uid` (signature_uid)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: EDataServer.SourceExtension (1)

Name	Type	Flags	Short Description
`address`	`str`	r/w/c/en	Sender’s email address
`aliases`	`str`	r/w/c/en	Sender’s email address aliases
`name`	`str`	r/w/c/en	Sender’s name
`organization`	`str`	r/w/c/en	Sender’s organization
`reply-to`	`str`	r/w/c/en	Sender’s reply-to address
`signature-uid`	`str`	r/w/c/en	`EDataServer.Source` UID of the sender’s signature

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`EDataServer.SourceExtension`	r

Class Details¶

class EDataServer.SourceMailIdentity(**kwargs)¶

Bases:: EDataServer.SourceExtension
Abstract:: No
Structure:: EDataServer.SourceMailIdentityClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.6.

dup_address()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailIdentity :address
Return type:: str or None

Thread-safe variation of EDataServer.SourceMailIdentity.get_address(). 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.6.

dup_aliases()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailIdentity :aliases
Return type:: str or None

Thread-safe variation of EDataServer.SourceMailIdentity.get_aliases(). 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.24.

dup_name()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailIdentity :name
Return type:: str or None

Thread-safe variation of EDataServer.SourceMailIdentity.get_name(). 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.6.

dup_organization()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailIdentity :organization
Return type:: str or None

Thread-safe variation of EDataServer.SourceMailIdentity.dup_organization(). 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.6.

dup_reply_to()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailIdentity :reply-to
Return type:: str or None

Thread-safe variation of EDataServer.SourceMailIdentity.get_reply_to(). 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.6.

dup_signature_uid()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailIdentity :signature-uid
Return type:: str or None

Thread-safe variation of EDataServer.SourceMailIdentity.get_signature_uid(). 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.6.

get_address()¶

Returns:: the sender’s email address
Return type:: str or None

Returns the email address for this identity from which to send messages. This may be an empty string but will never be None.

New in version 3.6.

get_aliases()¶

Returns:: the sender’s email address aliases
Return type:: str or None

Returns the email address aliases for this identity. These are comma-separated email addresses which may or may not contain also different name. This may be an empty string, but will never be None. There can be used Camel.Address.decode() on a Camel.InternetAddress to decode the list of aliases.

New in version 3.24.

get_aliases_as_hash_table()¶

Returns:: A newly created GLib.HashTable will all the aliases. Returns None if there are none set. Use GLib.HashTable.destroy() to free the returned hash table.
Return type:: {str: str} or None

Returns a set aliases as a hash table with address as key and name as value of the hash table. The name can be sometimes empty or None, thus rather use GLib.HashTable.contains() when checking for particular address. The addresses are compared case insensitively. The same addresses with a different name are included only once, the last variant of it. Use EDataServer.SourceMailIdentity.get_aliases() if you need more fine-grained control on the list of aliases.

New in version 3.24.

get_name()¶

Returns:: the sender’s name
Return type:: str or None

Returns the sender’s name for this identity.

New in version 3.6.

get_organization()¶

Returns:: the sender’s organization
Return type:: str or None

Returns the sender’s organization for this identity.

New in version 3.6.

get_reply_to()¶

Returns:: the sender’s reply-to address
Return type:: str or None

Returns the email address for this identity to which recipients should send replies.

New in version 3.6.

get_signature_uid()¶

Returns:: the sender’s signature ID, or “none”
Return type:: str or None

Returns the EDataServer.Source :uid of an EDataServer.Source describing a mail signature.

If the user does not want to use a signature for this identity, the convention is to set the EDataServer.SourceMailIdentity :signature-uid property to “none”.

New in version 3.6.

set_address(address)¶

Parameters:: address (str or None) – the sender’s email address, or None

Sets the email address for this identity from which to send messages.

The internal copy of address is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

set_aliases(aliases)¶

Parameters:: aliases (str or None) – the sender’s email address aliases, or None

Sets the email address aliases for this identity. These are comma-separated email addresses which may or may not contain also different name.

The internal copy of aliases is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.24.

set_name(name)¶

Parameters:: name (str or None) – the sender’s name, or None

Sets the sender’s name for this identity.

The internal copy of name is automatically stripped of leading and trailing whitespace.

New in version 3.6.

set_organization(organization)¶

Parameters:: organization (str or None) – the sender’s organization, or None

Sets the sender’s organization for this identity.

The internal copy of organization is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

set_reply_to(reply_to)¶

Parameters:: reply_to (str or None) – the sender’s reply-to address, or None

Sets the email address for this identity to which recipients should send replies.

The internal copy of reply_to is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

set_signature_uid(signature_uid)¶

Parameters:: signature_uid (str or None) – the sender’s signature ID, or None

Sets the EDataServer.Source :uid of an EDataServer.Source describing a mail signature.

If the user does not want to use a signature for this identity, the convention is to set the EDataServer.SourceMailIdentity :signature-uid property to “none”. In keeping with that convention, the property will be set to “none” if signature_uid is None or an empty string.

New in version 3.6.

Property Details¶

EDataServer.SourceMailIdentity.props.address¶

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

Sender’s email address

EDataServer.SourceMailIdentity.props.aliases¶

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

Sender’s email address aliases

EDataServer.SourceMailIdentity.props.name¶

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

Sender’s name

EDataServer.SourceMailIdentity.props.organization¶

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

Sender’s organization

EDataServer.SourceMailIdentity.props.reply_to¶

Name:: reply-to
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Sender’s reply-to address

EDataServer.SourceMailIdentity.props.signature_uid¶

Name:: signature-uid
Type:: str
Default Value:: 'none'
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

EDataServer.Source UID of the sender’s signature