| Fully Qualified Name: | Zend\Mail\Storage\Writable\WritableInterface |
| Name | Description | Defined By |
|---|---|---|
| appendMessage() | append a new message to mail storage | WritableInterface |
| copyMessage() | copy an existing message | WritableInterface |
| createFolder() | create a new folder | WritableInterface |
| moveMessage() | move an existing message | WritableInterface |
| removeFolder() | remove a folder | WritableInterface |
| renameFolder() | rename and/or move folder | WritableInterface |
| setFlags() | set flags for message | WritableInterface |
append a new message to mail storage
| Parameter Name | Type | Description |
|---|---|---|
| $message | string|\Message|\Mime\Message | message |
| $folder | null|string|\Storage\Folder | folder |
| $flags | null|array | set |
Returns:
copy an existing message
| Parameter Name | Type | Description |
|---|---|---|
| $id | int | number |
| $folder | string|\Storage\Folder | name |
Returns:
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
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | global |
| $parentFolder | string|\Storage\Folder | parent |
Returns:
move an existing message
| Parameter Name | Type | Description |
|---|---|---|
| $id | int | number |
| $folder | string|\Storage\Folder | name |
Returns:
remove a folder
| Parameter Name | Type | Description |
|---|---|---|
| $name | string|\Storage\Folder | name |
Returns:
rename and/or move folder
The new name has the same restrictions as in createFolder()
| Parameter Name | Type | Description |
|---|---|---|
| $oldName | string|\Storage\Folder | name |
| $newName | string | new |
Returns:
set flags for message
NOTE: this method can't set the recent flag.
| Parameter Name | Type | Description |
|---|---|---|
| $id | int | number |
| $flags | array | new |
Returns: