EDataServer.SourceMailComposition¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
---|---|---|---|
[ |
r/w/c/en |
Recipients to blind carbon-copy |
|
[ |
r/w/c/en |
Recipients to carbon-copy |
|
r/w/c/en |
Preferred folder for draft messages |
||
r/w/c/en |
Preferred language |
||
r/w/c/en |
What reply style to prefer |
||
r/w/c/en |
Include iMIP messages when signing |
||
r/w/c/en |
Whether start at bottom on reply or forward |
||
r/w/c/en |
Preferred folder for message templates |
||
r/w/c/en |
Whether place signature at the top on reply or forward |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class EDataServer.SourceMailComposition(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Contains only private data that should be read and manipulated using the functions below.
New 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.New 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.New in version 3.6.
- dup_drafts_folder()¶
- Returns:
a newly-allocated copy of
EDataServer.SourceMailComposition
:drafts-folder
- Return type:
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.New in version 3.6.
- dup_language()¶
- Returns:
a newly-allocated copy of
EDataServer.SourceMailComposition
:language
- Return type:
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.New in version 3.32.
- dup_templates_folder()¶
- Returns:
a newly-allocated copy of
EDataServer.SourceMailComposition
:templates-folder
- Return type:
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.New in version 3.6.
- get_bcc()¶
-
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.New in version 3.6.
- get_cc()¶
-
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.New in version 3.6.
- get_drafts_folder()¶
-
Returns a string identifying the preferred folder for draft messages. The format of the identifier string is defined by the client application.
New in version 3.6.
- get_language()¶
-
Returns a string identifying the preferred language, like “en_US”.
New in version 3.32.
- get_reply_style()¶
- Returns:
reply style preference
- Return type:
Returns preferred reply style to be used when replying using the associated account. If no preference is set, the
EDataServer.SourceMailCompositionReplyStyle.DEFAULT
is returned.New in version 3.20.
- get_sign_imip()¶
- Returns:
whether outgoing iMIP messages should be signed
- Return type:
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.
New in version 3.6.
- get_start_bottom()¶
- Returns:
start bottom on reply or forward preference
- Return type:
Returns whether start at bottom when replying or forwarding using the associated account. If no preference is set, the
EDataServer.ThreeState.INCONSISTENT
is returned.New in version 3.26.
- get_templates_folder()¶
-
Returns a string identifying the preferred folder for message templates. The format of the identifier string is defined by the client application.
New in version 3.6.
- get_top_signature()¶
- Returns:
top signature on reply or forward preference
- Return type:
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.New in version 3.26.
- set_bcc(bcc)¶
-
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>”.
New in version 3.6.
- set_cc(cc)¶
-
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>”.
New in version 3.6.
- set_drafts_folder(drafts_folder)¶
-
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.New in version 3.6.
- set_language(language)¶
-
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.New in version 3.32.
- set_reply_style(reply_style)¶
- Parameters:
reply_style (
EDataServer.SourceMailCompositionReplyStyle
) – anEDataServer.SourceMailCompositionReplyStyle
Sets preferred reply style to be used when replying using the associated account. To unset the preference, use the
EDataServer.SourceMailCompositionReplyStyle.DEFAULT
.New 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.
New in version 3.6.
- set_start_bottom(start_bottom)¶
- Parameters:
start_bottom (
EDataServer.ThreeState
) – anEDataServer.ThreeState
Sets whether start bottom when replying or forwarding using the associated account. To unset the preference, use the
EDataServer.ThreeState.INCONSISTENT
.New in version 3.26.
- set_templates_folder(templates_folder)¶
- Parameters:
templates_folder (
str
orNone
) – an identifier for the preferred templates folder, orNone
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.New in version 3.6.
- set_top_signature(top_signature)¶
- Parameters:
top_signature (
EDataServer.ThreeState
) – anEDataServer.ThreeState
Sets whether place signature at top when replying or forwarding using the associated account. To unset the preference, use the
EDataServer.ThreeState.INCONSISTENT
.New in version 3.26.
Property Details¶
- EDataServer.SourceMailComposition.props.bcc¶
- Name:
bcc
- Type:
[
str
]- Default Value:
[]
- Flags:
Recipients to blind carbon-copy
- EDataServer.SourceMailComposition.props.cc¶
- Name:
cc
- Type:
[
str
]- Default Value:
[]
- Flags:
Recipients to carbon-copy
- EDataServer.SourceMailComposition.props.drafts_folder¶
- Name:
drafts-folder
- Type:
- Default Value:
- Flags:
Preferred folder for draft messages
- EDataServer.SourceMailComposition.props.language¶
-
Preferred language
- EDataServer.SourceMailComposition.props.reply_style¶
- Name:
reply-style
- Type:
- Default Value:
- Flags:
What reply style to prefer
- EDataServer.SourceMailComposition.props.sign_imip¶
- Name:
sign-imip
- Type:
- Default Value:
- Flags:
Include iMIP messages when signing
- EDataServer.SourceMailComposition.props.start_bottom¶
- Name:
start-bottom
- Type:
- Default Value:
- Flags:
Whether start at bottom on reply or forward
- EDataServer.SourceMailComposition.props.templates_folder¶
- Name:
templates-folder
- Type:
- Default Value:
- Flags:
Preferred folder for message templates
- EDataServer.SourceMailComposition.props.top_signature¶
- Name:
top-signature
- Type:
- Default Value:
- Flags:
Whether place signature at the top on reply or forward