Controller: /siteworx/email/box¶
- Required Permissions
EMAIL
- Required Options
Email Boxes
Action: add
¶
- Added in Version
4.7.0-339
- Description
Add an e-mail box.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
|||
|
string |
Yes |
|||
|
string |
Yes |
Confirm the password field by providing it again. Must match the password provided. |
||
|
integer |
No |
1, 0 |
||
|
integer |
No* |
999999999 |
Megabytes |
|
|
struct (string) |
No |
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com |
||
|
struct (string) |
No |
mygroup |
* indicates that it’s actually required, but probably already has a valid default value.
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Delete an e-mail box.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
postmaster |
Action: edit
¶
- Added in Version
4.7.0-339
- Description
Edit an e-mail box.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
postmaster |
||
|
string |
No |
|||
|
string |
No |
Confirm the password field by providing it again. Must match the password provided. |
||
|
integer |
No |
1, 0 |
||
|
integer |
No* |
999999999 |
Megabytes |
|
|
struct (string) |
No |
poehler@example.com, mygroup@example.com, myautoresponder@example.com |
||
|
struct (string) |
No |
mygroup |
||
|
integer |
No* |
1, 0 |
0 |
|
|
integer |
No* |
1, 0 |
0 |
|
|
string |
No |
* indicates that it’s actually required, but probably already has a valid default value.
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: list
¶
- Added in Version
4.7.0-339
- Description
List e-mail boxes (pop/imap).
Warning
This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listEmailBoxes
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
0 => 'postmaster',
1 => '[email protected]',
),
),
'reply_code' => 205,
)
Action: listEmailBoxes
¶
- Added in Version
4.8.0-393
- Description
List e-mail boxes (pop/imap).
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'username' => 'postmaster',
'email' => '[email protected]',
'crypt_password' => '$6$kjlJCfEbpMxun1Z6$ZsbTCg7ANV/caa1usghgdbt2bnl3KGOSv4K2Y0alxkWI1yMzBl3abxjLJLP.I4tZo1gTzvcHTK.Qe3zjlaq1u.',
'quota' => '##LG_NOQUOTA##',
'quota_bytes' => 0,
'copyto' =>
array (
),
'disable_login' => false,
'on_vacation' => false,
'local_delivery' => true,
'box_size' => '271',
'box_pct' => 0,
),
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, EmailMailman, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.