| Fully Qualified Name: | Laminas\Mail\Storage\Writable\Maildir |
| Extends: | Maildir |
| Implements: | WritableInterface |
| Name | Description | Defined By |
|---|---|---|
| __construct() | Create instance with parameters Additional parameters are (see parent for more): - create if true a new maildir is create if none exists | Maildir |
| appendMessage() | append a new message to mail storage | Maildir |
| checkQuota() | check if storage is currently over quota | Maildir |
| copyMessage() | copy an existing message | Maildir |
| createFolder() | create a new folder | Maildir |
| getQuota() | get currently set quota | Maildir |
| initMaildir() | create a new maildir | Maildir |
| moveMessage() | move an existing message | Maildir |
| removeFolder() | remove a folder | Maildir |
| removeMessage() | stub for not supported message deletion | Maildir |
| renameFolder() | rename and/or move folder | Maildir |
| setFlags() | set flags for message | Maildir |
| setQuota() | enable/disable quota and set a quota value if wanted or needed | Maildir |
Create instance with parameters Additional parameters are (see parent for more): - create if true a new maildir is create if none exists
| Parameter Name | Type | Description |
|---|---|---|
| $params | ||
| $params |
Returns:
append a new message to mail storage
| Parameter Name | Type | Description |
|---|---|---|
| $message | string|resource | message |
| $folder | null|string|\Folder | folder |
| $flags | null|array | set |
| $recent | bool | handle |
Returns:
check if storage is currently over quota
| Parameter Name | Type | Description |
|---|---|---|
| $detailedResponse | bool | return |
| $forceRecalc | bool |
Returns: bool|array over quota state or detailed response
copy an existing message
| Parameter Name | Type | Description |
|---|---|---|
| $id | int | number |
| $folder | string|\Laminas\Mail\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|\Laminas\Mail\Storage\Folder | parent |
Returns: string only used internally (new created maildir)
get currently set quota
| Parameter Name | Type | Description |
|---|---|---|
| $fromStorage | bool |
Returns: bool|array
create a new maildir
If the given dir is already a valid maildir this will not fail.
| Parameter Name | Type | Description |
|---|---|---|
| $dir | string | directory |
Returns:
move an existing message
| Parameter Name | Type | Description |
|---|---|---|
| $id | int | number |
| $folder | string|\Laminas\Mail\Storage\Folder | name |
Returns:
remove a folder
| Parameter Name | Type | Description |
|---|---|---|
| $name | string|\Folder | name |
Returns:
stub for not supported message deletion
| Parameter Name | Type | Description |
|---|---|---|
| $id | ||
| $id |
Returns:
rename and/or move folder
The new name has the same restrictions as in createFolder()
| Parameter Name | Type | Description |
|---|---|---|
| $oldName | string|\Laminas\Mail\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:
enable/disable quota and set a quota value if wanted or needed
You can enable/disable quota with true/false. If you don't have a MDA or want to enforce a quota value you can also set this value here. Use array('size' => SIZE_QUOTA, 'count' => MAX_MESSAGE) do define your quota. Order of these fields does matter!
| Parameter Name | Type | Description |
|---|---|---|
| $value | bool|array | new |
Returns: