![]() |
![]() |
![]() |
Evolution Mail Composer Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
struct EMsgComposer; EMsgComposer * e_msg_composer_new (EShell *shell
); EMsgComposer * e_msg_composer_new_with_message (EShell *shell
,CamelMimeMessage *message
,gboolean keep_signature
,GCancellable *cancellable
); EMsgComposer * e_msg_composer_new_from_url (EShell *shell
,const gchar *url
); EMsgComposer * e_msg_composer_new_redirect (EShell *shell
,CamelMimeMessage *message
,const gchar *identity_uid
,GCancellable *cancellable
); EFocusTracker * e_msg_composer_get_focus_tracker (EMsgComposer *composer
); CamelSession * e_msg_composer_ref_session (EMsgComposer *composer
); EShell * e_msg_composer_get_shell (EMsgComposer *composer
); void e_msg_composer_send (EMsgComposer *composer
); void e_msg_composer_save_to_drafts (EMsgComposer *composer
); void e_msg_composer_save_to_outbox (EMsgComposer *composer
); void e_msg_composer_print (EMsgComposer *composer
,GtkPrintOperationAction print_action
); void e_msg_composer_set_body_text (EMsgComposer *composer
,const gchar *text
,gboolean update_signature
); void e_msg_composer_set_body (EMsgComposer *composer
,const gchar *body
,const gchar *mime_type
); void e_msg_composer_add_header (EMsgComposer *composer
,const gchar *name
,const gchar *value
); void e_msg_composer_set_header (EMsgComposer *composer
,const gchar *name
,const gchar *value
); void e_msg_composer_remove_header (EMsgComposer *composer
,const gchar *name
); void e_msg_composer_set_draft_headers (EMsgComposer *composer
,const gchar *folder_uri
,const gchar *message_uid
); void e_msg_composer_set_source_headers (EMsgComposer *composer
,const gchar *folder_uri
,const gchar *message_uid
,CamelMessageFlags flags
); void e_msg_composer_attach (EMsgComposer *composer
,CamelMimePart *mime_part
); void e_msg_composer_get_message (EMsgComposer *composer
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); CamelMimeMessage * e_msg_composer_get_message_finish (EMsgComposer *composer
,GAsyncResult *result
,GError **error
); void e_msg_composer_get_message_print (EMsgComposer *composer
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); CamelMimeMessage * e_msg_composer_get_message_print_finish (EMsgComposer *composer
,GAsyncResult *result
,GError **error
); void e_msg_composer_get_message_draft (EMsgComposer *composer
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); CamelMimeMessage * e_msg_composer_get_message_draft_finish (EMsgComposer *composer
,GAsyncResult *result
,GError **error
); CamelInternetAddress * e_msg_composer_get_from (EMsgComposer *composer
); CamelInternetAddress * e_msg_composer_get_reply_to (EMsgComposer *composer
); void e_msg_composer_add_message_attachments (EMsgComposer *composer
,CamelMimeMessage *message
,gboolean just_inlines
); void e_msg_composer_request_close (EMsgComposer *composer
); gboolean e_msg_composer_can_close (EMsgComposer *composer
,gboolean can_save_draft
); EComposerHeaderTable * e_msg_composer_get_header_table (EMsgComposer *composer
); EAttachmentView * e_msg_composer_get_attachment_view (EMsgComposer *composer
); GByteArray * e_msg_composer_get_raw_message_text (EMsgComposer *composer
); gboolean e_msg_composer_is_exiting (EMsgComposer *composer
); void e_save_spell_languages (const GList *spell_languages
);
GObject +----GInitiallyUnowned +----GtkWidget +----GtkContainer +----GtkBin +----GtkWindow +----EMsgComposer
"busy" gboolean : Read "focus-tracker" EFocusTracker* : Read "shell" EShell* : Read / Write / Construct Only
"presend" :Run Last
"print" :Run Last
"save-to-drafts" :Run Last
"save-to-outbox" :Run Last
"send" :Run Last
EMsgComposer * e_msg_composer_new (EShell *shell
);
Create a new message composer widget.
|
an EShell |
Returns : |
A pointer to the newly created widget |
EMsgComposer * e_msg_composer_new_with_message (EShell *shell
,CamelMimeMessage *message
,gboolean keep_signature
,GCancellable *cancellable
);
Create a new message composer widget.
Note: Designed to work only for messages constructed using Evolution.
|
an EShell |
|
The message to use as the source |
|
Keep message signature, if any |
|
optional GCancellable object, or NULL
|
Returns : |
A pointer to the newly created widget |
EMsgComposer * e_msg_composer_new_from_url (EShell *shell
,const gchar *url
);
Create a new message composer widget, and fill in fields as defined by the provided URL.
|
an EShell |
|
a mailto URL |
EMsgComposer * e_msg_composer_new_redirect (EShell *shell
,CamelMimeMessage *message
,const gchar *identity_uid
,GCancellable *cancellable
);
Create a new message composer widget.
|
an EShell |
|
The message to use as the source |
Returns : |
A pointer to the newly created widget |
EFocusTracker * e_msg_composer_get_focus_tracker (EMsgComposer *composer
);
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.
|
an EMsgComposer |
Returns : |
the mail module's CamelSession |
EShell * e_msg_composer_get_shell (EMsgComposer *composer
);
Returns the EShell that was passed to e_msg_composer_new()
.
|
an EMsgComposer |
Returns : |
the EShell |
void e_msg_composer_send (EMsgComposer *composer
);
Send the message in composer
.
|
an EMsgComposer |
void e_msg_composer_save_to_drafts (EMsgComposer *composer
);
Save the message in composer
to the selected account's Drafts folder.
|
an EMsgComposer |
void e_msg_composer_save_to_outbox (EMsgComposer *composer
);
Save the message in composer
to the local Outbox folder.
|
an EMsgComposer |
void e_msg_composer_print (EMsgComposer *composer
,GtkPrintOperationAction print_action
);
Print the message in composer
.
|
an EMsgComposer |
|
the print action to start |
void e_msg_composer_set_body_text (EMsgComposer *composer
,const gchar *text
,gboolean update_signature
);
Loads the given HTML text into the editor.
|
a composer object |
|
the HTML text to initialize the editor with |
|
whether update signature in the text after setting it; Might be usually called with TRUE. |
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.
|
a composer object |
|
the data to initialize the composer with |
|
the MIME type of data |
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.
|
an EMsgComposer |
|
the header's name |
|
the header's value |
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.
|
an EMsgComposer |
|
the header's name |
|
the header's value |
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()
.
|
an EMsgComposer |
|
the header's name |
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.
|
an EMsgComposer |
|
folder URI of the last saved draft |
|
message UID of the last saved draft |
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.
|
an EMsgComposer |
|
folder URI of the source message |
|
message UID of the source message |
|
flags to set on the source message after sending |
void e_msg_composer_attach (EMsgComposer *composer
,CamelMimePart *mime_part
);
Attaches attachment
to the message being composed in the composer.
|
a composer object |
|
the CamelMimePart to attach |
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.
|
an EMsgComposer |
CamelMimeMessage * e_msg_composer_get_message_finish (EMsgComposer *composer
,GAsyncResult *result
,GError **error
);
void e_msg_composer_get_message_print (EMsgComposer *composer
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
CamelMimeMessage * e_msg_composer_get_message_print_finish (EMsgComposer *composer
,GAsyncResult *result
,GError **error
);
void e_msg_composer_get_message_draft (EMsgComposer *composer
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
CamelMimeMessage * e_msg_composer_get_message_draft_finish (EMsgComposer *composer
,GAsyncResult *result
,GError **error
);
CamelInternetAddress * e_msg_composer_get_reply_to (EMsgComposer *composer
);
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
.
|
the composer to add the attachments to. |
|
the source message to copy the attachments from. |
|
whether to attach all attachments or just add inline images. |
gboolean e_msg_composer_can_close (EMsgComposer *composer
,gboolean can_save_draft
);
EComposerHeaderTable * e_msg_composer_get_header_table (EMsgComposer *composer
);
EAttachmentView * e_msg_composer_get_attachment_view (EMsgComposer *composer
);
GByteArray * e_msg_composer_get_raw_message_text (EMsgComposer *composer
);
Returns : |
the text/plain of the message from composer |
"presend"
signalgboolean user_function (EMsgComposer *emsgcomposer,
gpointer user_data) : Run Last
"print"
signalvoid user_function (EMsgComposer *emsgcomposer,
GtkPrintOperationAction arg1,
CamelMimeMessage *arg2,
EActivity *arg3,
gpointer user_data) : Run Last
"save-to-drafts"
signalvoid user_function (EMsgComposer *emsgcomposer,
CamelMimeMessage *arg1,
EActivity *arg2,
gpointer user_data) : Run Last
"save-to-outbox"
signalvoid user_function (EMsgComposer *emsgcomposer,
CamelMimeMessage *arg1,
EActivity *arg2,
gpointer user_data) : Run Last
"send"
signalvoid user_function (EMsgComposer *emsgcomposer,
CamelMimeMessage *arg1,
EActivity *arg2,
gpointer user_data) : Run Last