Added the 'subscribed' return value from mailboxList API call

horde · Nov 11, 2013 · 14cd9ec · 14cd9ec
1 parent 32ee6b0
commit 14cd9ec
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/imp/docs/UPGRADING b/imp/docs/UPGRADING
@@ -77,6 +77,16 @@ The following preferences have been removed::
    pgp_scan_body
 
 
+API Changes
+-----------
+
+These API calls have been changed::
+
+   - mailboxList
+
+     Added the 'subscribed' return value.
+
+
 
 Upgrading IMP From 6.1.x To 6.1.4
 =================================

diff --git a/imp/lib/Api.php b/imp/lib/Api.php
@@ -89,6 +89,7 @@ public function batchCompose($args = array(), $extra = array())
      *   - label: (string) Human readable label (UTF-8).
      *   - level: (integer) The child level of this element.
      *   - ob: (Horde_Imap_Client_Mailbox) A mailbox object.
+     *   - subscribed: (boolean) True if mailbox is subscribed (@since 6.2.0).
      */
     public function mailboxList()
     {
@@ -102,11 +103,16 @@ public function mailboxList()
 
         foreach ($iterator as $val) {
             $mbox_ob = $val->mbox_ob;
+            $sub = $mbox_ob->sub;
+
             $mboxes[] = array(
+                // TODO: Remove for IMP 7.
+                'a' => $sub ? 8 : 0,
                 'd' => $mbox_ob->namespace_delimiter,
                 'label' => $mbox_ob->label,
                 'level' => $val->level,
-                'ob' => $mbox_ob->imap_mbox_ob
+                'ob' => $mbox_ob->imap_mbox_ob,
+                'subscribed' => $sub
             );
         }