Chapter 68: Controller: /siteworx/email Up Part III: SiteWorx API Spec Chapter 70: Controller: /siteworx/email/autorespond 

69 Controller: /siteworx/email/alias

Required Permissions "EMAIL"
Required Options E-mail Aliases
Action: add
Added in version 4.7.0-339
Description Add an e-mail alias.
Input Parameters
Name Type Notes Required?
username string Yes
forwardsto string Example Values
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
Yes
Action: delete
Added in version 4.7.0-339
Description Delete an e-mail alias.
Input Parameters
Name Type Notes Required?
username struct (string) Example Values
poehler
Yes
Action: edit
Added in version 4.7.0-339
Description Edit an e-mail alias.
Input Parameters
Name Type Notes Required?
username string Example Values
poehler
Yes
forwardsto string Example Values
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
Example Default Value
poehler@interworx.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: list
Added in version 4.7.0-339
Description List e-mail aliases.
Warning This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listEmailAliases
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’poehler’,
1 => ’poehler@example.com’,
),
),
)
Action: listEmailAliases
Added in version 4.8.0-393
Description List e-mail aliases.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’username’ => ’poehler’,
’email’ => ’poehler@example.com’,
’dest’ => ’poehler@interworx.com’,
),
),
)
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
username string Example Values
poehler
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’domain’ => ’example.com’,
’disabled_username’ => ’poehler’,
’forwardsto’ => ’poehler@interworx.com’,
’username’ => ’poehler’,
),
)
 Chapter 68: Controller: /siteworx/email Up Part III: SiteWorx API Spec Chapter 70: Controller: /siteworx/email/autorespond 

(C) 2017 by InterWorx LLC