getMetaData() abstract public method

Get metadata information for a mailbox.
abstract public getMetaData ( string $mailbox, integer $uidvalid, array $entries ) : array
$mailbox string An IMAP mailbox string.
$uidvalid integer The IMAP uidvalidity value of the mailbox.
$entries array An array of entries to return. If empty, returns all metadata.
return array The requested metadata. Requested entries that do not exist will be undefined. The following entries are defaults and always present: - uidvalid: (integer) The UIDVALIDITY of the mailbox.
Exemplo n.º 1
0
 /**
  * Get metadata information for a mailbox.
  *
  * @param string $mailbox    An IMAP mailbox string.
  * @param integer $uidvalid  The IMAP uidvalidity value of the mailbox.
  * @param array $entries     An array of entries to return. If empty,
  *                           returns all metadata.
  *
  * @return array  The requested metadata. Requested entries that do not
  *                exist will be undefined. The following entries are
  *                defaults and always present:
  *   - uidvalid: (integer) The UIDVALIDITY of the mailbox.
  */
 public function getMetaData($mailbox, $uidvalid = null, array $entries = array())
 {
     return $this->_backend->getMetaData(strval($mailbox), $uidvalid, $entries);
 }