From: Michael M Slusarz Date: Tue, 10 Feb 2009 06:39:40 +0000 (-0700) Subject: phpdoc X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=4bcf1f0a29b5c72b01e32c99e830d6fe7d02fdb1;p=horde.git phpdoc --- diff --git a/framework/Imap_Client/lib/Horde/Imap/Client.php b/framework/Imap_Client/lib/Horde/Imap/Client.php index 09d2c60df..4c7751709 100644 --- a/framework/Imap_Client/lib/Horde/Imap/Client.php +++ b/framework/Imap_Client/lib/Horde/Imap/Client.php @@ -144,14 +144,15 @@ class Horde_Imap_Client /** * Attempts to return a concrete Horde_Imap_Client instance based on * $driver. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $driver The type of concrete Horde_Imap_Client subclass * to return. * @param array $params A hash containing any additional configuration or * connection parameters a subclass might need. * - * @return Horde_Imap_Client_Base The newly created Horde_Imap_Client instance. + * @return Horde_Imap_Client_Base The newly created Horde_Imap_Client + * instance. + * @throws Horde_Imap_Client_Exception */ static public function getInstance($driver, $params = array()) { diff --git a/framework/Imap_Client/lib/Horde/Imap/Client/Base.php b/framework/Imap_Client/lib/Horde/Imap/Client/Base.php index 5a6dfa883..aab964f5d 100644 --- a/framework/Imap_Client/lib/Horde/Imap/Client/Base.php +++ b/framework/Imap_Client/lib/Horde/Imap/Client/Base.php @@ -84,9 +84,10 @@ abstract class Horde_Imap_Client_Base /** * Constructs a new Horde_Imap_Client object. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $params A hash containing configuration parameters. + * + * @throws Horde_Imap_Client_Exception */ public function __construct($params = array()) { @@ -186,9 +187,9 @@ abstract class Horde_Imap_Client_Base /** * Initialize the Horde_Imap_Client_Cache object, if necessary. - * Throws a Horde_Imap_Client_Exception on error. * * @return boolean Returns true if caching is enabled. + * @throws Horde_Imap_Client_Exception */ protected function _initCache() { @@ -256,9 +257,9 @@ abstract class Horde_Imap_Client_Base /** * Get CAPABILITY information from the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @return array The capability array. + * @throws Horde_Imap_Client_Exception */ public function capability() { @@ -271,15 +272,16 @@ abstract class Horde_Imap_Client_Base /** * Get CAPABILITY information from the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @return array The capability array. + * @throws Horde_Imap_Client_Exception */ abstract protected function _capability(); /** * Send a NOOP command (RFC 3501 [6.1.2]). - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ public function noop() { @@ -291,13 +293,13 @@ abstract class Horde_Imap_Client_Base /** * Send a NOOP command. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ abstract protected function _noop(); /** * Get the NAMESPACE information from the IMAP server (RFC 2342). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $additional If the server supports namespaces, any * additional namespaces to add to the @@ -318,6 +320,7 @@ abstract class Horde_Imap_Client_Base * 'type' - (string) The namespace type (either 'personal', 'other' or * 'shared'). * + * @throws Horde_Imap_Client_Exception */ public function getNamespaces($additional = array()) { @@ -373,9 +376,9 @@ abstract class Horde_Imap_Client_Base /** * Get the NAMESPACE information from the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @return array An array of namespace information. + * @throws Horde_Imap_Client_Exception */ abstract protected function _getNamespaces(); @@ -399,7 +402,8 @@ abstract class Horde_Imap_Client_Base /** * Login to the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ public function login() { @@ -442,9 +446,9 @@ abstract class Horde_Imap_Client_Base /** * Login to the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @return boolean Return true if global login tasks should be run. + * @throws Horde_Imap_Client_Exception */ abstract protected function _login(); @@ -466,10 +470,11 @@ abstract class Horde_Imap_Client_Base /** * Send ID information to the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info Overrides the value of the 'id' param and sends * this information instead. + * + * @throws Horde_Imap_Client_Exception */ public function sendID($info = null) { @@ -482,18 +487,19 @@ abstract class Horde_Imap_Client_Base /** * Send ID information to the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info The information to send to the server. + * + * @throws Horde_Imap_Client_Exception */ abstract protected function _sendID($info); /** * Return ID information from the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. * * @return array An array of information returned, with the keys as the * 'field' and the values as the 'value'. + * @throws Horde_Imap_Client_Exception */ public function getID() { @@ -506,16 +512,15 @@ abstract class Horde_Imap_Client_Base /** * Return ID information from the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. * * @return array An array of information returned, with the keys as the * 'field' and the values as the 'value'. + * @throws Horde_Imap_Client_Exception */ abstract protected function _getID(); /** * Sets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info Overrides the value of the 'lang' param and sends * this list of preferred languages instead. The @@ -524,6 +529,7 @@ abstract class Horde_Imap_Client_Base * * @return string The language accepted by the server, or null if the * default language is used. + * @throws Horde_Imap_Client_Exception */ public function setLanguage($langs = null) { @@ -541,24 +547,24 @@ abstract class Horde_Imap_Client_Base /** * Sets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info The preferred list of languages. * * @return string The language accepted by the server, or null if the * default language is used. + * @throws Horde_Imap_Client_Exception */ abstract protected function _setLanguage($langs); /** * Gets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $list If true, return the list of available languages. * * @return mixed If $list is true, the list of languages available on the * server (may be empty). If false, the language used by * the server, or null if the default language is used. + * @throws Horde_Imap_Client_Exception */ public function getLanguage($list = false) { @@ -571,19 +577,18 @@ abstract class Horde_Imap_Client_Base /** * Gets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $list If true, return the list of available languages. * * @return mixed If $list is true, the list of languages available on the * server (may be empty). If false, the language used by * the server, or null if the default language is used. + * @throws Horde_Imap_Client_Exception */ abstract protected function _getLanguage($list); /** * Open a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to open. Either in UTF7-IMAP or * UTF-8. @@ -591,6 +596,8 @@ abstract class Horde_Imap_Client_Base * Horde_Imap_Client::OPEN_READONLY, * Horde_Imap_Client::OPEN_READWRITE, or * Horde_Imap_Client::OPEN_AUTO. + * + * @throws Horde_Imap_Client_Exception */ public function openMailbox($mailbox, $mode = Horde_Imap_Client::OPEN_AUTO) { @@ -618,16 +625,16 @@ abstract class Horde_Imap_Client_Base /** * Open a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to open (UTF7-IMAP). * @param integer $mode The access mode. + * + * @throws Horde_Imap_Client_Exception */ abstract protected function _openMailbox($mailbox, $mode); /** * Return the currently opened mailbox and access mode. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options: * 
@@ -637,6 +644,7 @@ abstract class Horde_Imap_Client_Base
      *
      * @return mixed  Either an array with two elements - 'mailbox' and
      *                'mode' - or null if no mailbox selected.
+     * @throws Horde_Imap_Client_Exception
      */
     public function currentMailbox($options = array())
     {
@@ -650,10 +658,11 @@ abstract class Horde_Imap_Client_Base
 
     /**
      * Create a mailbox.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $mailbox  The mailbox to create. Either in UTF7-IMAP or
      *                         UTF-8.
+     *
+     * @throws Horde_Imap_Client_Exception
      */
     public function createMailbox($mailbox)
     {
@@ -662,18 +671,20 @@ abstract class Horde_Imap_Client_Base
 
     /**
      * Create a mailbox.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $mailbox  The mailbox to create (UTF7-IMAP).
+     *
+     * @throws Horde_Imap_Client_Exception
      */
     abstract protected function _createMailbox($mailbox);
 
     /**
      * Delete a mailbox.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $mailbox  The mailbox to delete. Either in UTF7-IMAP or
      *                         UTF-8.
+     *
+     * @throws Horde_Imap_Client_Exception
      */
     public function deleteMailbox($mailbox)
     {
@@ -696,20 +707,22 @@ abstract class Horde_Imap_Client_Base
 
     /**
      * Delete a mailbox.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $mailbox  The mailbox to delete (UTF7-IMAP).
+     *
+     * @throws Horde_Imap_Client_Exception
      */
     abstract protected function _deleteMailbox($mailbox);
 
     /**
      * Rename a mailbox.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $old     The old mailbox name. Either in UTF7-IMAP or
      *                        UTF-8.
      * @param string $new     The new mailbox name. Either in UTF7-IMAP or
      *                        UTF-8.
+     *
+     * @throws Horde_Imap_Client_Exception
      */
     public function renameMailbox($old, $new)
     {
@@ -739,20 +752,22 @@ abstract class Horde_Imap_Client_Base
 
     /**
      * Rename a mailbox.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $old     The old mailbox name (UTF7-IMAP).
      * @param string $new     The new mailbox name (UTF7-IMAP).
+     *
+     * @throws Horde_Imap_Client_Exception
      */
     abstract protected function _renameMailbox($old, $new);
 
     /**
      * Manage subscription status for a mailbox.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $mailbox     The mailbox to [un]subscribe to. Either in
      *                            UTF7-IMAP or UTF-8.
      * @param boolean $subscribe  True to subscribe, false to unsubscribe.
+     *
+     * @throws Horde_Imap_Client_Exception
      */
     public function subscribeMailbox($mailbox, $subscribe = true)
     {
@@ -761,16 +776,16 @@ abstract class Horde_Imap_Client_Base
 
     /**
      * Manage subscription status for a mailbox.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $mailbox     The mailbox to [un]subscribe to (UTF7-IMAP).
      * @param boolean $subscribe  True to subscribe, false to unsubscribe.
+     *
+     * @throws Horde_Imap_Client_Exception
      */
     abstract protected function _subscribeMailbox($mailbox, $subscribe);
 
     /**
      * Obtain a list of mailboxes matching a pattern.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @todo RFC 5258 extensions
      *
@@ -807,6 +822,7 @@ abstract class Horde_Imap_Client_Base
      *                with the following keys: 'mailbox', 'attributes' (only
      *                if 'attributes' option is true), and 'delimiter' (only
      *                if 'delimiter' option is true).
+     * @throws Horde_Imap_Client_Exception
      */
     public function listMailboxes($pattern, $mode = Horde_Imap_Client::MBOX_ALL,
                                   $options = array())
@@ -822,19 +838,18 @@ abstract class Horde_Imap_Client_Base
 
     /**
      * Obtain a list of mailboxes matching a pattern.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $pattern  The mailbox search pattern (UTF7-IMAP).
      * @param integer $mode    Which mailboxes to return.
      * @param array $options   Additional options.
      *
      * @return array  See self::listMailboxes().
+     * @throws Horde_Imap_Client_Exception
      */
     abstract protected function _listMailboxes($pattern, $mode, $options);
 
     /**
      * Obtain status information for a mailbox.
-     * Throws a Horde_Imap_Client_Exception on error.
      *
      * @param string $mailbox  The mailbox to query. Either in UTF7-IMAP or
      *                         or UTF-8.
@@ -900,6 +915,7 @@ abstract class Horde_Imap_Client_Base
      *
* * @return array An array with the requested keys (see above). + * @throws Horde_Imap_Client_Exception */ public function status($mailbox, $flags = Horde_Imap_Client::STATUS_ALL) { @@ -917,19 +933,18 @@ abstract class Horde_Imap_Client_Base /** * Obtain status information for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to query (UTF7-IMAP). * @param string $flags A bitmask of information requested from the * server. * * @return array See self::status(). + * @throws Horde_Imap_Client_Exception */ abstract protected function _status($mailbox, $flags); /** * Append message(s) to a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to append the message(s) to. Either * in UTF7-IMAP or UTF-8. @@ -967,6 +982,7 @@ abstract class Horde_Imap_Client_Base * @return mixed An array of the UIDs of the appended messages (if server * supports UIDPLUS extension or 'messageid' is defined) * or true. + * @throws Horde_Imap_Client_Exception */ public function append($mailbox, $data, $options = array()) { @@ -997,7 +1013,6 @@ abstract class Horde_Imap_Client_Base /** * Append message(s) to a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to append the message(s) to * (UTF7-IMAP). @@ -1006,13 +1021,15 @@ abstract class Horde_Imap_Client_Base * * @return mixed An array of the UIDs of the appended messages (if server * supports UIDPLUS extension) or true. + * @throws Horde_Imap_Client_Exception */ abstract protected function _append($mailbox, $data, $options); /** * Request a checkpoint of the currently selected mailbox (RFC 3501 * [6.4.1]). - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ public function check() { @@ -1024,20 +1041,22 @@ abstract class Horde_Imap_Client_Base /** * Request a checkpoint of the currently selected mailbox. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ abstract protected function _check(); /** * Close the connection to the currently selected mailbox, optionally * expunging all deleted messages (RFC 3501 [6.4.2]). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options: * 
      * 'expunge' - (boolean) Expunge all messages flagged as deleted?
      *             DEFAULT: No
      *
+ * + * @throws Horde_Imap_Client_Exception */ public function close($options = array()) { @@ -1066,15 +1085,15 @@ abstract class Horde_Imap_Client_Base /** * Close the connection to the currently selected mailbox, optionally * expunging all deleted messages (RFC 3501 [6.4.2]). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ abstract protected function _close($options); /** * Expunge deleted messages from the given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to expunge. Either in UTF7-IMAP * or UTF-8. @@ -1087,6 +1106,8 @@ abstract class Horde_Imap_Client_Base * 'sequence' - (boolean) If true, 'ids' is an array of sequence numbers. * DEFAULT: 'sequence' is an array of UIDs. * + * + * @throws Horde_Imap_Client_Exception */ public function expunge($mailbox, $options = array()) { @@ -1096,15 +1117,15 @@ abstract class Horde_Imap_Client_Base /** * Expunge all deleted messages from the given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ abstract protected function _expunge($options); /** * Search a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to search. Either in UTF7-IMAP * or UTF-8. @@ -1179,6 +1200,7 @@ abstract class Horde_Imap_Client_Base * (if 'sequence' is true) that match $criteria. * Returned if 'sort' is true. * + * @throws Horde_Imap_Client_Exception */ public function search($mailbox, $query = null, $options = array()) { @@ -1230,7 +1252,6 @@ abstract class Horde_Imap_Client_Base /** * Search a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param object $query The search query. * @param array $options Additional options. The '_query' key contains @@ -1238,17 +1259,19 @@ abstract class Horde_Imap_Client_Base * * @return array An array of UIDs (default) or an array of message * sequence numbers (if 'sequence' is true). + * @throws Horde_Imap_Client_Exception */ abstract protected function _search($query, $options); /** * Set the comparator to use for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $comparator The comparator string (see RFC 4790 [3.1] - * "collation-id" - for format). The reserved * string 'default' can be used to select * the default comparator. + * + * @throws Horde_Imap_Client_Exception */ public function setComparator($comparator = null) { @@ -1267,21 +1290,22 @@ abstract class Horde_Imap_Client_Base /** * Set the comparator to use for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $comparator The comparator string (see RFC 4790 [3.1] - * "collation-id" - for format). The reserved * string 'default' can be used to select * the default comparator. + * + * @throws Horde_Imap_Client_Exception */ abstract protected function _setComparator($comparator); /** * Get the comparator used for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @return mixed Null if the default comparator is being used, or an * array of comparator information (see RFC 5255 [4.8]). + * @throws Horde_Imap_Client_Exception */ public function getComparator() { @@ -1295,16 +1319,15 @@ abstract class Horde_Imap_Client_Base /** * Get the comparator used for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @return mixed Null if the default comparator is being used, or an * array of comparator information (see RFC 5255 [4.8]). + * @throws Horde_Imap_Client_Exception */ abstract protected function _getComparator(); /** * Thread sort a given list of messages (RFC 5256). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to search. Either in UTF7-IMAP * or UTF-8. @@ -1324,6 +1347,7 @@ abstract class Horde_Imap_Client_Base * * * @return Horde_Imap_Client_Thread A Horde_Imap_Client_Thread object. + * @throws Horde_Imap_Client_Exception */ public function thread($mailbox, $options = array()) { @@ -1335,7 +1359,6 @@ abstract class Horde_Imap_Client_Base /** * Thread sort a given list of messages (RFC 5256). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. * @@ -1350,12 +1373,12 @@ abstract class Horde_Imap_Client_Base * 'level' - (integer) The thread level of this message (1 = base). * 'uid' - (integer) The UID of the message. * + * @throws Horde_Imap_Client_Exception */ abstract protected function _thread($options); /** * Fetch message data (see RFC 3501 [6.4.5]). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to fetch messages from. Either in * UTF7-IMAP or UTF-8. @@ -1693,6 +1716,7 @@ abstract class Horde_Imap_Client_Base * keys that correspond to 'ids', and values that * contain the array of fetched information as requested * in criteria. + * @throws Horde_Imap_Client_Exception */ public function fetch($mailbox, $criteria, $options = array()) { @@ -1881,18 +1905,17 @@ abstract class Horde_Imap_Client_Base /** * Fetch message data. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $criteria The fetch criteria. * @param array $options Additional options. * * @return array See self::fetch(). + * @throws Horde_Imap_Client_Exception */ abstract protected function _fetch($criteria, $options); /** * Store message flag data (see RFC 3501 [6.4.6]). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox containing the messages to modify. * Either in UTF7-IMAP or UTF-8. @@ -1922,6 +1945,7 @@ abstract class Horde_Imap_Client_Base * @return array If 'unchangedsince' is set, this is a list of UIDs or * sequence numbers (if 'sequence' is true) that failed * the 'unchangedsince' test. Else, an empty array. + * @throws Horde_Imap_Client_Exception */ public function store($mailbox, $options = array()) { @@ -1937,17 +1961,16 @@ abstract class Horde_Imap_Client_Base /** * Store message flag data. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. * * @return array See self::store(). + * @throws Horde_Imap_Client_Exception */ abstract protected function _store($options); /** * Copy messages to another mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $source The source mailbox. Either in UTF7-IMAP * or UTF-8. @@ -1968,6 +1991,7 @@ abstract class Horde_Imap_Client_Base * @return mixed An array mapping old UIDs (keys) to new UIDs (values) on * success (if the IMAP server and/or driver support the * UIDPLUS extension) or true. + * @throws Horde_Imap_Client_Exception */ public function copy($source, $dest, $options = array()) { @@ -1977,7 +2001,6 @@ abstract class Horde_Imap_Client_Base /** * Copy messages to another mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $dest The destination mailbox (UTF7-IMAP). * @param array $options Additional options. @@ -1985,13 +2008,13 @@ abstract class Horde_Imap_Client_Base * @return mixed An array mapping old UIDs (keys) to new UIDs (values) on * success (if the IMAP server and/or driver support the * UIDPLUS extension) or true. + * @throws Horde_Imap_Client_Exception */ abstract protected function _copy($dest, $options); /** * Set quota limits. The server must support the IMAP QUOTA extension * (RFC 2087). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root. Either in UTF7-IMAP or UTF-8. * @param array $options Additional options: @@ -2003,6 +2026,8 @@ abstract class Horde_Imap_Client_Base * storage size. * DEFAULT: No limit set. * + * + * @throws Horde_Imap_Client_Exception */ public function setQuota($root, $options = array()) { @@ -2017,25 +2042,25 @@ abstract class Horde_Imap_Client_Base /** * Set quota limits. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root (UTF7-IMAP). * @param array $options Additional options. * * @return boolean True on success. + * @throws Horde_Imap_Client_Exception */ abstract protected function _setQuota($root, $options); /** * Get quota limits. The server must support the IMAP QUOTA extension * (RFC 2087). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root. Either in UTF7-IMAP or UTF-8. * * @return mixed An array with these possible keys: 'messages' and * 'storage'; each key holds an array with 2 values: * 'limit' and 'usage'. + * @throws Horde_Imap_Client_Exception */ public function getQuota($root) { @@ -2048,20 +2073,19 @@ abstract class Horde_Imap_Client_Base /** * Get quota limits. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root (UTF7-IMAP). * * @return mixed An array with these possible keys: 'messages' and * 'storage'; each key holds an array with 2 values: * 'limit' and 'usage'. + * @throws Horde_Imap_Client_Exception */ abstract protected function _getQuota($root); /** * Get quota limits for a mailbox. The server must support the IMAP QUOTA * extension (RFC 2087). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox. Either in UTF7-IMAP or UTF-8. * @@ -2069,6 +2093,7 @@ abstract class Horde_Imap_Client_Base * holds an array with two possible keys: 'messages' and * 'storage'; each of these keys holds an array with 2 * values: 'limit' and 'usage'. + * @throws Horde_Imap_Client_Exception */ public function getQuotaRoot($mailbox) { @@ -2081,7 +2106,6 @@ abstract class Horde_Imap_Client_Base /** * Get quota limits for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @@ -2089,18 +2113,19 @@ abstract class Horde_Imap_Client_Base * holds an array with two possible keys: 'messages' and * 'storage'; each of these keys holds an array with 2 * values: 'limit' and 'usage'. + * @throws Horde_Imap_Client_Exception */ abstract protected function _getQuotaRoot($mailbox); /** * Get the ACL rights for a given mailbox. The server must support the * IMAP ACL extension (RFC 2086/4314). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox. Either in UTF7-IMAP or UTF-8. * * @return array An array with identifiers as the keys and an array of * rights as the values. + * @throws Horde_Imap_Client_Exception */ public function getACL($mailbox) { @@ -2109,18 +2134,17 @@ abstract class Horde_Imap_Client_Base /** * Get ACL rights for a given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * * @return array An array with identifiers as the keys and an array of * rights as the values. + * @throws Horde_Imap_Client_Exception */ abstract protected function _getACL($mailbox); /** * Set ACL rights for a given mailbox/identifier. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox. Either in UTF7-IMAP or UTF-8. * @param string $identifier The identifier to alter. Either in UTF7-IMAP @@ -2132,6 +2156,8 @@ abstract class Horde_Imap_Client_Base * 'rights' - (string) The rights to alter. * DEFAULT: No rights are altered. * + * + * @throws Horde_Imap_Client_Exception */ public function setACL($mailbox, $identifier, $options) { @@ -2144,18 +2170,18 @@ abstract class Horde_Imap_Client_Base /** * Set ACL rights for a given mailbox/identifier. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @param string $identifier The identifier to alter (UTF7-IMAP). * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ abstract protected function _setACL($mailbox, $identifier, $options); /** * List the ACL rights for a given mailbox/identifier. The server must * support the IMAP ACL extension (RFC 2086/4314). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox. Either in UTF7-IMAP or UTF-8. * @param string $identifier The identifier to alter. Either in UTF7-IMAP @@ -2166,6 +2192,7 @@ abstract class Horde_Imap_Client_Base * identifier can be granted in the mailbox; these rights * may be grouped together to indicate that they are tied * to each other). + * @throws Horde_Imap_Client_Exception */ public function listACLRights($mailbox, $identifier) { @@ -2178,23 +2205,23 @@ abstract class Horde_Imap_Client_Base /** * Get ACL rights for a given mailbox/identifier. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @param string $identifier The identifier to alter (UTF7-IMAP). * * @return array An array of rights (keys: 'required' and 'optional'). + * @throws Horde_Imap_Client_Exception */ abstract protected function _listACLRights($mailbox, $identifier); /** * Get the ACL rights for the current user for a given mailbox. The * server must support the IMAP ACL extension (RFC 2086/4314). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox. Either in UTF7-IMAP or UTF-8. * * @return array An array of rights. + * @throws Horde_Imap_Client_Exception */ public function getMyACLRights($mailbox) { @@ -2207,11 +2234,11 @@ abstract class Horde_Imap_Client_Base /** * Get the ACL rights for the current user for a given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * * @return array An array of rights. + * @throws Horde_Imap_Client_Exception */ abstract protected function _getMyACLRights($mailbox); @@ -2251,7 +2278,6 @@ abstract class Horde_Imap_Client_Base /** * Store FETCH data in cache. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $data The data array. * @param array $options Additional options: @@ -2263,6 +2289,8 @@ abstract class Horde_Imap_Client_Base * 'uidvalid' - (integer) The UID Validity number. * DEFAULT: UIDVALIDITY discovered via a status() call. * + * + * @throws Horde_Imap_Client_Exception */ protected function _updateCache($data, $options = array()) { diff --git a/framework/Imap_Client/lib/Horde/Imap/Client/Cache.php b/framework/Imap_Client/lib/Horde/Imap/Client/Cache.php index 31a10e2f5..d2a395208 100644 --- a/framework/Imap_Client/lib/Horde/Imap/Client/Cache.php +++ b/framework/Imap_Client/lib/Horde/Imap/Client/Cache.php @@ -100,9 +100,10 @@ class Horde_Imap_Client_Cache /** * Constructor. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $params The configuration parameters. + * + * @throws Horde_Imap_Client_Exception */ public function __construct($params = array()) { @@ -206,7 +207,6 @@ class Horde_Imap_Client_Cache /** * Get information from the cache. - * Throws a Horde_Imap_Cache_Exception on error. * * @param string $mailbox An IMAP mailbox string. * @param array $uids The list of message UIDs to retrieve @@ -219,6 +219,7 @@ class Horde_Imap_Client_Cache * key (if found) and the fields as values (will be * undefined if not found). If $uids is empty, returns the * full list of cached UIDs. + * @throws Horde_Imap_Client_Exception */ public function get($mailbox, $uids = array(), $fields = array(), $uidvalid = null) @@ -338,10 +339,11 @@ class Horde_Imap_Client_Cache /** * Delete messages in the cache. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox An IMAP mailbox string. * @param array $uids The list of message UIDs to delete. + * + * @throws Horde_Imap_Client_Exception */ public function deleteMsgs($mailbox, $uids) { @@ -403,12 +405,14 @@ class Horde_Imap_Client_Cache /** * Load the given mailbox by regenerating from the cache. - * Throws a Horde_Imap_Client_Exception on error (only if $uidvalid is - * set). + * Throws a Horde_Imap_Client_Exception on error ONLY if $uidvalid is + * set. * * @param string $mailbox The mailbox to load. * @param array $uids The UIDs to load. * @param integer $uidvalid The IMAP uidvalidity value of the mailbox. + * + * @throws Horde_Imap_Client_Exception */ protected function _loadMailbox($mailbox, $uids, $uidvalid = null) { @@ -479,13 +483,13 @@ class Horde_Imap_Client_Cache /** * Given a list of UIDs, determine the slices that need to be loaded. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox. * @param array $uids A list of UIDs. * @param boolean $set Set the slice information in $_slicemap? * * @return array UIDs as the keys, the slice number as the value. + * @throws Horde_Imap_Client_Exception */ protected function _getCacheSlices($mailbox, $uids, $set = false) { diff --git a/framework/Imap_Client/lib/Horde/Imap/Client/Cclient.php b/framework/Imap_Client/lib/Horde/Imap/Client/Cclient.php index 607d581af..98507cf92 100644 --- a/framework/Imap_Client/lib/Horde/Imap/Client/Cclient.php +++ b/framework/Imap_Client/lib/Horde/Imap/Client/Cclient.php @@ -124,9 +124,9 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Get CAPABILITY info from the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @return array The capability array. + * @throws Horde_Imap_Client_Exception */ protected function _capability() { @@ -142,7 +142,8 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Send a NOOP command. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ protected function _noop() { @@ -159,9 +160,9 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Get the NAMESPACE information from the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @return array An array of namespace information. + * @throws Horde_Imap_Client_Exception */ protected function _getNamespaces() { @@ -181,9 +182,9 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Login to the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @return boolean Return true if global login tasks should be run. + * @throws Horde_Imap_Client_Exception */ protected function _login() { @@ -254,9 +255,10 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Send ID information to the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info The information to send to the server. + * + * @throws Horde_Imap_Client_Exception */ protected function _sendID($info) { @@ -265,10 +267,10 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Return ID information from the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. * * @return array An array of information returned, with the keys as the * 'field' and the values as the 'value'. + * @throws Horde_Imap_Client_Exception */ protected function _getID() { @@ -277,12 +279,12 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Sets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info The preferred list of languages. * * @return string The language accepted by the server, or null if the * default language is used. + * @throws Horde_Imap_Client_Exception */ protected function _setLanguage($langs) { @@ -291,13 +293,13 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Gets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $list If true, return the list of available languages. * * @return mixed If $list is true, the list of languages available on the * server (may be empty). If false, the language used by * the server, or null if the default language is used. + * @throws Horde_Imap_Client_Exception */ protected function _getLanguage($list) { @@ -306,10 +308,11 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Open a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to open (UTF7-IMAP). * @param integer $mode The access mode. + * + * @throws Horde_Imap_Client_Exception */ protected function _openMailbox($mailbox, $mode) { @@ -331,9 +334,10 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Create a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to create (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _createMailbox($mailbox) { @@ -350,9 +354,10 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Delete a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to delete (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _deleteMailbox($mailbox) { @@ -369,10 +374,11 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Rename a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $old The old mailbox name (UTF7-IMAP). * @param string $new The new mailbox name (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _renameMailbox($old, $new) { @@ -389,10 +395,11 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Manage subscription status for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to [un]subscribe to (UTF7-IMAP). * @param boolean $subscribe True to subscribe, false to unsubscribe. + * + * @throws Horde_Imap_Client_Exception */ protected function _subscribeMailbox($mailbox, $subscribe) { @@ -413,7 +420,6 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Obtain a list of mailboxes matching a pattern. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $pattern The mailbox search pattern. * @param integer $mode Which mailboxes to return. @@ -426,6 +432,7 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base * * * @return array See Horde_Imap_Client_Base::listMailboxes(). + * @throws Horde_Imap_Client_Exception */ protected function _listMailboxes($pattern, $mode, $options) { @@ -542,13 +549,13 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Obtain status information for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to query (UTF7-IMAP). * @param string $flags A bitmask of information requested from the * server. * * @return array See Horde_Imap_Client_Base::status(). + * @throws Horde_Imap_Client_Exception */ protected function _status($mailbox, $flags) { @@ -608,7 +615,6 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Append message(s) to a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to append the message(s) to * (UTF7-IMAP). @@ -616,6 +622,7 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base * @param array $options Additional options. * * @return mixed Returns true. + * @throws Horde_Imap_Client_Exception */ protected function _append($mailbox, $data, $options) { @@ -653,7 +660,8 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Request a checkpoint of the currently selected mailbox. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ protected function _check() { @@ -671,9 +679,10 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Close the connection to the currently selected mailbox, optionally * expunging all deleted messages (RFC 3501 [6.4.2]). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _close($options) { @@ -685,9 +694,10 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Expunge deleted messages from the given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _expunge($options) { @@ -740,7 +750,6 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Search a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param object $query The search string. * @param array $options Additional options. The '_query' key contains @@ -748,6 +757,7 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base * * @return array An array of UIDs (default) or an array of message * sequence numbers (if 'sequence' is true). + * @throws Horde_Imap_Client_Exception */ protected function _search($query, $options) { @@ -808,12 +818,13 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Set the comparator to use for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $comparator The comparator string (see RFC 4790 [3.1] - * "collation-id" - for format). The reserved * string 'default' can be used to select * the default comparator. + * + * @throws Horde_Imap_Client_Exception */ protected function _setComparator($comparator) { @@ -822,10 +833,10 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Get the comparator used for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @return mixed Null if the default comparator is being used, or an * array of comparator information (see RFC 5255 [4.8]). + * @throws Horde_Imap_Client_Exception */ protected function _getComparator() { @@ -834,11 +845,11 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Thread sort a given list of messages (RFC 5256). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. * * @return array See Horde_Imap_Client_Base::_thread(). + * @throws Horde_Imap_Client_Exception */ protected function _thread($options) { @@ -926,12 +937,12 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Fetch message data. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $criteria The fetch criteria. * @param array $options Additional options. * * @return array See self::fetch(). + * @throws Horde_Imap_Client_Exception */ protected function _fetch($criteria, $options) { @@ -1306,9 +1317,10 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Store message flag data. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _store($options) { @@ -1358,13 +1370,13 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Copy messages to another mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $dest The destination mailbox (UTF7-IMAP). * @param array $options Additional options. * * @return boolean True on success (this driver does not support * returning the UIDs). + * @throws Horde_Imap_Client_Exception */ protected function _copy($dest, $options) { @@ -1405,10 +1417,11 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Set quota limits. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root (UTF7-IMAP). * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _setQuota($root, $options) { @@ -1431,13 +1444,13 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Get quota limits. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root (UTF7-IMAP). * * @return mixed An array with these possible keys: 'messages' and * 'storage'; each key holds an array with 2 values: * 'limit' and 'usage'. + * @throws Horde_Imap_Client_Exception */ protected function _getQuota($root) { @@ -1454,7 +1467,6 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Get quota limits for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @@ -1462,6 +1474,7 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base * holds an array with two possible keys: 'messages' and * 'storage'; each of these keys holds an array with 2 * values: 'limit' and 'usage'. + * @throws Horde_Imap_Client_Exception */ protected function _getQuotaRoot($mailbox) { @@ -1480,11 +1493,12 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Set ACL rights for a given mailbox/identifier. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @param string $identifier The identifier to alter (UTF7-IMAP). * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _setACL($mailbox, $identifier, $options) { @@ -1514,12 +1528,12 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Get ACL rights for a given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * * @return array An array with identifiers as the keys and an array of * rights as the values. + * @throws Horde_Imap_Client_Exception */ protected function _getACL($mailbox) { @@ -1547,12 +1561,12 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Get ACL rights for a given mailbox/identifier. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @param string $identifier The identifier (UTF-8). * * @return array An array of rights (keys: 'required' and 'optional'). + * @throws Horde_Imap_Client_Exception */ protected function _listACLRights($mailbox, $identifier) { @@ -1563,11 +1577,11 @@ class Horde_Imap_Client_Cclient extends Horde_Imap_Client_Base /** * Get the ACL rights for the current user for a given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * * @return array An array of rights. + * @throws Horde_Imap_Client_Exception */ protected function _getMyACLRights($mailbox) { diff --git a/framework/Imap_Client/lib/Horde/Imap/Client/Cclient/Pop3.php b/framework/Imap_Client/lib/Horde/Imap/Client/Cclient/Pop3.php index 329b3286a..24d11b15b 100644 --- a/framework/Imap_Client/lib/Horde/Imap/Client/Cclient/Pop3.php +++ b/framework/Imap_Client/lib/Horde/Imap/Client/Cclient/Pop3.php @@ -35,7 +35,8 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Get CAPABILITY info from the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ protected function _capability() { @@ -44,7 +45,8 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Get the NAMESPACE information from the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ protected function _getNamespaces() { @@ -53,9 +55,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Send ID information to the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info The information to send to the server. + * + * @throws Horde_Imap_Client_Exception */ protected function _sendID($info) { @@ -64,7 +67,8 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Return ID information from the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ protected function _getID() { @@ -73,12 +77,12 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Sets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info The preferred list of languages. * * @return string The language accepted by the server, or null if the * default language is used. + * @throws Horde_Imap_Client_Exception */ protected function _setLanguage($langs) { @@ -87,9 +91,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Gets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $list If true, return the list of available languages. + * + * @throws Horde_Imap_Client_Exception */ protected function _getLanguage($list) { @@ -98,10 +103,11 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Open a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to open (UTF7-IMAP). * @param integer $mode The access mode. + * + * @throws Horde_Imap_Client_Exception */ protected function _openMailbox($mailbox, $mode) { @@ -112,9 +118,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Create a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to create (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _createMailbox($mailbox) { @@ -123,9 +130,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Delete a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to delete (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _deleteMailbox($mailbox) { @@ -134,10 +142,11 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Rename a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $old The old mailbox name (UTF7-IMAP). * @param string $new The new mailbox name (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _renameMailbox($old, $new) { @@ -146,10 +155,11 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Manage subscription status for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to [un]subscribe to (UTF7-IMAP). * @param boolean $subscribe True to subscribe, false to unsubscribe. + * + * @throws Horde_Imap_Client_Exception */ protected function _subscribeMailbox($mailbox, $subscribe) { @@ -158,9 +168,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Unsubscribe to a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to unsubscribe to (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _unsubscribeMailbox($mailbox) { @@ -169,13 +180,13 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Obtain a list of mailboxes matching a pattern. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $pattern The mailbox search pattern. * @param integer $mode Which mailboxes to return. * @param array $options Additional options. * * @return array See Horde_Imap_Client_Base::listMailboxes(). + * @throws Horde_Imap_Client_Exception */ protected function _listMailboxes($pattern, $mode, $options) { @@ -193,13 +204,13 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Obtain status information for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to query (UTF7-IMAP). * @param string $flags A bitmask of information requested from the * server. * * @return array See Horde_Imap_Client_Base::status(). + * @throws Horde_Imap_Client_Exception */ protected function _status($mailbox, $flags) { @@ -219,13 +230,13 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Search a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param object $query The search string. * @param array $options Additional options. * * @return array An array of UIDs (default) or an array of message * sequence numbers (if 'sequence' is true). + * @throws Horde_Imap_Client_Exception */ protected function _search($query, $options) { @@ -247,12 +258,12 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Set the comparator to use for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $comparator The comparator string (see RFC 4790 [3.1] - * "collation-id" - for format). The reserved * string 'default' can be used to select * the default comparator. + * @throws Horde_Imap_Client_Exception */ protected function _setComparator($comparator) { @@ -261,7 +272,8 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Get the comparator used for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ protected function _getComparator() { @@ -270,11 +282,11 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Thread sort a given list of messages (RFC 5256). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. * * @return array See Horde_Imap_Client_Base::thread(). + * @throws Horde_Imap_Client_Exception */ protected function _thread($options) { @@ -291,12 +303,13 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Append a message to the mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $mailbox The mailboxes to append the messages to * (UTF7-IMAP). * @param array $data The message data. * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _append($mailbox, $data, $options) { @@ -305,12 +318,12 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Fetch message data. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $criteria The fetch criteria. * @param array $options Additional options. * * @return array See self::fetch(). + * @throws Horde_Imap_Client_Exception */ protected function _fetch($criteria, $options) { @@ -329,9 +342,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Store message flag data. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _store($options) { @@ -340,10 +354,11 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Copy messages to another mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $dest The destination mailbox (UTF7-IMAP). * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _copy($dest, $options) { @@ -352,10 +367,11 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Set quota limits. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root (UTF7-IMAP). * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _setQuota($root, $options) { @@ -364,9 +380,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Get quota limits. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _getQuota($root) { @@ -375,9 +392,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Get quota limits for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _getQuotaRoot($mailbox) { @@ -386,11 +404,12 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Set ACL rights for a given mailbox/identifier. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @param string $identifier The identifier to alter (UTF7-IMAP). * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _setACL($mailbox, $identifier, $options) { @@ -399,9 +418,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Get ACL rights for a given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _getACL($mailbox) { @@ -410,10 +430,11 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Get ACL rights for a given mailbox/identifier. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @param string $identifier The identifier (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _listACLRights($mailbox, $identifier) { @@ -422,9 +443,10 @@ class Horde_Imap_Client_Cclient_Pop3 extends Horde_Imap_Client_Cclient /** * Get the ACL rights for the current user for a given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _getMyACLRights($mailbox) { diff --git a/framework/Imap_Client/lib/Horde/Imap/Client/Socket.php b/framework/Imap_Client/lib/Horde/Imap/Client/Socket.php index 1d5c55f86..540b7fff2 100644 --- a/framework/Imap_Client/lib/Horde/Imap/Client/Socket.php +++ b/framework/Imap_Client/lib/Horde/Imap/Client/Socket.php @@ -114,9 +114,9 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Get CAPABILITY info from the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @return array The capability array. + * @throws Horde_Imap_Client_Exception */ protected function _capability() { @@ -173,7 +173,8 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Send a NOOP command. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ protected function _noop() { @@ -183,9 +184,9 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Get the NAMESPACE information from the IMAP server (RFC 2342). - * Throws a Horde_Imap_Client_Exception on error. * * @return array An array of namespace information. + * @throws Horde_Imap_Client_Exception */ protected function _getNamespaces() { @@ -250,9 +251,9 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Login to the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @return boolean Return true if global login tasks should be run. + * @throws Horde_Imap_Client_Exception */ protected function _login() { @@ -400,7 +401,8 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Connects to the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ protected function _connect() { @@ -483,9 +485,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Authenticate to the IMAP server. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $method IMAP login method. + * + * @throws Horde_Imap_Client_Exception */ protected function _tryLogin($method) { @@ -605,9 +608,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Send ID information to the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info The information to send to the server. + * + * @throws Horde_Imap_Client_Exception */ protected function _sendID($info) { @@ -644,10 +648,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Return ID information from the IMAP server (RFC 2971). - * Throws a Horde_Imap_Client_Exception on error. * * @return array An array of information returned, with the keys as the * 'field' and the values as the 'value'. + * @throws Horde_Imap_Client_Exception */ protected function _getID() { @@ -659,12 +663,12 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Sets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $info The preferred list of languages. * * @return string The language accepted by the server, or null if the * default language is used. + * @throws Horde_Imap_Client_Exception */ protected function _setLanguage($langs) { @@ -685,13 +689,13 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Gets the preferred language for server response messages (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $list If true, return the list of available languages. * * @return mixed If $list is true, the list of languages available on the * server (may be empty). If false, the language used by * the server, or null if the default language is used. + * @throws Horde_Imap_Client_Exception */ protected function _getLanguage($list) { @@ -729,9 +733,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Enable an IMAP extension (see RFC 5161). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $exts The extensions to enable. + * + * @throws Horde_Imap_Client_Exception */ protected function _enable($exts) { @@ -754,10 +759,11 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Open a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to open (UTF7-IMAP). * @param integer $mode The access mode. + * + * @throws Horde_Imap_Client_Exception */ protected function _openMailbox($mailbox, $mode) { @@ -834,9 +840,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Create a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to create (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _createMailbox($mailbox) { @@ -848,9 +855,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Delete a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to delete (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _deleteMailbox($mailbox) { @@ -885,10 +893,11 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Rename a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * - * @param string $old The old mailbox name (UTF7-IMAP). - * @param string $new The new mailbox name (UTF7-IMAP). + * @param string $old The old mailbox name (UTF7-IMAP). + * @param string $new The new mailbox name (UTF7-IMAP). + * + * @throws Horde_Imap_Client_Exception */ protected function _renameMailbox($old, $new) { @@ -900,10 +909,11 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Manage subscription status for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to [un]subscribe to (UTF7-IMAP). * @param boolean $subscribe True to subscribe, false to unsubscribe. + * + * @throws Horde_Imap_Client_Exception */ protected function _subscribeMailbox($mailbox, $subscribe) { @@ -916,13 +926,13 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Obtain a list of mailboxes matching a pattern. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $pattern The mailbox search pattern. * @param integer $mode Which mailboxes to return. * @param array $options Additional options. * * @return array See self::listMailboxes(). + * @throws Horde_Imap_Client_Exception */ protected function _listMailboxes($pattern, $mode, $options) { @@ -947,7 +957,6 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Obtain a list of mailboxes matching a pattern. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $pattern The mailbox search pattern. * @param integer $mode Which mailboxes to return. @@ -955,6 +964,7 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base * @param array $subscribed A list of subscribed mailboxes. * * @return array See self::listMailboxes((). + * @throws Horde_Imap_Client_Exception */ protected function _getMailboxList($pattern, $mode, $options, $subscribed = null) @@ -977,10 +987,11 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Parse a LIST/LSUB response (RFC 3501 [7.2.2 & 7.2.3]). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $data The server response (includes type as first * element). + * + * @throws Horde_Imap_Client_Exception */ protected function _parseList($data) { @@ -1019,13 +1030,13 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Obtain status information for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to query (UTF7-IMAP). * @param string $flags A bitmask of information requested from the * server. * * @return array See Horde_Imap_Client_Base::status(). + * @throws Horde_Imap_Client_Exception */ protected function _status($mailbox, $flags) { @@ -1130,7 +1141,6 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Append message(s) to a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox The mailbox to append the message(s) to * (UTF7-IMAP). @@ -1139,6 +1149,7 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base * * @return mixed An array of the UIDs of the appended messages (if server * supports UIDPLUS extension) or true. + * @throws Horde_Imap_Client_Exception */ protected function _append($mailbox, $data, $options) { @@ -1232,7 +1243,8 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Request a checkpoint of the currently selected mailbox. - * Throws a Horde_Imap_Client_Exception on error. + * + * @throws Horde_Imap_Client_Exception */ protected function _check() { @@ -1243,9 +1255,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Close the connection to the currently selected mailbox, optionally * expunging all deleted messages (RFC 3501 [6.4.2]). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _close($options) { @@ -1283,9 +1296,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Expunge deleted messages from the given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _expunge($options) { @@ -1425,7 +1439,6 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Search a mailbox. This driver supports all IMAP4rev1 search criteria * as defined in RFC 3501. - * Throws a Horde_Imap_Client_Exception on error. * * @param object $query The search query. * @param array $options Additional options. The '_query' key contains @@ -1433,6 +1446,7 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base * * @return array An array of UIDs (default) or an array of message * sequence numbers (if 'sequence' is true). + * @throws Horde_Imap_Client_Exception */ protected function _search($query, $options) { @@ -1638,12 +1652,12 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * If server does not support the SORT IMAP extension (RFC 5256), we need * to do sorting on the client side. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $res The search results. * @param array $opts The options to search(). * * @return array The sort results. + * @throws Horde_Imap_Client_Exception */ protected function _clientSort($res, $opts) { @@ -1816,12 +1830,13 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Set the comparator to use for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @param string $comparator The comparator string (see RFC 4790 [3.1] - * "collation-id" - for format). The reserved * string 'default' can be used to select * the default comparator. + * + * @throws Horde_Imap_Client_Exception */ protected function _setComparator($comparator) { @@ -1837,10 +1852,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Get the comparator used for searching/sorting (RFC 5255). - * Throws a Horde_Imap_Client_Exception on error. * * @return mixed Null if the default comparator is being used, or an * array of comparator information (see RFC 5255 [4.8]). + * @throws Horde_Imap_Client_Exception */ protected function _getComparator() { @@ -1863,11 +1878,11 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Thread sort a given list of messages (RFC 5256). - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. * * @return array See Horde_Imap_Client_Base::_thread(). + * @throws Horde_Imap_Client_Exception */ protected function _thread($options) { @@ -2001,7 +2016,6 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Fetch message data. - * Throws a Horde_Imap_Client_Exception on error. * * @todo Provide a function that would allow streaming of large data * items like bodytext. @@ -2010,6 +2024,7 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base * @param array $options Additional options. * * @return array See self::fetch(). + * @throws Horde_Imap_Client_Exception */ protected function _fetch($criteria, $options) { @@ -2570,11 +2585,11 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Store message flag data. - * Throws a Horde_Imap_Client_Exception on error. * * @param array $options Additional options. * * @return array See Horde_Imap_Client::store(). + * @throws Horde_Imap_Client_Exception */ protected function _store($options) { @@ -2660,7 +2675,6 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Copy messages to another mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $dest The destination mailbox (UTF7-IMAP). * @param array $options Additional options. @@ -2668,6 +2682,7 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base * @return mixed An array mapping old UIDs (keys) to new UIDs (values) on * success (if the IMAP server and/or driver support the * UIDPLUS extension) or true. + * @throws Horde_Imap_Client_Exception */ protected function _copy($dest, $options) { @@ -2711,10 +2726,11 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Set quota limits. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root (UTF7-IMAP). * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _setQuota($root, $options) { @@ -2733,13 +2749,13 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Get quota limits. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $root The quota root (UTF7-IMAP). * * @return mixed An array with these possible keys: 'messages' and * 'storage'; each key holds an array with 2 values: * 'limit' and 'usage'. + * @throws Horde_Imap_Client_Exception */ protected function _getQuota($root) { @@ -2772,7 +2788,6 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Get quota limits for a mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @@ -2780,6 +2795,7 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base * holds an array with two possible keys: 'messages' and * 'storage'; each of these keys holds an array with 2 * values: 'limit' and 'usage'. + * @throws Horde_Imap_Client_Exception */ protected function _getQuotaRoot($mailbox) { @@ -2792,11 +2808,12 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Set ACL rights for a given mailbox/identifier. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @param string $identifier The identifier to alter (UTF7-IMAP). * @param array $options Additional options. + * + * @throws Horde_Imap_Client_Exception */ protected function _setACL($mailbox, $identifier, $options) { @@ -2813,12 +2830,12 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Get ACL rights for a given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * * @return array An array with identifiers as the keys and an array of * rights as the values. + * @throws Horde_Imap_Client_Exception */ protected function _getACL($mailbox) { @@ -2846,12 +2863,12 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Get ACL rights for a given mailbox/identifier. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * @param string $identifier The identifier (US-ASCII). * * @return array An array of rights (keys: 'required' and 'optional'). + * @throws Horde_Imap_Client_Exception */ protected function _listACLRights($mailbox, $identifier) { @@ -2878,11 +2895,11 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Get the ACL rights for the current user for a given mailbox. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $mailbox A mailbox (UTF7-IMAP). * * @return array An array of rights. + * @throws Horde_Imap_Client_Exception */ protected function _getMyACLRights($mailbox) { @@ -2908,7 +2925,6 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Perform a command on the IMAP server. A connection to the server must * have already been made. - * Throws a Horde_Imap_Client_Exception on error. * * @todo RFC 3501 allows the sending of multiple commands at once. For * simplicity of implementation at this time, we will execute @@ -2942,6 +2958,8 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base * response). * DEFAULT: false * + * + * @throws Horde_Imap_Client_Exception */ protected function _sendLine($query, $options = array()) { @@ -3002,7 +3020,6 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Gets a line from the IMAP stream and parses it. - * Throws a Horde_Imap_Client_Exception on error. * * @return array An array with the following keys: * 
@@ -3014,6 +3031,7 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base
      *           with no response code).
      * 'type' - (string) Either 'tagged', 'untagged', or 'continuation'.
      *
+ * @throws Horde_Imap_Client_Exception */ protected function _getLine() { @@ -3220,9 +3238,10 @@ class Horde_Imap_Client_Socket extends Horde_Imap_Client_Base /** * Parse all untagged and tagged responses for a given command. - * Throws a Horde_Imap_Client_Exception on error. * * @param string $tag The IMAP tag of the current command. + * + * @throws Horde_Imap_Client_Exception */ protected function _parseResponse($tag) { diff --git a/framework/Imap_Client/lib/Horde/Imap/Client/Utf7imap.php b/framework/Imap_Client/lib/Horde/Imap/Client/Utf7imap.php index 550cf2136..268fcbfd1 100644 --- a/framework/Imap_Client/lib/Horde/Imap/Client/Utf7imap.php +++ b/framework/Imap_Client/lib/Horde/Imap/Client/Utf7imap.php @@ -61,11 +61,11 @@ class Horde_Imap_Client_Utf7imap /** * Convert a string from UTF7-IMAP to UTF-8. - * Throws a Horde_Imap_Client_Exception on error. * * @param string The UTF7-IMAP string. * * @return string The converted UTF-8 string. + * @throws Horde_Imap_Client_Exception */ public static function Utf7ImapToUtf8($str) { @@ -157,11 +157,11 @@ class Horde_Imap_Client_Utf7imap /** * Convert a string from UTF-8 to UTF7-IMAP. - * Throws a Horde_Imap_Client_Exception on error. * * @param string The UTF-8 string. * * @return string The converted UTF7-IMAP string. + * @throws Horde_Imap_Client_Exception */ public static function Utf8ToUtf7Imap($str) {