Detailed Description
Definition at line 48 of file Mbox.php.
Constructor & Destructor Documentation
Member Function Documentation
_getPos |
( |
$ |
id ) |
[protected] |
Get positions for mail message or throw exeption if id is invalid
- Parameters:
-
- Returns:
- array positions as in _positions
- Exceptions:
-
- See also:
- Zend_Mail_Storage_Exception
Definition at line 121 of file Mbox.php.
_isMboxFile |
( |
$ |
file, |
|
|
$ |
fileIsString = true |
|
) |
| [protected] |
check if given file is a mbox file
if $file is a resource its file pointer is moved after the first line
- Parameters:
-
resource | string | $file | stream resource of name of file |
bool | $fileIsString | file is string or resource |
- Returns:
- bool file is mbox file
Definition at line 250 of file Mbox.php.
_openMboxFile |
( |
$ |
filename ) |
[protected] |
Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
- Returns:
- void
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 336 of file Mbox.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()
- Parameters:
-
- Returns:
- int message number
- Exceptions:
-
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 402 of file Mbox.php.
getRawContent |
( |
$ |
id, |
|
|
$ |
part = null |
|
) |
| |
getRawHeader |
( |
$ |
id, |
|
|
$ |
part = null , |
|
|
$ |
topLines = 0 |
|
) |
| |
Get raw header of message or part
- Parameters:
-
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) |
- Returns:
- string raw header
- See also:
- Zend_Mail_Storage_Exception
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 176 of file Mbox.php.
Get a list of messages with number and size
- Parameters:
-
int | null | $id | number of message or null for all messages |
- Returns:
- int|array size of given message of list with all messages as array(num => size)
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 98 of file Mbox.php.
getUniqueId |
( |
$ |
id = null ) |
|
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.
- Parameters:
-
int | null | $id | message number |
- Returns:
- array|string message number for given message or all messages as array
- Exceptions:
-
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 380 of file Mbox.php.
The documentation for this class was generated from the following file:
- E:/E/GEAMP/www/openbiz/openbiz/others/Zend/Mail/Storage/Mbox.php