API Documentation

Mail/Storage/Writable/Interface.php

Interfaces
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mail
subpackage
Storage
version
$Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces
Zend_Mail_Storage_Writable_Interface

Description

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.

Zend_Mail_Storage_Writable_Interface
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mail
subpackage
Storage
Methods
createFolder
removeFolder
renameFolder
appendMessage
copyMessage
moveMessage
setFlags

Description

Methods

appendMessage
jump to class

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

append a new message to mail storage

Arguments
$message
stringZend_Mail_MessageZend_Mime_Message
message as string or instance of message class
$folder
nullstringZend_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
Details
visibility
public
final
false
static
false
throws

copyMessage
jump to class

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

copy an existing message

Arguments
$id
int
number of message
$folder
stringZend_Mail_Storage_Folder
name or instance of targer folder
Output
null
Details
visibility
public
final
false
static
false
throws

createFolder
jump to class

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

Arguments
$name
string
global name of folder, local name if $parentFolder is set
$parentFolder
stringZend_Mail_Storage_Folder
parent folder for new folder, else root folder is parent
Output
null
Details
visibility
public
final
false
static
false
throws

moveMessage
jump to class

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

move an existing message

Arguments
$id
int
number of message
$folder
stringZend_Mail_Storage_Folder
name or instance of targer folder
Output
null
Details
visibility
public
final
false
static
false
throws

removeFolder
jump to class

removeFolder( string|Zend_Mail_Storage_Folder $name ) : null

remove a folder

Arguments
$name
stringZend_Mail_Storage_Folder
name or instance of folder
Output
null
Details
visibility
public
final
false
static
false
throws

renameFolder
jump to class

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()

Arguments
$oldName
stringZend_Mail_Storage_Folder
name or instance of folder
$newName
string
new global name of folder
Output
null
Details
visibility
public
final
false
static
false
throws

setFlags
jump to class

setFlags( int $id, array $flags ) :

set flags for message

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

Arguments
$id
int
number of message
$flags
array
new flags for message
Details
visibility
public
final
false
static
false
throws
Documentation was generated by DocBlox.