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

:Required Permissions: EMAIL
:Required Options: Email Aliases, Email Autoresponders, Email Boxes, Email Groups

Action: ``editBounce``
----------------------

:Added in Version: 4.7.0-339
:Description: Edit bounce action.

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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``enablebounce``
     - integer
     - No*
     - 1, 0
     - 1
     - This is where you can define what happens when an email is sent to an address at your domain that does not exist. The choices are:<br>1. Send a "bounce" message back to the sender informing them that the email address they sent to does not exist<br>2. Silently delete the message without informing the sender that the email address does not exist<br><br>

\* 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: ``queryEditBounce``
---------------------------

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

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

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'enablebounce' => '1',
     ),
     'reply_code' => 205,
   )


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

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

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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``controller``
     - string
     - Yes
     - Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, EmailMailman, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout
     - 
     - 

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

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