Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
Zend_Mail_Storage_Writable_Interface Interface Reference
Inheritance diagram for Zend_Mail_Storage_Writable_Interface:
Zend_Mail_Storage_Imap Zend_Mail_Storage_Writable_Maildir

Public Member Functions

 createFolder ($name, $parentFolder=null)
 
 removeFolder ($name)
 
 renameFolder ($oldName, $newName)
 
 appendMessage ($message, $folder=null, $flags=null)
 
 copyMessage ($id, $folder)
 
 moveMessage ($id, $folder)
 
 setFlags ($id, $flags)
 

Detailed Description

Definition at line 32 of file Interface.php.

Member Function Documentation

◆ appendMessage()

appendMessage (   $message,
  $folder = null,
  $flags = null 
)

append a new message to mail storage

Parameters
string | Zend_Mail_Message | Zend_Mime_Message$messagemessage as string or instance of message class
null | string | Zend_Mail_Storage_Folder$folderfolder for new message, else current folder is taken
null | array$flagsset flags for new message, else a default set is used
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Imap.

◆ copyMessage()

copyMessage (   $id,
  $folder 
)

copy an existing message

Parameters
int$idnumber of message
string | Zend_Mail_Storage_Folder$foldername or instance of targer folder
Returns
null
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Writable_Maildir, and Zend_Mail_Storage_Imap.

◆ createFolder()

createFolder (   $name,
  $parentFolder = 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
string$nameglobal name of folder, local name if $parentFolder is set
string | Zend_Mail_Storage_Folder$parentFolderparent folder for new folder, else root folder is parent
Returns
null
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Imap, and Zend_Mail_Storage_Writable_Maildir.

◆ moveMessage()

moveMessage (   $id,
  $folder 
)

move an existing message

Parameters
int$idnumber of message
string | Zend_Mail_Storage_Folder$foldername or instance of targer folder
Returns
null
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Writable_Maildir, and Zend_Mail_Storage_Imap.

◆ removeFolder()

removeFolder (   $name)

remove a folder

Parameters
string | Zend_Mail_Storage_Folder$namename or instance of folder
Returns
null
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Imap, and Zend_Mail_Storage_Writable_Maildir.

◆ renameFolder()

renameFolder (   $oldName,
  $newName 
)

rename and/or move folder

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

Parameters
string | Zend_Mail_Storage_Folder$oldNamename or instance of folder
string$newNamenew global name of folder
Returns
null
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Imap, and Zend_Mail_Storage_Writable_Maildir.

◆ setFlags()

setFlags (   $id,
  $flags 
)

set flags for message

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

Parameters
int$idnumber of message
array$flagsnew flags for message
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Writable_Maildir, and Zend_Mail_Storage_Imap.


The documentation for this interface was generated from the following file: