EDataServer.SourceMailAccount¶

Subclasses:: None

Methods¶

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

	`dup_archive_folder` ()
	`dup_identity_uid` ()
	`get_archive_folder` ()
	`get_builtin` ()
	`get_identity_uid` ()
	`get_mark_seen` ()
	`get_mark_seen_timeout` ()
	`get_needs_initial_setup` ()
	`set_archive_folder` (archive_folder)
	`set_builtin` (builtin)
	`set_identity_uid` (identity_uid)
	`set_mark_seen` (mark_seen)
	`set_mark_seen_timeout` (timeout)
	`set_needs_initial_setup` (needs_initial_setup)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: EDataServer.SourceBackend (1), EDataServer.SourceExtension (1)

Name	Type	Flags	Short Description
`archive-folder`	`str`	r/w/c/en	Folder to Archive messages in
`builtin`	`bool`	r/w/c/en	Whether the account is builtin
`identity-uid`	`str`	r/w/c/en	`EDataServer.Source` UID of a Mail Identity
`mark-seen`	`EDataServer.ThreeState`	r/w/c/en	Three-state option for Mark messages as read after N seconds
`mark-seen-timeout`	`int`	r/w/c/en	Timeout in milliseconds for Mark messages as read after N seconds
`needs-initial-setup`	`bool`	r/w/c/en	Whether the account needs to do an initial setup

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`EDataServer.SourceBackend`	r

Class Details¶

class EDataServer.SourceMailAccount(**kwargs)¶

Bases:: EDataServer.SourceBackend
Abstract:: No
Structure:: EDataServer.SourceMailAccountClass

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

New in version 3.6.

dup_archive_folder()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailAccount :archive-folder
Return type:: str or None

Thread-safe variation of EDataServer.SourceMailAccount.get_archive_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.16.

dup_identity_uid()¶

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

Thread-safe variation of EDataServer.SourceMailAccount.get_identity_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_archive_folder()¶

Returns:: an identifier of the archive folder
Return type:: str or None

Returns a string identifying the archive folder. The format of the identifier string is defined by the client application.

New in version 3.16.

get_builtin()¶

Returns:: True, when the account is a builtin account
Return type:: bool

Returns whether the mail account is a builtin account. The builtin account cannot be created by a user. The default value is False.

New in version 3.46.

get_identity_uid()¶

Returns:: the mail identity EDataServer.Source :uid
Return type:: str or None

Returns the EDataServer.Source :uid of the EDataServer.Source that describes the mail identity to be used for this account.

New in version 3.6.

get_mark_seen()¶

Returns:: an EDataServer.ThreeState, whether messages in this account should be marked as seen automatically.
Return type:: EDataServer.ThreeState

New in version 3.32.

get_mark_seen_timeout()¶

Returns:: timeout in milliseconds for marking messages as seen in this account
Return type:: int

New in version 3.32.

get_needs_initial_setup()¶

Returns:: True, when the account needs to run its initial setup
Return type:: bool

Check whether the mail account needs to do its initial setup.

New in version 3.20.

set_archive_folder(archive_folder)¶

Parameters:: archive_folder (str or None) – an identifier for the archive folder, or None

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

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

New in version 3.16.

set_builtin(builtin)¶

Parameters:: builtin (int) – value to set

Sets whether the account is a builtin account. See EDataServer.SourceMailAccount.get_builtin() for more information about what it means.

New in version 3.46.

set_identity_uid(identity_uid)¶

Parameters:: identity_uid (str or None) – the mail identity EDataServer.Source :uid, or None

Sets the EDataServer.Source :uid of the EDataServer.Source that describes the mail identity to be used for this account.

New in version 3.6.

set_mark_seen(mark_seen)¶

Parameters:: mark_seen (EDataServer.ThreeState) – an EDataServer.ThreeState as the value to set

Sets whether the messages in this account should be marked as seen automatically. An inconsistent state means to use global option.

New in version 3.32.

set_mark_seen_timeout(timeout)¶

Parameters:: timeout (int) – a timeout in milliseconds

Sets the timeout in milliseconds for marking messages as seen in this account. Whether the timeout is used depends on EDataServer.SourceMailAccount.get_mark_seen().

New in version 3.32.

set_needs_initial_setup(needs_initial_setup)¶

Parameters:: needs_initial_setup (bool) – value to set

Sets whether the account needs to run its initial setup.

New in version 3.20.

Property Details¶

EDataServer.SourceMailAccount.props.archive_folder¶

Name:: archive-folder
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Folder to Archive messages in

EDataServer.SourceMailAccount.props.builtin¶

Name:: builtin
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether the account is builtin

EDataServer.SourceMailAccount.props.identity_uid¶

Name:: identity-uid
Type:: str
Default Value:: 'self'
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

EDataServer.Source UID of a Mail Identity

EDataServer.SourceMailAccount.props.mark_seen¶

Name:: mark-seen
Type:: EDataServer.ThreeState
Default Value:: EDataServer.ThreeState.INCONSISTENT
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Three-state option for Mark messages as read after N seconds

EDataServer.SourceMailAccount.props.mark_seen_timeout¶

Name:: mark-seen-timeout
Type:: int
Default Value:: 1500
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Timeout in milliseconds for Mark messages as read after N seconds

EDataServer.SourceMailAccount.props.needs_initial_setup¶

Name:: needs-initial-setup
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether the account needs to do an initial setup