__construct()
__destruct()
__get()
appendMessage()
close()
copyMessage()
count()
countMessages()
createFolder()
current()
getCapabilities()
getCurrentFolder()
getFolders()
getMessage()
getNumberByUniqueId()
getRawContent()
getRawHeader()
getSize()
getUniqueId()
key()
moveMessage()
next()
noop()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
removeFolder()
removeMessage()
renameFolder()
rewind()
seek()
selectFolder()
setFlags()
valid()
$currentFolder
$has
$iterationMax
$iterationPos
$knownFlags
$messageClass
$protocol
$searchFlags
__construct(array $params)
arraymail reader specific parameters
\Zend\Mail\Storage\Exception\RuntimeException |
|
|---|---|
\Zend\Mail\Storage\Exception\InvalidArgumentException |
|
\Zend\Mail\Protocol\Exception\RuntimeException |
__destruct()
| inherited_from | \Zend\Mail\Storage\AbstractStorage::__destruct() |
|---|
__get(string $var) : bool
The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop
The valid values for the has-properties are: - true if a feature is supported - false if a feature is not supported - null is it's not yet known or it can't be know if a feature is supported
| inherited_from | \Zend\Mail\Storage\AbstractStorage::__get() |
|---|
stringproperty name
\Zend\Mail\Storage\Exception\InvalidArgumentException |
|---|
boolsupported or notappendMessage(string $message, null | string | \Zend\Mail\Storage\Folder $folder, null | array $flags)
stringmessage as string or instance of message class
nullarrayset flags for new message, else a default set is used
\Zend\Mail\Storage\Exception\RuntimeException |
|---|
close()
If you need to control, when the resource is closed. Otherwise the destructor would call this.
copyMessage(int $id, string | \Zend\Mail\Storage\Folder $folder)
count() : int
| inherited_from | \Zend\Mail\Storage\AbstractStorage::count() |
|---|
intcountMessages(null $flags) : int
null
\Zend\Mail\Storage\Exception\RuntimeException |
|
|---|---|
\Zend\Mail\Protocol\Exception\RuntimeException |
intnumber of messagescreateFolder(string $name, string | \Zend\Mail\Storage\Folder $parentFolder)
This method also creates parent folders if necessary. Some mail storages may restrict, which folder may be used as parent or which chars may be used in the folder name
stringglobal name of folder, local name if $parentFolder is set
string\Zend\Mail\Storage\Folderparent folder for new folder, else root folder is parent
\Zend\Mail\Storage\Exception\RuntimeException |
|---|
current() : \Zend\Mail\Storage\Message
| inherited_from | \Zend\Mail\Storage\AbstractStorage::current() |
|---|
\Zend\Mail\Storage\Messagecurrent messagegetCapabilities() : array
| inherited_from | \Zend\Mail\Storage\AbstractStorage::getCapabilities() |
|---|
arraylist of features as array(feature_name => true|false[|null])getCurrentFolder() : \Zend\Mail\Storage\Folder
\Zend\Mail\Storage\Exception\ExceptionInterface |
|---|
\Zend\Mail\Storage\Folderinstance of current foldergetFolders(string $rootFolder) : \Zend\Mail\Storage\Folder
stringget folder structure for given folder, else root
\Zend\Mail\Storage\Exception\RuntimeException |
|
|---|---|
\Zend\Mail\Storage\Exception\InvalidArgumentException |
|
\Zend\Mail\Protocol\Exception\RuntimeException |
\Zend\Mail\Storage\Folderroot or wanted foldergetMessage(int $id) : \Zend\Mail\Storage\Message
intnumber of message
\Zend\Mail\Protocol\Exception\RuntimeException |
|---|
getNumberByUniqueId(string $id) : int
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()
stringunique id
\Zend\Mail\Storage\Exception\InvalidArgumentException |
|---|
intmessage numbergetRawContent(int $id, null | array | string $part) : string
intnumber of message
nullarraystringpath to part or null for message content
stringraw contentgetRawHeader(int $id, null | array | string $part, int $topLines) : string
intnumber of message
nullarraystringpath to part or null for message header
intinclude this many lines with header (after an empty line)
stringraw headergetSize(int $id) : int | array
intnumber of message
\Zend\Mail\Protocol\Exception\RuntimeException |
|---|
intarraysize of given message of list with all messages as array(num => size)getUniqueId(int | null $id) : array | string
if storage does not support unique ids it's the same as the message number
intnullmessage number
\Zend\Mail\Protocol\Exception\RuntimeException |
|---|
arraystringmessage number for given message or all messages as arraykey() : int
| inherited_from | \Zend\Mail\Storage\AbstractStorage::key() |
|---|
intid of current positionmoveMessage(int $id, string | \Zend\Mail\Storage\Folder $folder)
NOTE: IMAP has no native move command, thus it's emulated with copy and delete
intnumber of message
\Zend\Mail\Storage\Exception\RuntimeException |
|---|
next()
| inherited_from | \Zend\Mail\Storage\AbstractStorage::next() |
|---|
offsetExists(int $id) : bool
| inherited_from | \Zend\Mail\Storage\AbstractStorage::offsetExists() |
|---|
int
booloffsetGet(int $id) : \Zend\Mail\Storage\Message
| inherited_from | \Zend\Mail\Storage\AbstractStorage::offsetGet() |
|---|
int
\Zend\Mail\Storage\Messagemessage objectoffsetSet(mixed $id, mixed $value)
| inherited_from | \Zend\Mail\Storage\AbstractStorage::offsetSet() |
|---|
mixed
mixed
\Zend\Mail\Storage\Exception\RuntimeException |
|---|
offsetUnset(int $id) : bool
| inherited_from | \Zend\Mail\Storage\AbstractStorage::offsetUnset() |
|---|
int
boolsuccessremoveFolder(string | \Zend\Mail\Storage\Folder $name)
removeMessage(int $id)
If you're doing that from a web environment you should be careful and use a uniqueid as parameter if possible to identify the message.
intnumber of message
\Zend\Mail\Storage\Exception\RuntimeException |
|---|
renameFolder(string | \Zend\Mail\Storage\Folder $oldName, string $newName)
The new name has the same restrictions as in createFolder()
stringnew global name of folder
\Zend\Mail\Storage\Exception\RuntimeException |
|---|
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.
| inherited_from | \Zend\Mail\Storage\AbstractStorage::rewind() |
|---|
seek(int $pos)
| inherited_from | \Zend\Mail\Storage\AbstractStorage::seek() |
|---|
int
\Zend\Mail\Storage\Exception\OutOfBoundsException |
|---|
selectFolder(\Zend\Mail\Storage\Folder | string $globalName)
folder must be selectable!
\Zend\Mail\Storage\Exception\RuntimeException |
|
|---|---|
\Zend\Mail\Protocol\Exception\RuntimeException |
setFlags(int $id, array $flags)
NOTE: this method can't set the recent flag.
intnumber of message
arraynew flags for message
\Zend\Mail\Storage\Exception\RuntimeException |
|---|
valid() : bool
| inherited_from | \Zend\Mail\Storage\AbstractStorage::valid() |
|---|
bool$currentFolder : string
$has : array
| inherited_from | \Zend\Mail\Storage\AbstractStorage::$$has |
|---|
$iterationMax : null | int
| inherited_from | \Zend\Mail\Storage\AbstractStorage::$$iterationMax |
|---|
$iterationPos : int
| inherited_from | \Zend\Mail\Storage\AbstractStorage::$$iterationPos |
|---|
$knownFlags : array
$searchFlags : array