Phpdoc

Make it clearer that this is expected to be decoded 8bit data.
horde · Jan 2, 2016 · 1522a1a · 1522a1a
1 parent 8de42ef
commit 1522a1a
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 2 deletions.
diff --git a/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Base.php b/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Base.php
@@ -345,7 +345,8 @@ public function fetchStructure($mailbox, $uids)
      * @param array  $uid     The message UID.
      * @param array  $id      The mime part ID.
      *
-     * @return resource  The body part, as a stream resource.
+     * @return resource  The transfer-decoded body part data, as a stream
+     *                   resource presented as 8bit data.
      */
     public function fetchBodypart($mailbox, $uid, $id)
     {

diff --git a/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Cclient.php b/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Cclient.php
@@ -10,6 +10,8 @@
  * @author   Gunnar Wrobel <wrobel@pardus.de>
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
  * @link     http://pear.horde.org/index.php?package=Kolab_Storage
+ * @deprecated This class is not maintained and will be removed in future
+ *             releases.
  */
 
 /**

diff --git a/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Imap.php b/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Imap.php
@@ -583,7 +583,8 @@ public function fetchStructure($folder, $uids)
      * @param array  $uid                 The message UID.
      * @param array  $id                  The mime part ID.
      *
-     * @return resource  The body part, as a stream resource.
+     * @return resource  The body part, as a stream resource. The contents are
+     *                   already transfer decoded and presented as 8bit data.
      */
     public function fetchBodypart($folder, $uid, $id)
     {

diff --git a/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Pear.php b/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Pear.php
@@ -10,6 +10,8 @@
  * @author   Gunnar Wrobel <wrobel@pardus.de>
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
  * @link     http://pear.horde.org/index.php?package=Kolab_Storage
+ * @deprecated This class is not maintained and will be removed in future
+ *             releases.
  */
 
 /**

diff --git a/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Rcube.php b/framework/Kolab_Storage/lib/Horde/Kolab/Storage/Driver/Rcube.php
@@ -10,6 +10,8 @@
  * @author   Gunnar Wrobel <wrobel@pardus.de>
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
  * @link     http://pear.horde.org/index.php?package=Kolab_Storage
+ * @deprecated This class is not maintained and will be removed in future
+ *             releases.
  */
 
 /**