1 /* Copyright (c) 2008, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #ifndef __MODEST_PLUGIN_UI_ACTIONS_H__
31 #define __MODEST_PLUGIN_UI_ACTIONS_H__
33 /* This should contain simple facades for internal ui actions in modest
34 * that should be available in plugins.
43 * modest_ui_actions_on_delete_account:
44 * @parent_window: the parent #GtkWindow of the dialog that will be shown
45 * @account_name: the modest name for the account to be deleted
46 * @account_display_name: the display name that will be used in the dialog
48 * This function will perform the actions required to delete an
49 * account. This function assumes that the account to be deleted is
50 * already disconnected, so the caller must verify that this is the
51 * case. Otherwise weird behaviours could happen
53 * Returns: TRUE if the account was successfully deleted, FALSE otherwise
55 gboolean modest_ui_actions_on_delete_account (GtkWindow *parent_window,
56 const gchar *account_name,
57 const gchar *account_display_name);
60 * modest_ui_actions_on_reload_message:
61 * @msg_id: a message id
63 * Reload the message if it's currently being shown in a view.
66 modest_ui_actions_on_reload_message (const gchar *msg_id);
69 * modest_ui_actions_reply_calendar:
70 * @win: parent #ModestWindow
71 * @header_pairs: #TnyList of #TnyPair of header pairs
73 * this method opens the mail composer with a reply of a message with calendar
74 * allowing to add @header_pairs with the result of the calendar request.
76 * @win should be a #ModestMsgViewWindow. We don't put the exact type to avoid
77 * exporting to plugins #ModestMsgViewWindow API
80 modest_ui_actions_reply_calendar (ModestWindow *win, TnyList *header_pairs);
83 * modest_ui_actions_reply_calendar_with_subject:
84 * @win: parent #ModestWindow
85 * @subject: a string, or %NULL to use default reply subject
86 * @header_pairs: #TnyList of #TnyPair of header pairs
88 * this method opens the mail composer with a reply of a message with calendar
89 * allowing to add @header_pairs with the result of the calendar request.
91 * @win should be a #ModestMsgViewWindow. We don't put the exact type to avoid
92 * exporting to plugins #ModestMsgViewWindow API
95 modest_ui_actions_reply_calendar_with_subject (ModestWindow *win, const gchar *custom_subject, TnyList *header_pairs);
98 * modest_ui_actions_on_send_msg:
99 * @window: parent window requesting to send the message
102 * This method will send @msg without showing the message editor.
104 * Returns: %TRUE if succesful, %FALSE otherwise
107 modest_ui_actions_on_send_msg (ModestWindow *window,
111 * modest_ui_actions_on_send_custom_msg:
112 * @account_name: the account name to use for sending
117 * @plain_body: a string with body of the message in plain text
118 * @html_body: a string with body of the message in html (or %NULL if message is only in plain text)
119 * @attachments_list: a #GList of attachments to add (#TnyMimePart)
120 * @images_list: a #GList of embedded images to add (#TnyMimePart)
121 * @references: list of messages this new message refers to
122 * @in_reply_to: a string with new in-reply-to header
123 * @priority_flags: the priority of the message as #TnyHeaderFlag mask
124 * @header_pairs: a #TnyList of #TnyPair with custom headers to add
127 modest_ui_actions_on_send_custom_msg (const gchar *account_name,
128 const gchar *from, const gchar *to, const gchar *cc, const gchar *bcc,
129 const gchar *subject,
130 const gchar *plain_body, const gchar *html_body,
131 const GList *attachments_list, const GList *images_list,
132 const gchar *references, const gchar *in_reply_to,
133 TnyHeaderFlags priority_flags, TnyList *header_pairs);
136 * modest_ui_actions_on_send_custom_msg:
137 * @transport_account: a #TnyTransportAccount
138 * @draft_msg: original draft message to delete on sending
143 * @plain_body: a string with body of the message in plain text
144 * @html_body: a string with body of the message in html (or %NULL if message is only in plain text)
145 * @attachments_list: a #GList of attachments to add (#TnyMimePart)
146 * @images_list: a #GList of embedded images to add (#TnyMimePart)
147 * @references: list of messages this new message refers to
148 * @in_reply_to: a string with new in-reply-to header
149 * @priority_flags: the priority of the message as #TnyHeaderFlag mask
150 * @header_pairs: a #TnyList of #TnyPair with custom headers to add
153 modest_ui_actions_send_msg_with_transport (TnyTransportAccount *transport_account,
155 const gchar *from, const gchar *to, const gchar *cc, const gchar *bcc,
156 const gchar *subject,
157 const gchar *plain_body, const gchar *html_body,
158 const GList *attachments_list, const GList *images_list,
159 const gchar *references, const gchar *in_reply_to,
160 TnyHeaderFlags priority_flags, TnyList *header_pairs);
163 #endif /* __MODEST_PLUGIN_UI_ACTIONS_H__ */