Mail/Storage/Writable/Interface.php

Show:

inherited

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Mail
Subpackage: Storage
Version: $Id$

\Zend_Mail_Storage_Writable_Interface
jump to top

Package: Zend_Mail\Storage

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Methods

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

append a new message to mail storage

Parameters

Name	Type	Description
$message	string \| \Zend_Mail_Message \| \Zend_Mime_Message	message as string or instance of message class
$folder	null \| string \| \Zend_Mail_Storage_Folder	folder for new message, else current folder is taken
$flags	null \| array	set flags for new message, else a default set is used

Throws

Exception	Description
\Zend_Mail_Storage_Exception

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

copy an existing message

Parameters

Name	Type	Description
$id	int	number of message
$folder	string \| \Zend_Mail_Storage_Folder	name or instance of targer folder

Returns

Type	Description
null

Throws

Exception	Description
\Zend_Mail_Storage_Exception

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

create a new folder

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	Type	Description
$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

Returns

Type	Description
null

Throws

Exception	Description
\Zend_Mail_Storage_Exception

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

move an existing message

Parameters

Name	Type	Description
$id	int	number of message
$folder	string \| \Zend_Mail_Storage_Folder	name or instance of targer folder

Returns

Type	Description
null

Throws

Exception	Description
\Zend_Mail_Storage_Exception

removeFolder(string | \Zend_Mail_Storage_Folder $name) : null

remove a folder

Parameters

Name	Type	Description
$name	string \| \Zend_Mail_Storage_Folder	name or instance of folder

Returns

Type	Description
null

Throws

Exception	Description
\Zend_Mail_Storage_Exception

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

rename and/or move folder

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

Parameters

Name	Type	Description
$oldName	string \| \Zend_Mail_Storage_Folder	name or instance of folder
$newName	string	new global name of folder

Returns

Type	Description
null

Throws

Exception	Description
\Zend_Mail_Storage_Exception

setFlags(int $id, array $flags) : void

set flags for message

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

Parameters

Name	Type	Description
$id	int	number of message
$flags	array	new flags for message

Throws

Exception	Description
\Zend_Mail_Storage_Exception

Mail/Storage/Writable/Interface.php

\Zend_Mail_Storage_Writable_Interfacejump to top

Methods

\Zend_Mail_Storage_Writable_Interface
jump to top