Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

array
$_files= 'array()'
data of found message files in maildir dir
array()
Details
array
$_knownFlags= 'array('D' => Zend_Mail_Storage::FLAG_DRAFT'
known flag chars in filenames
This list has to be in alphabetical order for setFlags()
array('D' => Zend_Mail_Storage::FLAG_DRAFT
Details
__construct(
array $params
)
:
void
Create instance with parameters Supported parameters are: - dirname dirname of mbox file
Name | Type | Description |
---|---|---|
$params | array | mail reader specific parameters |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

_getFileData(
int $id, string|null $field
=
null
)
:
string|array
Get one or all fields from file structure. Also checks if message is valid
Name | Type | Description |
---|---|---|
$id | int | message number |
$field | string|null | wanted field |
Type | Description |
---|---|
string|array | wanted field or all fields as array |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

_getMaildirFiles(
resource $dh, string $dirname, array $default_flags
=
array()
)
:
null
find all files in opened dir handle and add to maildir files
Name | Type | Description |
---|---|---|
$dh | resource | dir handle used for search |
$dirname | string | dirname of dir in $dh |
$default_flags | array | default flags for given dir |
Type | Description |
---|---|
null |

_isMaildir(
string $dirname
)
:
bool
check if a given dir is a valid maildir
Name | Type | Description |
---|---|---|
$dirname | string | name of dir |
Type | Description |
---|---|
bool | dir is valid maildir |

_openMaildir(
string $dirname
)
:
null
open given dir as current maildir
Name | Type | Description |
---|---|---|
$dirname | string | name of maildir |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

close(
)
:
void
Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.

countMessages(
$flags
=
null
)
:
int
Count messages all messages in current box
Name | Type | Description |
---|---|---|
$flags |
Type | Description |
---|---|
int | number of messages |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

getMessage(
int $id
)
:
\Zend_Mail_Message_File
Fetch a message
Name | Type | Description |
---|---|---|
$id | int | number of message |
Type | Description |
---|---|
\Zend_Mail_Message_File |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

getNumberByUniqueId(
string $id
)
:
int
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()
Name | Type | Description |
---|---|---|
$id | string | unique id |
Type | Description |
---|---|
int | message number |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

getRawHeader(
$id, $part
=
null, $topLines
=
0
)
:
void
Name | Type | Description |
---|---|---|
$id | ||
$part | ||
$topLines |

getSize(
int|null $id
=
null
)
:
int|array
Get a list of messages with number and size
Name | Type | Description |
---|---|---|
$id | int|null | number of message or null for all messages |
Type | Description |
---|---|
int|array | size of given message of list with all messages as array(num => size) |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

getUniqueId(
int|null $id
=
null
)
:
array|string
get unique id for one or all messages
if storage does not support unique ids it's the same as the message number
Name | Type | Description |
---|---|---|
$id | int|null | message number |
Type | Description |
---|---|
array|string | message number for given message or all messages as array |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

removeMessage(
$id
)
:
null
stub for not supported message deletion
Name | Type | Description |
---|---|---|
$id |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |