EDataServer.SourceMailComposition¶

Subclasses:: None

Methods¶

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

	`dup_bcc` ()
	`dup_cc` ()
	`dup_drafts_folder` ()
	`dup_language` ()
	`dup_templates_folder` ()
	`get_bcc` ()
	`get_cc` ()
	`get_drafts_folder` ()
	`get_language` ()
	`get_reply_style` ()
	`get_sign_imip` ()
	`get_start_bottom` ()
	`get_templates_folder` ()
	`get_top_signature` ()
	`set_bcc` (bcc)
	`set_cc` (cc)
	`set_drafts_folder` (drafts_folder)
	`set_language` (language)
	`set_reply_style` (reply_style)
	`set_sign_imip` (sign_imip)
	`set_start_bottom` (start_bottom)
	`set_templates_folder` (templates_folder)
	`set_top_signature` (top_signature)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: EDataServer.SourceExtension (1)

Name	Type	Flags	Short Description
`bcc`	[`str`]	r/w/c/en	Recipients to blind carbon-copy
`cc`	[`str`]	r/w/c/en	Recipients to carbon-copy
`drafts-folder`	`str`	r/w/c/en	Preferred folder for draft messages
`language`	`str`	r/w/c/en	Preferred language
`reply-style`	`EDataServer.SourceMailCompositionReplyStyle`	r/w/c/en	What reply style to prefer
`sign-imip`	`bool`	r/w/c/en	Include iMIP messages when signing
`start-bottom`	`EDataServer.ThreeState`	r/w/c/en	Whether start at bottom on reply or forward
`templates-folder`	`str`	r/w/c/en	Preferred folder for message templates
`top-signature`	`EDataServer.ThreeState`	r/w/c/en	Whether place signature at the top on reply or forward

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`EDataServer.SourceExtension`	r

Class Details¶

class EDataServer.SourceMailComposition(**kwargs)¶

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

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

Added in version 3.6.

dup_bcc()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailComposition :bcc
Return type:: [str]

Thread-safe variation of EDataServer.SourceMailComposition.get_bcc(). Use this function when accessing self from multiple threads.

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

Added in version 3.6.

dup_cc()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailComposition :cc
Return type:: [str]

Thread-safe variation of EDataServer.SourceMailComposition.get_cc(). Use this function when accessing self from multiple threads.

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

Added in version 3.6.

dup_drafts_folder()¶

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

Thread-safe variation of EDataServer.SourceMailComposition.get_drafts_folder(). Use this function when accessing self from multiple threads.

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

Added in version 3.6.

dup_language()¶

Returns:: a newly-allocated copy of EDataServer.SourceMailComposition :language
Return type:: str or None

Thread-safe variation of EDataServer.SourceMailComposition.get_language(). Use this function when accessing self from multiple threads.

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

Added in version 3.32.

dup_templates_folder()¶

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

Thread-safe variation of EDataServer.SourceMailComposition.get_templates_folder(). Use this function when accessing self from multiple threads.

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

Added in version 3.6.

get_bcc()¶

Returns:: a None-terminated string array of Bcc recipients
Return type:: [str]

Returns a None-terminated string array of recipients which should automatically be added to the blind carbon-copy (Bcc) list when composing a new mail message. The recipient strings should be of the form “Full Name <email-address>”. The returned array is owned by self and should not be modified or freed.

Added in version 3.6.

get_cc()¶

Returns:: a None-terminated string array of Cc recipients
Return type:: [str]

Returns a None-terminated string array of recipients which should automatically be added to the carbon-copy (Cc) list when composing a new mail message. The recipient strings should be of the form “Full Name <email-address>”. The returned array is owned by self and should not be modified or freed.

Added in version 3.6.

get_drafts_folder()¶

Returns:: an identifier for the preferred drafts folder
Return type:: str or None

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

Added in version 3.6.

get_language()¶

Returns:: an identifier for the preferred language, or None for none
Return type:: str or None

Returns a string identifying the preferred language, like “en_US”.

Added in version 3.32.

get_reply_style()¶

Returns:: reply style preference
Return type:: EDataServer.SourceMailCompositionReplyStyle

Returns preferred reply style to be used when replying using the associated account. If no preference is set, the EDataServer.SourceMailCompositionReplyStyle.DEFAULT is returned.

Added in version 3.20.

get_sign_imip()¶

Returns:: whether outgoing iMIP messages should be signed
Return type:: bool

