Magento 2 Documentation
2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
|
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) | |
Definition at line 32 of file Interface.php.
appendMessage | ( | $message, | |
$folder = null , |
|||
$flags = null |
|||
) |
append a new message to mail storage
string | Zend_Mail_Message | Zend_Mime_Message | $message | message as string or instance of message class |
null | string | Zend_Mail_Storage_Folder | $folder | folder for new message, else current folder is taken |
null | array | $flags | set flags for new message, else a default set is used |
Zend_Mail_Storage_Exception |
Implemented in Zend_Mail_Storage_Imap.
copyMessage | ( | $id, | |
$folder | |||
) |
copy an existing message
int | $id | number of message |
string | Zend_Mail_Storage_Folder | $folder | name or instance of targer folder |
Zend_Mail_Storage_Exception |
Implemented in Zend_Mail_Storage_Writable_Maildir, and Zend_Mail_Storage_Imap.
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
string | $name | global name of folder, local name if $parentFolder is set |
string | Zend_Mail_Storage_Folder | $parentFolder | parent folder for new folder, else root folder is parent |
Zend_Mail_Storage_Exception |
Implemented in Zend_Mail_Storage_Imap, and Zend_Mail_Storage_Writable_Maildir.
moveMessage | ( | $id, | |
$folder | |||
) |
move an existing message
int | $id | number of message |
string | Zend_Mail_Storage_Folder | $folder | name or instance of targer folder |
Zend_Mail_Storage_Exception |
Implemented in Zend_Mail_Storage_Writable_Maildir, and Zend_Mail_Storage_Imap.
removeFolder | ( | $name | ) |
remove a folder
string | Zend_Mail_Storage_Folder | $name | name or instance of folder |
Zend_Mail_Storage_Exception |
Implemented in Zend_Mail_Storage_Imap, and Zend_Mail_Storage_Writable_Maildir.
renameFolder | ( | $oldName, | |
$newName | |||
) |
rename and/or move folder
The new name has the same restrictions as in createFolder()
string | Zend_Mail_Storage_Folder | $oldName | name or instance of folder |
string | $newName | new global name of folder |
Zend_Mail_Storage_Exception |
Implemented in Zend_Mail_Storage_Imap, and Zend_Mail_Storage_Writable_Maildir.
setFlags | ( | $id, | |
$flags | |||
) |
set flags for message
NOTE: this method can't set the recent flag.
int | $id | number of message |
array | $flags | new flags for message |
Zend_Mail_Storage_Exception |
Implemented in Zend_Mail_Storage_Writable_Maildir, and Zend_Mail_Storage_Imap.