aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-folder.c
diff options
context:
space:
mode:
Diffstat (limited to 'camel/camel-folder.c')
-rw-r--r--camel/camel-folder.c17
1 files changed, 14 insertions, 3 deletions
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index 6fda77d5d1..a5ccc24070 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -842,9 +842,20 @@ search_by_expression (CamelFolder *folder, const char *expression,
return NULL;
}
-GList *camel_folder_search_by_expression (CamelFolder *folder,
- const char *expression,
- CamelException *ex)
+/**
+ * camel_folder_search_by_expression:
+ * @folder: Folder object
+ * @expression: a search expression
+ * @ex: a CamelException
+ *
+ * Searches the folder for messages matching the given search expression.
+ *
+ * Return value: a list of uids of matching messages. The caller must
+ * free the list and each of the elements when it is done.
+ **/
+GList *
+camel_folder_search_by_expression (CamelFolder *folder, const char *expression,
+ CamelException *ex)
{
g_return_val_if_fail (CAMEL_IS_FOLDER (folder), NULL);
g_return_val_if_fail (folder->has_search_capability, NULL);