1 /* Copyright (c) 2006, 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.
31 /* modest-text-utils.h */
33 #ifndef __MODEST_TEXT_UTILS_H__
34 #define __MODEST_TEXT_UTILS_H__
39 * modest_text_utils_derived_subject:
40 * @subject: a string which contains the original subject
41 * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:')
43 * create a 'derived' subject line for eg. replies and forwards
45 * Returns: a newly allocated string containing the resulting subject
47 gchar* modest_text_utils_derived_subject (const gchar *subject,
52 * modest_text_utils_quote:
53 * @buf: a string which contains the message to quote
54 * @from: the sender of the original message
55 * @sent_date: sent date/time of the original message
56 * @limit: specifies the maximum characters per line in the quoted text
58 * quote an existing message
60 * Returns: a newly allocated string containing the quoted message
62 gchar* modest_text_utils_quote (const gchar *text,
63 const gchar *content_type,
65 const time_t sent_date,
70 * modest_text_utils_cited_text:
71 * @from: sender of the message
72 * @sent_date: the sent date of the original message
73 * @text: the text of the original message
75 * cite the text in a message
77 * Returns: a newly allocated string containing the cited text
79 gchar* modest_text_utils_cite (const gchar *text,
80 const gchar *content_type,
85 * modest_text_utils_inlined_text
86 * @from: the sender of the original message
87 * @sent_date: sent date/time of the original message
88 * @to: sent date/time of the original message
89 * @subject: sent date/time of the original message
90 * @text: sent date/time of the original message
92 * creates a new string with the "Original message" text prepended to
93 * the text passed as argument and some data of the header
95 * Returns: a newly allocated string containing the quoted message
97 gchar* modest_text_utils_inline (const gchar *text,
98 const gchar *content_type,
102 const gchar *subject);
105 * modest_text_utils_remove_address
106 * @address_list: string with a comma-separated list of email addresses
107 * @address: an specific e-mail address
109 * remove a specific address from a list of email addresses
111 * Returns: a newly allocated string containing the new list
113 gchar* modest_text_utils_remove_address (const gchar *address_list,
114 const gchar *address);
117 * modest_text_utils_convert_to_html:
118 * @txt: a string which contains the message to quote
120 * convert plain text (utf8) into html
122 * Returns: a newly allocated string containing the html
124 gchar* modest_text_utils_convert_to_html (const gchar *data);
128 * modest_text_utils_strftime:
134 * this is just an alias for strftime(3), so we can use that without
135 * getting warning from gcc
137 * Returns: a formatted string of max length @max in @s
139 size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, const struct tm *tm);
144 * modest_text_utils_display_addres:
145 * @address: original address (UTF8 string)
147 * make a 'display address' from an address:
148 * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
149 * the change is in-place
151 * Returns: the new address. The string is *not* newly allocated.
152 * NULL in case of error
154 gchar* modest_text_utils_display_address (gchar *address);
157 #endif /* __MODEST_TEXT_UTILS_H__ */