Top |
Functions
Properties
gboolean | busy | Read |
EHTMLEditor * | editor | Read / Write / Construct Only |
EFocusTracker * | focus-tracker | Read |
EShell * | shell | Read / Write / Construct Only |
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkWindow ╰── EMsgComposer
Functions
e_msg_composer_new ()
void e_msg_composer_new (EShell *shell
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously creates an EMsgComposer. The operation is finished
with e_msg_composer_new_finish()
called from within the callback
.
Parameters
shell |
an EShell |
|
callback |
called when the composer is ready |
|
user_data |
user data passed to |
Since: 3.22
e_msg_composer_new_finish ()
EMsgComposer * e_msg_composer_new_finish (GAsyncResult *result
,GError **error
);
Finishes call of e_msg_composer_new()
.
Parameters
result |
a GAsyncResult provided by the callback from |
|
error |
optional GError for errors |
Since: 3.22
e_msg_composer_setup_with_message ()
void e_msg_composer_setup_with_message (EMsgComposer *composer
,CamelMimeMessage *message
,gboolean keep_signature
,const gchar *override_identity_uid
,GCancellable *cancellable
);
Sets up the message composer
with a specific message
.
Note: Designed to work only for messages constructed using Evolution.
Parameters
composer |
an EMsgComposer |
|
message |
The message to use as the source |
|
keep_signature |
Keep message signature, if any |
|
override_identity_uid |
Optional identity UID to use, or |
[allow none] |
cancellable |
optional GCancellable object, or |
Since: 3.22
e_msg_composer_setup_from_url ()
void e_msg_composer_setup_from_url (EMsgComposer *composer
,const gchar *url
);
Sets up the message composer
content as defined by the provided URL.
Since: 3.22
e_msg_composer_setup_redirect ()
void e_msg_composer_setup_redirect (EMsgComposer *composer
,CamelMimeMessage *message
,const gchar *identity_uid
,GCancellable *cancellable
);
Sets up the message composer
as a redirect of the message
.
Parameters
composer |
an EMsgComposer |
|
message |
The message to use as the source |
|
identity_uid |
an identity UID to use, if any. |
[nullable] |
cancellable |
an optional GCancellable |
Since: 3.22
e_msg_composer_get_editor ()
EHTMLEditor *
e_msg_composer_get_editor (EMsgComposer *composer
);
Returns composer
's internal EHTMLEditor instance.
e_msg_composer_get_focus_tracker ()
EFocusTracker *
e_msg_composer_get_focus_tracker (EMsgComposer *composer
);
e_msg_composer_ref_session ()
CamelSession *
e_msg_composer_ref_session (EMsgComposer *composer
);
Returns the mail module's global CamelSession instance. Calling this function will load the mail module if it isn't already loaded.
The returned CamelSession is referenced for thread-safety and must
be unreferenced with g_object_unref()
when finished with it.
e_msg_composer_get_shell ()
EShell *
e_msg_composer_get_shell (EMsgComposer *composer
);
Returns the EShell that was passed to e_msg_composer_new()
.
e_msg_composer_send ()
void
e_msg_composer_send (EMsgComposer *composer
);
Send the message in composer
.
e_msg_composer_save_to_drafts ()
void
e_msg_composer_save_to_drafts (EMsgComposer *composer
);
Save the message in composer
to the selected account's Drafts folder.
e_msg_composer_save_to_outbox ()
void
e_msg_composer_save_to_outbox (EMsgComposer *composer
);
Save the message in composer
to the local Outbox folder.
e_msg_composer_print ()
void e_msg_composer_print (EMsgComposer *composer
,GtkPrintOperationAction print_action
);
Print the message in composer
.
e_msg_composer_set_body_text ()
void e_msg_composer_set_body_text (EMsgComposer *composer
,const gchar *text
,gboolean update_signature
);
Loads the given HTML text into the editor.
e_msg_composer_set_body ()
void e_msg_composer_set_body (EMsgComposer *composer
,const gchar *body
,const gchar *mime_type
);
Loads the given data into the composer as the message body.
e_msg_composer_add_header ()
void e_msg_composer_add_header (EMsgComposer *composer
,const gchar *name
,const gchar *value
);
Adds a new custom header created from name
and value
. The header
is not shown in the user interface but will be added to the resulting
MIME message when sending or saving.
e_msg_composer_set_header ()
void e_msg_composer_set_header (EMsgComposer *composer
,const gchar *name
,const gchar *value
);
Replaces all custom headers matching name
that were added with
e_msg_composer_add_header()
or e_msg_composer_set_header()
, with
a new custom header created from name
and value
. The header is
not shown in the user interface but will be added to the resulting
MIME message when sending or saving.
e_msg_composer_get_header ()
const gchar * e_msg_composer_get_header (EMsgComposer *composer
,const gchar *name
,gint index
);
Returns header value of the header named name
previously added
by e_msg_composer_add_header()
or set by e_msg_composer_set_header()
.
The index
is which header index to return. Returns NULL
on error
or when the given index of the header couldn't be found.
Since: 3.20
e_msg_composer_remove_header ()
void e_msg_composer_remove_header (EMsgComposer *composer
,const gchar *name
);
Removes all custom headers matching name
that were added with
e_msg_composer_add_header()
or e_msg_composer_set_header()
.
e_msg_composer_set_draft_headers ()
void e_msg_composer_set_draft_headers (EMsgComposer *composer
,const gchar *folder_uri
,const gchar *message_uid
);
Add special X-Evolution-Draft headers to remember the most recently saved draft message, even across Evolution sessions. These headers can be used to mark the draft message for deletion after saving a newer draft or sending the composed message.
Parameters
composer |
an EMsgComposer |
|
folder_uri |
folder URI of the last saved draft |
|
message_uid |
message UID of the last saved draft |
e_msg_composer_set_source_headers ()
void e_msg_composer_set_source_headers (EMsgComposer *composer
,const gchar *folder_uri
,const gchar *message_uid
,CamelMessageFlags flags
);
Add special X-Evolution-Source headers to remember the message being forwarded or replied to, even across Evolution sessions. These headers can be used to set appropriate flags on the source message after sending the composed message.
Parameters
composer |
an EMsgComposer |
|
folder_uri |
folder URI of the source message |
|
message_uid |
message UID of the source message |
|
flags |
flags to set on the source message after sending |
e_msg_composer_attach ()
void e_msg_composer_attach (EMsgComposer *composer
,CamelMimePart *mime_part
);
Attaches attachment
to the message being composed in the composer.
e_msg_composer_get_message ()
void e_msg_composer_get_message (EMsgComposer *composer
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Retrieve the message edited by the user as a CamelMimeMessage. The CamelMimeMessage object is created on the fly; subsequent calls to this function will always create new objects from scratch.
e_msg_composer_get_message_finish ()
CamelMimeMessage * e_msg_composer_get_message_finish (EMsgComposer *composer
,GAsyncResult *result
,GError **error
);
e_msg_composer_get_message_print ()
void e_msg_composer_get_message_print (EMsgComposer *composer
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
e_msg_composer_get_message_print_finish ()
CamelMimeMessage * e_msg_composer_get_message_print_finish (EMsgComposer *composer
,GAsyncResult *result
,GError **error
);
e_msg_composer_get_message_draft ()
void e_msg_composer_get_message_draft (EMsgComposer *composer
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
e_msg_composer_get_message_draft_finish ()
CamelMimeMessage * e_msg_composer_get_message_draft_finish (EMsgComposer *composer
,GAsyncResult *result
,GError **error
);
e_msg_composer_get_reply_to ()
CamelInternetAddress *
e_msg_composer_get_reply_to (EMsgComposer *composer
);
e_msg_composer_add_message_attachments ()
void e_msg_composer_add_message_attachments (EMsgComposer *composer
,CamelMimeMessage *message
,gboolean just_inlines
);
Walk through all the mime parts in message
and add them to the composer
specified in composer
.
e_msg_composer_can_close ()
gboolean e_msg_composer_can_close (EMsgComposer *composer
,gboolean can_save_draft
);
e_msg_composer_get_header_table ()
EComposerHeaderTable *
e_msg_composer_get_header_table (EMsgComposer *composer
);
e_msg_composer_get_attachment_view ()
EAttachmentView *
e_msg_composer_get_attachment_view (EMsgComposer *composer
);
e_msg_composer_get_raw_message_text_without_signature ()
GByteArray *
e_msg_composer_get_raw_message_text_without_signature
(EMsgComposer *composer
);
Returns the text/plain of the message from composer without signature
e_msg_composer_get_raw_message_text ()
GByteArray *
e_msg_composer_get_raw_message_text (EMsgComposer *composer
);
Returns the text/plain of the message from composer
e_msg_composer_save_focused_widget ()
void
e_msg_composer_save_focused_widget (EMsgComposer *composer
);
e_msg_composer_restore_focus_on_composer ()
void
e_msg_composer_restore_focus_on_composer
(EMsgComposer *composer
);
e_msg_composer_is_busy ()
gboolean
e_msg_composer_is_busy (EMsgComposer *composer
);
Returns TRUE
only while an EActivity is in progress.
Property Details
The “busy”
property
“busy” gboolean
Whether an activity is in progress.
Flags: Read
Default value: FALSE
Signal Details
The “presend”
signal
gboolean user_function (EMsgComposer *emsgcomposer, gpointer user_data)
Flags: Run Last
The “print”
signal
void user_function (EMsgComposer *emsgcomposer, GtkPrintOperationAction arg1, CamelMimeMessage *arg2, EActivity *arg3, gpointer user_data)
Flags: Run Last
The “save-to-drafts”
signal
void user_function (EMsgComposer *emsgcomposer, CamelMimeMessage *arg1, EActivity *arg2, gpointer user_data)
Flags: Run Last
The “save-to-outbox”
signal
void user_function (EMsgComposer *emsgcomposer, CamelMimeMessage *arg1, EActivity *arg2, gpointer user_data)
Flags: Run Last
The “send”
signal
void user_function (EMsgComposer *emsgcomposer, CamelMimeMessage *arg1, EActivity *arg2, gpointer user_data)
Flags: Run Last