Prev Chapter 70: Controller: /siteworx/email
Up Part III: SiteWorx API Spec
Chapter 72: Controller: /siteworx/email/autorespond Next
71 Controller: /siteworx/email/alias
Required Permissions "EMAIL"
Required Options E-mail Aliases
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 |
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 |
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 | |||
Added in version n/a
Description Magic function - test for failure mechanism.
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’,
),
),
)
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’,
),
),
)
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’,
),
)
Added in version n/a
Description Action to re-route from the current controller to a different one.
Added in version n/a
Description Magic function - test for testing success mechanism.
Prev Chapter 70: Controller: /siteworx/email
Up Part III: SiteWorx API Spec
Chapter 72: Controller: /siteworx/email/autorespond Next
(C) 2018 by InterWorx LLC