From 4d7369b0a5abbe5eebdb60d048197cfad6a075ac Mon Sep 17 00:00:00 2001 From: tokul Date: Wed, 13 Apr 2005 13:24:06 +0000 Subject: [PATCH] documenting two functions git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@9257 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- functions/imap_asearch.php | 1 + functions/imap_messages.php | 14 +++++++++----- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/functions/imap_asearch.php b/functions/imap_asearch.php index dd4177ee..12269e04 100644 --- a/functions/imap_asearch.php +++ b/functions/imap_asearch.php @@ -338,6 +338,7 @@ function sqimap_array_merge_unique(&$to, $from) * @param string $search_string the full search expression eg "ALL RECENT" * @param string $search_charset charset to use or zls ('') * @return array an IDs or UIDs array of matching messages or an empty array +* @since 1.5.0 */ function sqimap_run_search($imapConnection, $search_string, $search_charset) { diff --git a/functions/imap_messages.php b/functions/imap_messages.php index 606c99c1..92b96a9f 100755 --- a/functions/imap_messages.php +++ b/functions/imap_messages.php @@ -580,11 +580,15 @@ function parseArray($read,&$i) { /** * Retrieves a list with headers, flags, size or internaldate from the imap server - * @param resource $imap_stream imap connection - * @param array $msg_list array with id's to create a msgs set from - * @param array $aHeaderFields requested header fields - * @param array $aFetchItems requested other fetch items like FLAGS, RFC822.SIZE - * @return array $aMessages associative array with messages. Key is the UID, value is an associative array + * + * WARNING: function is not portable between SquirrelMail 1.2.x, 1.4.x and 1.5.x. + * Output format, third argument and $msg_list array format requirements differ. + * @param stream $imap_stream imap connection + * @param array $msg_list array with id's to create a msgs set from + * @param array $aHeaderFields (since 1.5.0) requested header fields + * @param array $aFetchItems (since 1.5.0) requested other fetch items like FLAGS, RFC822.SIZE + * @return array $aMessages (since 1.5.0) associative array with messages. Key is the UID, value is an associative array + * @since 1.1.3 */ function sqimap_get_small_header_list($imap_stream, $msg_list, $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Importance', 'Priority', 'Content-Type'), -- 2.25.1