* Added an email validation function

[modest] / src / modest-text-utils.h

diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h
index e07e682..e294442 100644 (file)
--- a/src/modest-text-utils.h
+++ b/src/modest-text-utils.h
@@ -53,8 +53,9 @@ gchar* modest_text_utils_derived_subject (const gchar *subject,
 
 /**
  * modest_text_utils_quote:
- * @buf: a string which contains the message to quote
- * @from: the sender of the original message
+ * @text: a non-NULL string which contains the message to quote
+ * @from: a non-NULL  sender of the original message
+ * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
  * @sent_date: sent date/time of the original message
  * @limit: specifies the maximum characters per line in the quoted text
  * 
@@ -86,11 +87,11 @@ gchar* modest_text_utils_cite (const gchar *text,
 
 /**
  * modest_text_utils_inlined_text
- * @from: the sender of the original message
+ * @from: the non-NULL sender of the original message
  * @sent_date: sent date/time of the original message
- * @to: sent date/time of the original message
- * @subject: sent date/time of the original message
- * @text: sent date/time of the original message
+ * @to: 
+ * @subject: 
+ * @text: 
  *
  * creates a new string with the "Original message" text prepended to
  * the text passed as argument and some data of the header
@@ -106,12 +107,14 @@ gchar*   modest_text_utils_inline (const gchar *text,
 
 /**
  * modest_text_utils_remove_address
- * @address_list: string with a comma-separated list of email addresses
- * @address: an specific e-mail address
+ * @address_list: none-NULL string with a comma-separated list of email addresses
+ * @address: an specific e-mail address 
  *
- * remove a specific address from a list of email addresses
+ * remove a specific address from a list of email addresses; if @address
+ * is NULL, returns an unchanged @address_list
  * 
- * Returns: a newly allocated string containing the new list
+ * Returns: a newly allocated string containing the new list, or NULL
+ * in case of error or the original @address_list was NULL
  */
 gchar*   modest_text_utils_remove_address (const gchar *address_list, 
                                           const gchar *address);
@@ -124,7 +127,7 @@ gchar*   modest_text_utils_remove_address (const gchar *address_list,
  * 
  * Returns: a newly allocated string containing the html
  */
-gchar*  modest_text_utils_convert_to_html (const gchar *data);
+gchar*  modest_text_utils_convert_to_html (const gchar *txt);
 
 
 /**
@@ -144,7 +147,7 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, const
 
 
 /**
- * modest_text_utils_display_addres:
+ * modest_text_utils_get_display_addres:
  * @address: original address (UTF8 string)
  *
  * make a 'display address' from an address:
@@ -155,7 +158,57 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, const
  * Returns: the new address. The string is *not* newly allocated.
  * NULL in case of error
  */
-gchar* modest_text_utils_display_address (gchar *address);
+gchar* modest_text_utils_get_display_address (gchar *address);
 
 
+/**
+ * modest_text_utils_get_subject_prefix_len:
+ * @subject: original subject (UTF8 string)
+ *
+ * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address
+ * 
+ * Returns: the length of the  prefix, or 0 if there is none
+ */
+gint modest_text_utils_get_subject_prefix_len (const gchar *subject);
+
+
+/**
+ * modest_text_utils_utf8_strcmp:
+ * @s1: the first string
+ * @s2: the second string
+ * @insensitive: should the comparison be case-insensitive?
+ *
+ * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison 
+ *
+ * Returns: an integer less than, equal to, or greater than zero if s1 is found,
+ * respectively, to be less than, to match, or be greater than s2.
+ */
+gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive);
+
+
+
+/**
+ * modest_text_utils_get_display_date:
+ * @date: the date to display
+ *
+ * get a string representation for a date.
+ * 
+ * 
+ * Returns: the new display date. The string is *not* newly allocated,
+ * but is a static buffer (for optimization reasons). Therefore, when
+ * you call this function, you will loose the data.
+ */
+const gchar* modest_text_utils_get_display_date (time_t date);
+
+
+/**
+ * modest_text_utils_validate_email_address:
+ * @email_address: a string
+ * 
+ * validates the email address passed as argument
+ * 
+ * Returns: TRUE if the address is valid, FALSE otherwise
+ **/
+gboolean     modest_text_utils_validate_email_address (const gchar *email_address);
+
 #endif /* __MODEST_TEXT_UTILS_H__ */