documenting two functions

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@9257 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/functions/imap_asearch.php b/functions/imap_asearch.php
index dd4177ee4451ca1611b83877257e97a47709113d..12269e04e34cd742858d945f31072e39c93a1594 100644 (file)
--- 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 606c99c15de6f490e45d3455fca78ed516f944a4..92b96a9f115e447a7c920e755810150407638dfd 100755 (executable)
--- 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'),