Horde_ActiveSync_Imap_Adapter::emptyMailbox PHP Method

emptyMailbox() public method

Completely empty specified mailbox.
Since: 2.18.0
public emptyMailbox ( string $mbox )
$mbox string The mailbox to empty.
    public function emptyMailbox($mbox)
    {
        $mbox = new Horde_Imap_Client_Mailbox($mbox);
        try {
            $this->_getImapOb()->expunge($mbox, array('delete' => true));
        } catch (Horde_Imap_Client_Exception $e) {
            throw new Horde_ActiveSync_Exception($e);
        }
    }

Usage Example

Example #1
0
 /**
  * Empty specified mailbox.
  *
  * @param array $params An array of parameters:
  *   - folderid: The backend folderid of the mailbox to empty.
  *   - subfolders: IGNORED for now.
  *
  * @throws Horde_ActiveSync_Exception
  * @since 2.14.0
  */
 public function itemOperationsEmptyFolder($params)
 {
     $this->_imap->emptyMailbox($params['folderid']);
 }