Controller: EmailAlias

API Controller /siteworx/email/alias
Required Permissions ["EMAIL"]
Required Options E-mail Aliases
Action Description
add Add an e-mail alias.
delete Delete an e-mail alias.
edit Edit an e-mail alias.
list List e-mail aliases. DEPRECATED in version 4.8.0-393
listEmailAliases List e-mail aliases.

Action: add

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

Delete an e-mail alias.

Input Parameters

Name Type Notes Required?
username struct (string)
Example Values
poehler
 Yes

Action: edit

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

This action has been deprecated as of version 4.8.0-393.

MESSAGE: 2010-11-18 use listEmailAliases

List e-mail aliases.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => 'poehler',
      1 => 'poehler@example.com',
    ),
  ),
)

Action: listEmailAliases (Added in version 4.8.0-393)

List e-mail aliases.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'username' => 'poehler',
      'email' => 'poehler@example.com',
      'dest' => 'poehler@interworx.com',
    ),
  ),
)