category Zend
package Zend_Mail
subpackage Storage
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

append a new message to mail storage

appendMessage(string|\Zend_Mail_Message|\Zend_Mime_Message $message, null|string|\Zend_Mail_Storage_Folder $folder = null, null|array $flags = null

Parameters

$message

string\Zend_Mail_Message\Zend_Mime_Message

message as string or instance of message class

$folder

nullstring\Zend_Mail_Storage_Folder

folder for new message, else current folder is taken

$flags

nullarray

set flags for new message, else a default set is used

Exceptions

\Zend_Mail_Storage_Exception

copy an existing message

copyMessage(integer $id, string|\Zend_Mail_Storage_Folder $folder) : null

Parameters

$id

integer

number of message

$folder

string\Zend_Mail_Storage_Folder

name or instance of targer folder

Exceptions

\Zend_Mail_Storage_Exception

Returns

null

create a new folder

createFolder(string $name, string|\Zend_Mail_Storage_Folder $parentFolder = null) : null

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

Parameters

$name

string

global name of folder, local name if $parentFolder is set

$parentFolder

string\Zend_Mail_Storage_Folder

parent folder for new folder, else root folder is parent

Exceptions

\Zend_Mail_Storage_Exception

Returns

null

move an existing message

moveMessage(integer $id, string|\Zend_Mail_Storage_Folder $folder) : null

Parameters

$id

integer

number of message

$folder

string\Zend_Mail_Storage_Folder

name or instance of targer folder

Exceptions

\Zend_Mail_Storage_Exception

Returns

null

remove a folder

removeFolder(string|\Zend_Mail_Storage_Folder $name) : null

Parameters

$name

string\Zend_Mail_Storage_Folder

name or instance of folder

Exceptions

\Zend_Mail_Storage_Exception

Returns

null

rename and/or move folder

renameFolder(string|\Zend_Mail_Storage_Folder $oldName, string $newName) : null

The new name has the same restrictions as in createFolder()

Parameters

$oldName

string\Zend_Mail_Storage_Folder

name or instance of folder

$newName

string

new global name of folder

Exceptions

\Zend_Mail_Storage_Exception

Returns

null

set flags for message

setFlags(integer $id, array $flags) 

NOTE: this method can't set the recent flag.

Parameters

$id

integer

number of message

$flags

array

new flags for message

Exceptions

\Zend_Mail_Storage_Exception