Do ignore empty recipients when checking names
[modest] / src / modest-formatter.h
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30 #ifndef __MODEST_FORMATTER_H__
31 #define __MODEST_FORMATTER_H__
32
33 #include <tny-msg.h>
34 #include <tny-header.h>
35 #include <tny-mime-part.h>
36
37 G_BEGIN_DECLS
38
39 #define MODEST_TYPE_FORMATTER             (modest_formatter_get_type ())
40 #define MODEST_FORMATTER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), MODEST_TYPE_FORMATTER, ModestFormatter))
41 #define MODEST_FORMATTER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), MODEST_TYPE_FORMATTER, ModestFormatterClass))
42 #define MODEST_IS_FORMATTER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MODEST_TYPE_FORMATTER))
43 #define MODEST_IS_FORMATTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MODEST_TYPE_FORMATTER))
44 #define MODEST_FORMATTER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), MODEST_TYPE_FORMATTER, ModestFormatterClass))
45
46 typedef struct _ModestFormatter ModestFormatter;
47 typedef struct _ModestFormatterClass ModestFormatterClass;
48
49 struct _ModestFormatter
50 {
51         GObject parent;
52 };
53
54 struct _ModestFormatterClass 
55 {
56         GObjectClass parent;
57 };
58
59 GType modest_formatter_get_type (void);
60
61 ModestFormatter* modest_formatter_new (const gchar *content_type, const gchar *signature);
62
63 /**
64  * modest_formatter_cite:
65  * @self: a #ModestFormatter
66  * @part: a non-NULL #TnyMimePart with the body of the original message
67  * @header: a non-NULL #TnyHeader of the original message
68  * 
69  * Creates a new message with a text body made from the body of the
70  * original message cited. This function is locale-sensitive.
71  *
72  * Example of cited message:
73  * <programlisting><para>
74  * Original message
75  * ----------------
76  * Date: 1970/01/01
77  * From: somemailATmodest.org
78  * Body: "This is the body of the text"
79  * </para><para>
80  * Cited message
81  * -------------
82  * Body:
83  * On 1970/01/01 somemailATmodest.org wrote:
84  * This is the body of the text
85  * </para></programlisting>
86  *
87  * Returns: a newly formatted #TnyMsg or NULL in case of error
88  **/
89 TnyMsg * modest_formatter_cite   (ModestFormatter *self, TnyMimePart *part, TnyHeader *header);
90
91
92 /**
93  * modest_formatter_quote:
94  * @self: a #ModestFormatter
95  * @part: a non-NULL #TnyMimePart with the body of the original message
96  * @header: a non-NULL #TnyHeader of the original message
97  * @attachments: a #GList of attachments in original message
98  * 
99  * Creates a new message with a text body made from the body of the
100  * original message quoted. This function is locale-sensitive.
101  *
102  * Example of cited message:
103  * <programlisting><para>
104  * Original message
105  * ----------------
106  * Date: 1970/01/01
107  * From: somemailATmodest.org
108  * Body: "This is the body of the text"
109  * </para><para>
110  * Quoted message
111  * -------------
112  * Body:
113  * ------ Original message -----
114  * > This is the body of the text
115  * > Attachment: file1.txt
116  * </para></programlisting>
117  *
118  * Returns: a newly formatted #TnyMsg or NULL in case of error
119  **/
120 TnyMsg * modest_formatter_quote  (ModestFormatter *self, TnyMimePart *part, TnyHeader *header, GList *attachments);
121
122
123 /**
124  * modest_formatter_inline:
125  * @self: a #ModestFormatter
126  * @part: a non-NULL #TnyMimePart with the body of the original message
127  * @header: a non-NULL #TnyHeader of the original message
128  * @attachments: a #GList of attachments
129  * 
130  * Creates a new message with a text body made from the body of the
131  * original message inlined ready to be forwarded. This function is
132  * locale-sensitive.
133  *
134  * Example of cited message:
135  * <programlisting><para>
136  * Original message
137  * ----------------
138  * Date: 1970/01/01
139  * From: somemailATmodest.org
140  * To: mymailATmodest.org
141  * Subject: Mail subject
142  * Body: "This is the body of the text"
143  * </para><para>
144  * Inlined message
145  * -------------
146  * Body:
147  * -----Forwarded Message-----
148  * From: somemailATmodest.org
149  * Sent: 1970/01/01
150  * To: mymailATmodest.org
151  * Subject: Fw: Mail subject
152  * On 1970/01/01 somemailATmodest.org wrote:
153  * This is the body of the text
154  * </para></programlisting>
155  *
156  * Returns: a newly formatted #TnyMsg or NULL in case of error
157  **/
158 TnyMsg * modest_formatter_inline (ModestFormatter *self, TnyMimePart *part, TnyHeader *header, GList *attachments);
159
160 /**
161  * modest_formatter_attach:
162  * @self: a #ModestFormatter
163  * @part: a non-NULL #TnyMimePart with the body of the original message
164  * @header: a non-NULL #TnyHeader of the original message
165  * 
166  * Creates a new message with the original message as attachment
167  *
168  * Returns: a newly formatted #TnyMsg or NULL in case of error
169  **/
170 TnyMsg * modest_formatter_attach (ModestFormatter *self, TnyMsg *msg, TnyHeader *header);
171
172 /**
173  * modest_formatter_create_message:
174  * @self: a #ModestFormatter
175  * @single_body: a #gboolean
176  * @has_attachments: a #gboolean
177  * @has_images: a #gboolean
178  *
179  * Creates an empty #TnyMsg with the expected parts for Modest
180  * formatters and body embedders.
181  *
182  * If @has_attachments is %TRUE, the mail will be formatted as
183  * "multipart/mixed", and attachments will be stored as parts
184  * of it. The body will be just another multipart. If %FALSE,
185  * the bodies will be stored directly as the message.
186  *
187  * If @single_body is %TRUE, the body will be stored as a
188  * "multipart/alternative", and the parts will be the different
189  * alternatives. If %FALSE, this body will be stored directly.
190  * 
191  * If @has_images is %TRUE, the body will be embedded in a 
192  * multipart/related, that will also host attached images.
193  */
194 TnyMsg * modest_formatter_create_message (ModestFormatter *self, gboolean single_body, 
195                                           gboolean has_attachments, gboolean has_images);
196
197 /**
198  * modest_formatter_create_body_part:
199  * @self: a #ModestFormatter
200  *
201  * Obtains a new formatted body part for @msg, or
202  * @msg itself if the body is intended to be stored directly
203  * in it.
204  */ 
205 TnyMimePart * modest_formatter_create_body_part (ModestFormatter *self, TnyMsg *msg);
206
207 G_END_DECLS
208
209 #endif