EDataServer.SourceMailSubmission

g EDataServer.SourceExtension EDataServer.SourceExtension EDataServer.SourceMailSubmission EDataServer.SourceMailSubmission EDataServer.SourceExtension->EDataServer.SourceMailSubmission GObject.Object GObject.Object GObject.Object->EDataServer.SourceExtension

Subclasses:

None

Methods

Inherited:

EDataServer.SourceExtension (4), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

dup_sent_folder ()

dup_transport_uid ()

get_replies_to_origin_folder ()

get_sent_folder ()

get_transport_uid ()

get_use_sent_folder ()

set_replies_to_origin_folder (replies_to_origin_folder)

set_sent_folder (sent_folder)

set_transport_uid (transport_uid)

set_use_sent_folder (use_sent_folder)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

EDataServer.SourceExtension (1)

Name

Type

Flags

Short Description

replies-to-origin-folder

bool

r/w/c/en

Whether to save replies to folder of the message being replied to, instead of the Sent folder

sent-folder

str

r/w/c/en

Preferred folder for sent messages

transport-uid

str

r/w/c/en

EDataServer.Source UID of a Mail Transport

use-sent-folder

bool

r/w/c/en

Whether to save sent messages to sent-folder

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent

EDataServer.SourceExtension

r

Class Details

class EDataServer.SourceMailSubmission(**kwargs)
Bases:

EDataServer.SourceExtension

Abstract:

No

Structure:

EDataServer.SourceMailSubmissionClass

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

New in version 3.6.

dup_sent_folder()
Returns:

a newly-allocated copy of EDataServer.SourceMailSubmission :sent-folder

Return type:

str or None

Thread-safe variation of EDataServer.SourceMailSubmission.get_sent_folder(). 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_transport_uid()
Returns:

a newly-allocated copy of EDataServer.SourceMailSubmission :transport-uid

Return type:

str or None

Thread-safe variation of EDataServer.SourceMailSubmission.get_transport_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_replies_to_origin_folder()
Returns:

whether save replies in the folder of the message being replied to

Return type:

bool

Returns whether save replies in the folder of the message being replied to, instead of the Sent folder.

New in version 3.8.

get_sent_folder()
Returns:

an identifier for the preferred sent folder

Return type:

str or None

Returns a string identifying the preferred folder for sent messages. The format of the identifier string is defined by the client application.

New in version 3.6.

get_transport_uid()
Returns:

the mail transport EDataServer.Source :uid

Return type:

str or None

Returns the EDataServer.Source :uid of the EDataServer.Source that describes the mail transport to be used for outgoing messages.

New in version 3.6.

get_use_sent_folder()
Returns:

whether save messages to the sent folder at all

Return type:

bool

New in version 3.26.

set_replies_to_origin_folder(replies_to_origin_folder)
Parameters:

replies_to_origin_folder (bool) – new value

Sets whether save replies in the folder of the message being replied to, instead of the Sent folder.

New in version 3.8.

set_sent_folder(sent_folder)
Parameters:

sent_folder (str or None) – an identifier for the preferred sent folder, or None

Sets the preferred folder for sent messages by an identifier string. The format of the identifier string is defined by the client application.

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

New in version 3.6.

set_transport_uid(transport_uid)
Parameters:

transport_uid (str or None) – the mail transport EDataServer.Source :uid, or None

Sets the EDataServer.Source :uid of the EDataServer.Source that describes the mail transport to be used for outgoing messages.

New in version 3.6.

set_use_sent_folder(use_sent_folder)
Parameters:

use_sent_folder (bool) – the value to set

Sets whether save messages to the sent folder at all.

New in version 3.26.

Property Details

EDataServer.SourceMailSubmission.props.replies_to_origin_folder
Name:

replies-to-origin-folder

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether to save replies to folder of the message being replied to, instead of the Sent folder

EDataServer.SourceMailSubmission.props.sent_folder
Name:

sent-folder

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Preferred folder for sent messages

EDataServer.SourceMailSubmission.props.transport_uid
Name:

transport-uid

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

EDataServer.Source UID of a Mail Transport

EDataServer.SourceMailSubmission.props.use_sent_folder
Name:

use-sent-folder

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether to save sent messages to sent-folder