* make modest handle mailing lists somewhat correcter (RFC2369):
[modest] / src / modest-text-utils.h
index e11d702..7944dbe 100644 (file)
@@ -128,11 +128,11 @@ gchar*   modest_text_utils_inline (const gchar *text,
 
 /**
  * modest_text_utils_remove_address
- * @address_list: none-NULL string with a comma-separated list of email addresses
+ * @address_list: non-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; if @address
- * is NULL, returns an unchanged @address_list
+ * is NULL, returns an unchanged (but newly allocated) @address_list
  * 
  * Returns: a newly allocated string containing the new list, or NULL
  * in case of error or the original @address_list was NULL
@@ -140,9 +140,23 @@ gchar*   modest_text_utils_inline (const gchar *text,
 gchar*   modest_text_utils_remove_address (const gchar *address_list, 
                                           const gchar *address);
 
+
+/**
+ * modest_text_utils_remove_duplicate_addresses
+ * @address_list: non-NULL string with a comma-separated list of email addresses
+ *
+ * remove duplicate addresses from a list of email addresses
+ * 
+ * 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_duplicate_addresses (const gchar *address_list); 
+                                                   
+
+
 /**
  * modest_text_utils_address_range_at_position:
- * @address_list: utf8 string containing a list of addresses
+ * @address_list: non-NULL utf8 string containing a list of addresses
  * @position: a gint
  * @start: a gint pointer
  * @end: a gint pointer
@@ -153,9 +167,9 @@ gchar*   modest_text_utils_remove_address (const gchar *address_list,
  * @end
  */
 void     modest_text_utils_address_range_at_position (const gchar *recipients_list,
-                                                     gint position,
-                                                     gint *start,
-                                                     gint *end);
+                                                     guint position,
+                                                     guint *start,
+                                                     guint *end);
 
 /**
  * modest_text_utils_hyperlinkify_begin:
@@ -213,8 +227,8 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, time_t
  * @address: original address (UTF8 string)
  *
  * make a 'display address' from an address:
- * "Foo Bar <foo@bar.cx>" --> "Foo Bar"
- * ie. removes "<...>" parts
+ * "Foo Bar &lt;foo@bar.cx&gt;" --&gt; "Foo Bar"
+ * ie. removes "&lt;...&gt;" parts
  * the change is in-place; removes leading whitespace
  * 
  * NOTE: for optimization reasons, this function changes @address
@@ -352,10 +366,11 @@ gboolean     modest_text_utils_validate_recipient (const gchar *recipient,
  * obtains a GSList of addresses from a string of addresses
  * in the format understood by email protocols
  *
- * Returns: a GSList of strings
+ * Returns: a newly allocated GSList of strings
  **/
 GSList      *modest_text_utils_split_addresses_list (const gchar *addresses);
 
+
 /**
  * modest_text_utils_get_addresses_indexes:
  * @addresses: a string