Public Member Functions | |
__get ($var) | |
getCapabilities () | |
countMessages () | |
getSize ($id=0) | |
getMessage ($id) | |
getRawHeader ($id, $part=null, $topLines=0) | |
getRawContent ($id, $part=null) | |
__construct ($params) | |
__destruct () | |
close () | |
noop () | |
removeMessage ($id) | |
getUniqueId ($id=null) | |
getNumberByUniqueId ($id) | |
count () | |
offsetExists ($id) | |
offsetGet ($id) | |
offsetSet ($id, $value) | |
offsetUnset ($id) | |
rewind () | |
current () | |
key () | |
next () | |
valid () | |
seek ($pos) | |
Protected Attributes | |
$_has | |
$_iterationPos = 0 | |
$_iterationMax = null | |
$_messageClass = 'Zend_Mail_Message' |
Definition at line 31 of file Abstract.php.
__construct | ( | $ | params ) | [abstract] |
Create instance with parameters
array | $params | mail reader specific parameters |
Zend_Mail_Storage_Exception |
Reimplemented in Zend_Mail_Storage_Folder_Maildir, Zend_Mail_Storage_Folder_Mbox, Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, Zend_Mail_Storage_Pop3, and Zend_Mail_Storage_Writable_Maildir.
__destruct | ( | ) |
Destructor calls close() and therefore closes the resource.
Definition at line 159 of file Abstract.php.
__get | ( | $ | var ) |
Getter for has-properties. The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop
The valid values for the has-properties are:
string | $var | property name |
Zend_Mail_Storage_Exception |
Reimplemented in Zend_Mail_Storage_Pop3.
Definition at line 75 of file Abstract.php.
close | ( | ) | [abstract] |
Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
Reimplemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, and Zend_Mail_Storage_Pop3.
count | ( | ) |
countMessages | ( | ) | [abstract] |
Count messages messages in current box/folder
Zend_Mail_Storage_Exception |
Reimplemented in Zend_Mail_Storage_Mbox, and Zend_Mail_Storage_Pop3.
current | ( | ) |
Iterator::current()
Definition at line 305 of file Abstract.php.
getCapabilities | ( | ) |
Get a full list of features supported by the specific mail lib and the server
Definition at line 95 of file Abstract.php.
getMessage | ( | $ | id ) | [abstract] |
Get a message with headers and body
$id | int number of message |
Reimplemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, and Zend_Mail_Storage_Pop3.
getNumberByUniqueId | ( | $ | id ) | [abstract] |
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 in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, and Zend_Mail_Storage_Pop3.
getRawContent | ( | $ | id, |
$ | part = null |
||
) | [abstract] |
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 in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, and Zend_Mail_Storage_Pop3.
getRawHeader | ( | $ | id, |
$ | part = null , |
||
$ | topLines = 0 |
||
) | [abstract] |
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 in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, and Zend_Mail_Storage_Pop3.
getSize | ( | $ | id = 0 ) |
[abstract] |
Get a list of messages with number and size
int | $id | number of message |
Reimplemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, and Zend_Mail_Storage_Pop3.
getUniqueId | ( | $ | id = null ) |
[abstract] |
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 in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, and Zend_Mail_Storage_Pop3.
key | ( | ) |
next | ( | ) |
noop | ( | ) | [abstract] |
Keep the resource alive.
Reimplemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, and Zend_Mail_Storage_Pop3.
offsetExists | ( | $ | id ) |
ArrayAccess::offsetExists()
int | $id |
Definition at line 230 of file Abstract.php.
offsetGet | ( | $ | id ) |
ArrayAccess::offsetGet()
int | $id |
Definition at line 248 of file Abstract.php.
offsetSet | ( | $ | id, |
$ | value | ||
) |
ArrayAccess::offsetSet()
id | $id | |
mixed | $value |
Zend_Mail_Storage_Exception |
Definition at line 262 of file Abstract.php.
offsetUnset | ( | $ | id ) |
ArrayAccess::offsetUnset()
int | $id |
Definition at line 278 of file Abstract.php.
removeMessage | ( | $ | id ) | [abstract] |
delete a message from current box/folder
Reimplemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Maildir, Zend_Mail_Storage_Mbox, Zend_Mail_Storage_Pop3, and Zend_Mail_Storage_Writable_Maildir.
rewind | ( | ) |
Iterator::rewind()
Rewind always gets the new count from the storage. Thus if you use the interfaces and your scripts take long you should use reset() from time to time.
Definition at line 293 of file Abstract.php.
seek | ( | $ | pos ) |
SeekableIterator::seek()
int | $pos |
OutOfBoundsException |
Definition at line 354 of file Abstract.php.
valid | ( | ) |
$_has [protected] |
array('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)
Definition at line 37 of file Abstract.php.