Returns whether outgoing iMIP messages such as meeting requests should also be signed. This is primarily intended as a workaround for certain versions of Microsoft Outlook which can’t handle signed iMIP messages.

Added in version 3.6.

get_start_bottom()¶

Returns:: start bottom on reply or forward preference
Return type:: EDataServer.ThreeState

Returns whether start at bottom when replying or forwarding using the associated account. If no preference is set, the EDataServer.ThreeState.INCONSISTENT is returned.

Added in version 3.26.

get_templates_folder()¶

Returns:: an identifier for the preferred templates folder
Return type:: str or None

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

Added in version 3.6.

get_top_signature()¶

Returns:: top signature on reply or forward preference
Return type:: EDataServer.ThreeState

Returns whether place signature at top when replying or forwarding using the associated account. If no preference is set, the EDataServer.ThreeState.INCONSISTENT is returned.

Added in version 3.26.

set_bcc(bcc)¶

Parameters:: bcc ([str]) – a None-terminated string array of Bcc recipients

Sets the recipients which should automatically be added to the blind carbon-copy (Bcc) list when composing a new mail message. The recipient strings should be of the form “Full Name <email-address>”.

Added in version 3.6.

set_cc(cc)¶

Parameters:: cc ([str]) – a None-terminated string array of Cc recipients

Sets the recipients which should automatically be added to the carbon copy (Cc) list when composing a new mail message. The recipient strings should be of the form “Full Name <email-address>”.

Added in version 3.6.

set_drafts_folder(drafts_folder)¶

Parameters:: drafts_folder (str or None) – an identifier for the preferred drafts folder, or None

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

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

Added in version 3.6.

set_language(language)¶

Parameters:: language (str or None) – an identifier for the preferred language, or None

Sets the preferred language by an identifier string, like “en_US”. Use None to unset any previous value.

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

Added in version 3.32.

set_reply_style(reply_style)¶

Parameters:: reply_style (EDataServer.SourceMailCompositionReplyStyle) – an EDataServer.SourceMailCompositionReplyStyle

Sets preferred reply style to be used when replying using the associated account. To unset the preference, use the EDataServer.SourceMailCompositionReplyStyle.DEFAULT.

Added in version 3.20.

set_sign_imip(sign_imip)¶

Parameters:: sign_imip (bool) – whether outgoing iMIP messages should be signed

Sets whether outgoing iMIP messages such as meeting requests should also be signed. This is primarily intended as a workaround for certain versions of Microsoft Outlook which can’t handle signed iMIP messages.

Added in version 3.6.

set_start_bottom(start_bottom)¶

Parameters:: start_bottom (EDataServer.ThreeState) – an EDataServer.ThreeState

Sets whether start bottom when replying or forwarding using the associated account. To unset the preference, use the EDataServer.ThreeState.INCONSISTENT.

Added in version 3.26.

set_templates_folder(templates_folder)¶

Parameters:: templates_folder (str or None) – an identifier for the preferred templates folder, or None

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

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

Added in version 3.6.

set_top_signature(top_signature)¶

Parameters:: top_signature (EDataServer.ThreeState) – an EDataServer.ThreeState

Sets whether place signature at top when replying or forwarding using the associated account. To unset the preference, use the EDataServer.ThreeState.INCONSISTENT.

Added in version 3.26.

Property Details¶

EDataServer.SourceMailComposition.props.bcc¶

Name:: bcc
Type:: [str]
Default Value:: []
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Recipients to blind carbon-copy

EDataServer.SourceMailComposition.props.cc¶

Name:: cc
Type:: [str]
Default Value:: []
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Recipients to carbon-copy

EDataServer.SourceMailComposition.props.drafts_folder¶

Name:: drafts-folder
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Preferred folder for draft messages

EDataServer.SourceMailComposition.props.language¶

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

Preferred language

EDataServer.SourceMailComposition.props.reply_style¶

Name:: reply-style
Type:: EDataServer.SourceMailCompositionReplyStyle
Default Value:: EDataServer.SourceMailCompositionReplyStyle.DEFAULT
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

What reply style to prefer

EDataServer.SourceMailComposition.props.sign_imip¶

Name:: sign-imip
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Include iMIP messages when signing

EDataServer.SourceMailComposition.props.start_bottom¶

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

Whether start at bottom on reply or forward

EDataServer.SourceMailComposition.props.templates_folder¶

Name:: templates-folder
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Preferred folder for message templates

EDataServer.SourceMailComposition.props.top_signature¶

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

Whether place signature at the top on reply or forward