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__
40 * modest_text_utils_derived_subject:
41 * @subject: a string which contains the original subject
42 * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:'),
45 * create a 'derived' subject line for eg. replies and forwards
47 * Returns: a newly allocated string containing the resulting subject
48 * subject == NULL, then @prefix " " will be returned
50 gchar* modest_text_utils_derived_subject (const gchar *subject,
55 * modest_text_utils_quote:
56 * @text: a non-NULL string which contains the message to quote
57 * @from: a non-NULL sender of the original message
58 * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
59 * @sent_date: sent date/time of the original message
60 * @limit: specifies the maximum characters per line in the quoted text
62 * quote an existing message
64 * Returns: a newly allocated string containing the quoted message
66 gchar* modest_text_utils_quote (const gchar *text,
67 const gchar *content_type,
69 const time_t sent_date,
74 * modest_text_utils_cited_text:
75 * @from: sender of the message
76 * @sent_date: the sent date of the original message
77 * @text: the text of the original message
79 * cite the text in a message
81 * Returns: a newly allocated string containing the cited text
83 gchar* modest_text_utils_cite (const gchar *text,
84 const gchar *content_type,
89 * modest_text_utils_inlined_text
90 * @from: the non-NULL sender of the original message
91 * @sent_date: sent date/time of the original message
96 * creates a new string with the "Original message" text prepended to
97 * the text passed as argument and some data of the header
99 * Returns: a newly allocated string containing the quoted message
101 gchar* modest_text_utils_inline (const gchar *text,
102 const gchar *content_type,
106 const gchar *subject);
109 * modest_text_utils_remove_address
110 * @address_list: none-NULL string with a comma-separated list of email addresses
111 * @address: an specific e-mail address
113 * remove a specific address from a list of email addresses; if @address
114 * is NULL, returns an unchanged @address_list
116 * Returns: a newly allocated string containing the new list, or NULL
117 * in case of error or the original @address_list was NULL
119 gchar* modest_text_utils_remove_address (const gchar *address_list,
120 const gchar *address);
123 * modest_text_utils_convert_to_html:
124 * @txt: a string which contains the message to quote
126 * convert plain text (utf8) into html
128 * Returns: a newly allocated string containing the html
130 gchar* modest_text_utils_convert_to_html (const gchar *txt);
134 * modest_text_utils_strftime:
140 * this is just an alias for strftime(3), so we can use that without
141 * getting warning from gcc
143 * Returns: a formatted string of max length @max in @s
145 size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, const struct tm *tm);
150 * modest_text_utils_get_display_addres:
151 * @address: original address (UTF8 string)
153 * make a 'display address' from an address:
154 * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
155 * ie. removes "<...>" and "(...)" parts
156 * the change is in-place; removes leading/trailing whitespace
158 * Returns: the new address. The string is *not* newly allocated.
159 * NULL in case of error
161 gchar* modest_text_utils_get_display_address (gchar *address);
165 * modest_text_utils_get_subject_prefix_len:
166 * @subject: original subject (UTF8 string)
168 * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address
170 * Returns: the length of the prefix, or 0 if there is none
172 gint modest_text_utils_get_subject_prefix_len (const gchar *subject);
176 * modest_text_utils_utf8_strcmp:
177 * @s1: the first string
178 * @s2: the second string
179 * @insensitive: should the comparison be case-insensitive?
181 * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison
183 * Returns: an integer less than, equal to, or greater than zero if s1 is found,
184 * respectively, to be less than, to match, or be greater than s2.
186 gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive);
191 * modest_text_utils_get_display_date:
192 * @date: the date to display
194 * get a string representation for a date.
197 * Returns: the new display date. The string is *not* newly allocated,
198 * but is a static buffer (for optimization reasons). Therefore, when
199 * you call this function, you will loose the data.
201 const gchar* modest_text_utils_get_display_date (time_t date);
205 * modest_text_utils_validate_email_address:
206 * @email_address: a string
208 * validates the email address passed as argument
210 * Returns: TRUE if the address is valid, FALSE otherwise
212 gboolean modest_text_utils_validate_email_address (const gchar *email_address);
214 #endif /* __MODEST_TEXT_UTILS_H__ */