From dc1bca241f3d0bd4b02353894825b6ac994ea0cf Mon Sep 17 00:00:00 2001 From: Brian White Date: Wed, 10 Oct 2012 05:36:56 -0400 Subject: [PATCH] Improve sort() documentation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3947ddf..f815e94 100644 --- a/README.md +++ b/README.md @@ -636,7 +636,7 @@ Extensions Supported * Additional ImapConnection functions - * **sort**(<_array_>sortCriteria, <_array_>searchCriteria, <_function_>callback) - _(void)_ - Performs a sorted search(). Valid sortCriteria are (reverse sorting of individual criteria is done by prefixing the criteria with '-'): + * **sort**(<_array_>sortCriteria, <_array_>searchCriteria, <_function_>callback) - _(void)_ - Performs a sorted search(). A seqno-based counterpart exists for this function. The callback has two parameters: the error (falsey if none), and an array containing the message UIDs matching the search criteria. Valid sortCriteria are (reverse sorting of individual criteria is done by prefixing the criteria with '-'): * ARRIVAL - Internal date and time of the message. This differs from the ON criteria in search(), which uses just the internal date.