Controller: /siteworx/email/alias
=================================

:Required Permissions: EMAIL
:Required Options: Email Aliases

Action: ``add``
---------------

:Added in Version: 4.7.0-339
:Description: Add an e-mail alias.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``username``
     - string
     - Yes
     - 
     - 
     - 
   * - ``forwardsto``
     - string
     - Yes
     - postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
     - 
     - 

Action: ``delete``
------------------

:Added in Version: 4.7.0-339
:Description: Delete an e-mail alias.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``username``
     - struct (string)
     - Yes
     - poehler
     - 
     - 

Action: ``edit``
----------------

:Added in Version: 4.7.0-339
:Description: Edit an e-mail alias.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``username``
     - string
     - Yes
     - poehler
     - 
     - 
   * - ``forwardsto``
     - string
     - No*
     - postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
     - poehler@interworx.com
     - 

\* 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 aliases.

.. warning::

   This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listEmailAliases


Sample Output
^^^^^^^^^^^^^

.. code-block::

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


Action: ``listEmailAliases``
----------------------------

:Added in Version: 4.8.0-393
:Description: List e-mail aliases.

Sample Output
^^^^^^^^^^^^^

.. code-block::

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


Action: ``queryEdit``
---------------------

:Added in Version: 5.1.0-838
:Description: Displays the information available to the action "edit".

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``username``
     - string
     - Yes
     - poehler
     - 
     - 

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'domain' => 'example.com',
       'disabled_username' => 'poehler',
       'forwardsto' => 'poehler@interworx.com',
       'username' => 'poehler',
     ),
     'reply_code' => 205,
   )


Action: ``reroute``
-------------------

:Added in Version: n/a
:Description: Action to re-route from the current controller to a different one.

Action: ``wait``
----------------

:Added in Version: 8.1.3-2998
:Description: Magic function - used to simulate a long-running process

Action: ``win``
---------------

:Added in Version: n/a
:Description: Magic function - test for testing success mechanism.