1 /* Copyright (c) 2006, 2007, 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_TNY_MSG_H__
31 #define __MODEST_TNY_MSG_H__
34 * ModestTnyMsgForwardType:
36 * How the original message will be forwarded to the recipient
38 typedef enum _ModestTnyMsgForwardType {
39 MODEST_TNY_MSG_FORWARD_TYPE_INLINE = 1,
40 MODEST_TNY_MSG_FORWARD_TYPE_ATTACHMENT
41 } ModestTnyMsgForwardType;
44 * ModestTnyMsgReplyType:
46 * How the original message will be forwarded to the recipient
48 typedef enum _ModestTnyMsgReplyType {
49 MODEST_TNY_MSG_REPLY_TYPE_CITE = 1,
50 MODEST_TNY_MSG_REPLY_TYPE_QUOTE
51 } ModestTnyMsgReplyType;
54 * ModestTnyMsgReplyMode:
56 * Who will be the recipients of the replied message
58 typedef enum _ModestTnyMsgReplyMode {
59 MODEST_TNY_MSG_REPLY_MODE_SENDER,
60 MODEST_TNY_MSG_REPLY_MODE_LIST,
61 MODEST_TNY_MSG_REPLY_MODE_ALL
62 } ModestTnyMsgReplyMode;
66 * @mailto: recipient for the message
67 * @mailfrom: sender of this message
68 * @cc: Cc: address for the message
69 * @bcc: Bcc: address for the message
70 * @subject: subject for the messdage
71 * @body: body for the message
72 * @attachments: a list of attachments (local URIs)
73 * @attached: a #gint pointer, returns the number of attachments really included.
74 * @error: a pointer for errors in message creation
76 * create a new TnyMsg with the given parameters
78 * Returns: a new TnyMsg (free with g_object_unref)
80 TnyMsg* modest_tny_msg_new (const gchar* mailto, const gchar* mailfrom, const gchar *cc,
81 const gchar *bcc, const gchar* subject,
82 const gchar *references, const gchar *in_reply_to,
84 GList *attachments, gint *attached, GError **err);
87 * modest_tny_msg_new_html_plain:
88 * @mailto: recipient for the message
89 * @mailfrom: sender of this message
90 * @cc: Cc: address for the message
91 * @bcc: Bcc: address for the message
92 * @subject: subject for the message
93 * @html_body: body for the message in HTML
94 * @plain_body: body for the message in plain text
95 * @attachments: a list of attachments (mime parts)
96 * @images: a list of images (mime parts)
97 * @attached: a #gint pointer, returns the number of attachments really included.
98 * @error: a pointer for errors in message creation
100 * create a new TnyMsg with the given parameters
102 * Returns: a new TnyMsg (free with g_object_unref)
104 TnyMsg* modest_tny_msg_new_html_plain (const gchar* mailto, const gchar* mailfrom, const gchar *cc,
105 const gchar *bcc, const gchar* subject,
106 const gchar *references, const gchar *in_reply_to,
107 const gchar *html_body, const gchar *plain_body,
108 GList *attachments, GList *images, gint *attached, GError **err);
111 * modest_tny_msg_find_body_part:
113 * @want_html: prefer HTML-part when there are multiple body parts?
115 * search a message for the body part. if @want_html is true, try HTML mail
118 * Returns: the TnyMsgMimePart for the found part, or NULL if no matching part is found
120 TnyMimePart* modest_tny_msg_find_body_part (TnyMsg * self, gboolean want_html);
123 * modest_tny_msg_find_calendar_part:
126 * search a message for the calendar part.
128 * Returns: the TnyMimePart for the found part, or NULL if no matching part is found
130 TnyMimePart* modest_tny_msg_find_calendar (TnyMsg *self);
134 * modest_tny_msg_find_body:
135 * @self: some #TnyMsg
137 * @is_html: if the original body was html or plain text
139 * gets the body of a message as text, if @want_html is true, try HTML mail
142 * Returns: the body of the message as text, or NULL if it is not found
143 * the text should be freed with
145 gchar* modest_tny_msg_get_body (TnyMsg *self, gboolean want_html, gboolean *is_html);
151 * modest_tny_msg_create_forward_msg:
152 * @msg: a valid #TnyMsg instance
153 * @from: the sender of the forwarded mail
154 * @signature: signature to attach to the reply
155 * @forward_type: the type of formatting used to create the forwarded message
157 * Creates a forwarded message from an existing one
159 * Returns: a new #TnyMsg, or NULL in case of error
161 TnyMsg* modest_tny_msg_create_forward_msg (TnyMsg *msg,
163 const gchar *signature,
164 ModestTnyMsgForwardType forward_type);
167 * modest_tny_msg_create_reply_calendar_msg:
168 * @msg: a valid #TnyMsg instance, or %NULL
169 * @header: a valid #TnyHeader instance, or %NULL
170 * @from: the sender of the forwarded mail
171 * @signature: signature to add to the reply message
172 * @headers: #TnyList of #TnyPair with the headers to add
174 * Creates a new message to reply to a calendar event
176 * Returns: Returns: a new #TnyMsg, or NULL in case of error
178 TnyMsg* modest_tny_msg_create_reply_calendar_msg (TnyMsg *msg,
181 const gchar *signature,
185 * modest_tny_msg_create_reply_msg:
186 * @msg: a valid #TnyMsg instance, or %NULL
187 * @header: a valid #TnyHeader instance, or %NULL
188 * @from: the sender of the forwarded mail
189 * @signature: signature to add to the reply message
190 * @reply_type: the type of formatting used to create the reply message
191 * @reply_mode: the mode of reply: to the sender only, to a mail list or to all
193 * Creates a new message to reply to an existing one
195 * Returns: Returns: a new #TnyMsg, or NULL in case of error
197 TnyMsg* modest_tny_msg_create_reply_msg (TnyMsg *msg,
200 const gchar *signature,
201 ModestTnyMsgReplyType reply_type,
202 ModestTnyMsgReplyMode reply_mode);
206 * modest_tny_msg_get_parent_unique_id
207 * @msg: a valid #TnyMsg instance, or %NULL
209 * gets the unique ID of the 'parent' (the original msg replied to or forward)
211 * Returns: Returns: a the parent uid, or NULL if there is none.
213 const gchar* modest_tny_msg_get_parent_uid (TnyMsg *msg);
217 * modest_tny_msg_estimate_size:
218 * @plain_body: a string
219 * @html_body: a string
220 * @parts_number: a gint (number of additional parts)
221 * @parts_size: a guint64 (sum of size of the additional parts)
223 * Estimates the size of the resulting message obtained from the size of the body
224 * parts, and adding the estimation of size headers.
227 modest_tny_msg_estimate_size (const gchar *plain_body, const gchar *html_body,
232 * modest_tny_msg_get_all_recipients_list:
233 * @header: a #TnyHeader
235 * Obtains a list of all the addresses available in @header.
237 * Returns: a newly allocated #GSList of strings. Caller should free strings and list.
240 modest_tny_msg_header_get_all_recipients_list (TnyHeader *header);
243 * modest_tny_msg_get_all_recipients_list:
246 * Obtains a list of all the addresses available in a message header.
248 * Returns: a newly allocated #GSList of strings. Caller should free strings and list.
251 modest_tny_msg_get_all_recipients_list (TnyMsg *msg);
254 * modest_tny_msg_get_references:
256 * @message_id: a pointer to a string
257 * @references: a pointer to a string
258 * @in_reply_to: a pointer to a string
260 * obtains the Message-ID, References and In-Reply-To fields of a
263 void modest_tny_msg_get_references (TnyMsg *msg, gchar **message_id, gchar **references, gchar **in_reply_to);
266 * modest_tny_msg_get_attachments_parent:
269 * the mime part of the message attachments should be below
271 * Returns: the mime part (ref owned by caller)
273 TnyMimePart *modest_tny_msg_get_attachments_parent (TnyMsg *msg);
276 #endif /* __MODEST_TNY_MSG_H__ */