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.

string
$_messageClass= ''Zend_Mail_Message_File''
used message class, change it in an extened class to extend the returned message class
'Zend_Mail_Message_File'
Details
__construct(
array $params
)
:
void
Create instance with parameters Supported parameters are: - filename filename of mbox file
Name | Type | Description |
---|---|---|
$params | array | mail reader specific parameters |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

__sleep(
)
:
array
magic method for serialize()
with this method you can cache the mbox class
Type | Description |
---|---|
array | name of variables |

__wakeup(
)
:
null
magic method for unserialize()
with this method you can cache the mbox class for cache validation the mtime of the mbox file is used
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

_getPos(
int $id
)
:
array
Get positions for mail message or throw exeption if id is invalid
Name | Type | Description |
---|---|---|
$id | int | number of message |
Type | Description |
---|---|
array | positions as in _positions |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

_isMboxFile(
resource|string $file, bool $fileIsString
=
true
)
:
bool
check if given file is a mbox file
if $file is a resource its file pointer is moved after the first line
Name | Type | Description |
---|---|---|
$file | resource|string | stream resource of name of file |
$fileIsString | bool | file is string or resource |
Type | Description |
---|---|
bool | file is mbox file |

_openMboxFile(
string $filename
)
:
null
open given file as current mbox file
Name | Type | Description |
---|---|---|
$filename | string | filename of mbox file |
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(
)
:
int
Count messages all messages in current box
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
=
0
)
:
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) |

getUniqueId(
int|null $id
=
null
)
:
array|string
get unique id for one or all messages
Mbox does not support unique ids (yet) - it's always the same as the message number. That shouldn't be a problem, because we can't change mbox files. Therefor the message number is save enough.
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 |