Mail/Storage/Writable/Interface.php
inherited
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Mail
- Subpackage
- Storage
- Version
- $Id: Interface.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Mail_Storage_Writable_Interface
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 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) : voidappend a new message to mail storage
| 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 |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
copyMessage(int $id, string | \Zend_Mail_Storage_Folder $folder) : nullcopy an existing message
| Name | Type | Description |
|---|---|---|
| $id | int | number of message |
| $folder | string | \Zend_Mail_Storage_Folder | name or instance of targer folder |
| Type | Description |
|---|---|
| null |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
createFolder(string $name, string | \Zend_Mail_Storage_Folder $parentFolder = null) : nullcreate 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
| 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 |
| Type | Description |
|---|---|
| null |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
moveMessage(int $id, string | \Zend_Mail_Storage_Folder $folder) : nullmove an existing message
| Name | Type | Description |
|---|---|---|
| $id | int | number of message |
| $folder | string | \Zend_Mail_Storage_Folder | name or instance of targer folder |
| Type | Description |
|---|---|
| null |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
removeFolder(string | \Zend_Mail_Storage_Folder $name) : nullremove a folder
| Name | Type | Description |
|---|---|---|
| $name | string | \Zend_Mail_Storage_Folder | name or instance of folder |
| Type | Description |
|---|---|
| null |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
renameFolder(string | \Zend_Mail_Storage_Folder $oldName, string $newName) : nullrename and/or move folder
The new name has the same restrictions as in createFolder()
| Name | Type | Description |
|---|---|---|
| $oldName | string | \Zend_Mail_Storage_Folder | name or instance of folder |
| $newName | string | new global name of folder |
| Type | Description |
|---|---|
| null |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
setFlags(int $id, array $flags) : voidset flags for message
NOTE: this method can't set the recent flag.
| Name | Type | Description |
|---|---|---|
| $id | int | number of message |
| $flags | array | new flags for message |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |