Public Member Functions | |
countMessages ($flags=null) | |
getSize ($id=null) | |
getMessage ($id) | |
getRawHeader ($id, $part=null, $topLines=0) | |
getRawContent ($id, $part=null) | |
__construct ($params) | |
close () | |
noop () | |
removeMessage ($id) | |
getUniqueId ($id=null) | |
getNumberByUniqueId ($id) | |
Protected Member Functions | |
_getFileData ($id, $field=null) | |
_isMaildir ($dirname) | |
_openMaildir ($dirname) | |
_getMaildirFiles ($dh, $dirname, $default_flags=array()) | |
Protected Attributes | |
$_messageClass = 'Zend_Mail_Message_File' | |
$_files = array() | |
Static Protected Attributes | |
static | $_knownFlags |
Definition at line 47 of file Maildir.php.
__construct | ( | $ | params ) |
Create instance with parameters Supported parameters are:
$params | array mail reader specific parameters |
Zend_Mail_Storage_Exception |
Reimplemented from Zend_Mail_Storage_Abstract.
Reimplemented in Zend_Mail_Storage_Folder_Maildir, and Zend_Mail_Storage_Writable_Maildir.
Definition at line 263 of file Maildir.php.
_getFileData | ( | $ | id, |
$ | field = null |
||
) | [protected] |
Get one or all fields from file structure. Also checks if message is valid
int | $id | message number |
string | null | $field | wanted field |
Zend_Mail_Storage_Exception |
Definition at line 119 of file Maildir.php.
_getMaildirFiles | ( | $ | dh, |
$ | dirname, | ||
$ | default_flags = array() |
||
) | [protected] |
find all files in opened dir handle and add to maildir files
resource | $dh | dir handle used for search |
string | $dirname | dirname of dir in $dh |
array | $default_flags | default flags for given dir |
Definition at line 352 of file Maildir.php.
_isMaildir | ( | $ | dirname ) | [protected] |
check if a given dir is a valid maildir
string | $dirname | name of dir |
Definition at line 296 of file Maildir.php.
_openMaildir | ( | $ | dirname ) | [protected] |
open given dir as current maildir
string | $dirname | name of maildir |
Zend_Mail_Storage_Exception |
Definition at line 314 of file Maildir.php.
close | ( | ) |
Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 397 of file Maildir.php.
countMessages | ( | $ | flags = null ) |
Count messages all messages in current box
Zend_Mail_Storage_Exception |
Definition at line 83 of file Maildir.php.
getMessage | ( | $ | id ) |
Fetch a message
int | $id | number of message |
Zend_Mail_Storage_Exception |
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 175 of file Maildir.php.
getNumberByUniqueId | ( | $ | id ) |
get a message number from a unique id
I.e. if you have a webmailer that supports deleting messages you should use unique ids as parameter and use this method to translate it to message number right before calling removeMessage()
string | $id | unique id |
Zend_Mail_Storage_Exception |
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 461 of file Maildir.php.
getRawContent | ( | $ | id, |
$ | part = null |
||
) |
Get raw content of message or part
int | $id | number of message |
null | array | string | $part | path to part or null for messsage content |
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 230 of file Maildir.php.
getRawHeader | ( | $ | id, |
$ | part = null , |
||
$ | topLines = 0 |
||
) |
Get raw header of message or part
int | $id | number of message |
null | array | string | $part | path to part or null for messsage header |
int | $topLines | include this many lines with header (after an empty line) |
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 196 of file Maildir.php.
getSize | ( | $ | id = null ) |
Get a list of messages with number and size
int | null | $id | number of message or null for all messages |
Zend_Mail_Storage_Exception |
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 151 of file Maildir.php.
getUniqueId | ( | $ | id = null ) |
get unique id for one or all messages
if storage does not support unique ids it's the same as the message number
int | null | $id | message number |
Zend_Mail_Storage_Exception |
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 438 of file Maildir.php.
noop | ( | ) |
Waste some CPU cycles doing nothing.
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 408 of file Maildir.php.
removeMessage | ( | $ | id ) |
stub for not supported message deletion
Zend_Mail_Storage_Exception |
Reimplemented from Zend_Mail_Storage_Abstract.
Reimplemented in Zend_Mail_Storage_Writable_Maildir.
Definition at line 420 of file Maildir.php.
$_knownFlags [static, protected] |
array('D' => Zend_Mail_Storage::FLAG_DRAFT, 'F' => Zend_Mail_Storage::FLAG_FLAGGED, 'P' => Zend_Mail_Storage::FLAG_PASSED, 'R' => Zend_Mail_Storage::FLAG_ANSWERED, 'S' => Zend_Mail_Storage::FLAG_SEEN, 'T' => Zend_Mail_Storage::FLAG_DELETED)
Definition at line 68 of file Maildir.php.