Chapter 72: Controller: /siteworx/email/autorespond Up Part III: SiteWorx API Spec Chapter 74: Controller: /siteworx/email/domainkeys 

73 Controller: /siteworx/email/box

Required Permissions "EMAIL"
Required Options E-mail Boxes
Action: add
Added in version 4.7.0-339
Description Add an e-mail box.
Input Parameters
Name Type Notes Required?
username string Yes
password string Yes
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
Yes
diskspacequota integer Description
Megabytes
Example Default Value
999999999
No*
copyto struct (string) Example Values
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
No
groups struct (string) Example Values
mygroup
No
* 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 Notes Required?
username struct (string) Example Values
postmaster
Yes
Action: edit
Added in version 4.7.0-339
Description Edit an e-mail box.
Input Parameters
Name Type Notes Required?
username string Example Values
postmaster
Yes
password string No
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
No
diskspacequota integer Description
Megabytes
Example Default Value
999999999
No*
copyto struct (string) Example Values
poehler@example.com, mygroup@example.com, myautoresponder@example.com
No
groups struct (string) Example Values
mygroup
No
onvacation integer Example Values
1, 0
Example Default Value
0
No*
vacation_message 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 => ’postmaster@example.com’,
),
),
)
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’ => ’postmaster@example.com’,
’quota’ => ’##LG_NOQUOTA##’,
’quota_bytes’ => 0,
’copyto’ =>
array (
),
’on_vacation’ => false,
’box_size’ => ’53248’,
’box_pct’ => 0,
),
),
)
Action: reroute
Added in version n/a
Description Action to re-route from the current controller to a different one.
Input Parameters
Name Type Notes Required?
controller string Example Values
Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsSlave, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Simplescripts, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, Backup, BackupSchedule, Prefs, Notice, Logout
Yes
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 72: Controller: /siteworx/email/autorespond Up Part III: SiteWorx API Spec Chapter 74: Controller: /siteworx/email/domainkeys 

(C) 2018 by InterWorx LLC