Controller: /nodeworx/mail/mda
==============================

:Required Permissions: EMAIL

Action: ``convertToDovecot``
----------------------------

:Added in Version: 6.3.0-1630
:Description: Convert to dovecot.

Action: ``fail``
----------------

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

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, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, ...
     - 
     - 

Action: ``startOnBootIMAP4``
----------------------------

:Added in Version: 4.7.0-339
:Description: Deprecated.

.. warning::

   This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailImap::startOnBoot


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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``mda_imap_startonboot``
     - integer
     - No*
     - 1, 0
     - 0
     - 
   * - ``cascade_to_nodes``
     - integer
     - No
     - 1
     - 
     - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``startOnBootPop3``
---------------------------

:Added in Version: 4.7.0-339
:Description: Deprecated.

.. warning::

   This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailPop3::startOnBoot


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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``mda_pop_startonboot``
     - integer
     - No*
     - 1, 0
     - 0
     - 
   * - ``cascade_to_nodes``
     - integer
     - No
     - 1
     - 
     - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``startOnBootSIMAP4``
-----------------------------

:Added in Version: 4.7.0-339
:Description: Deprecated.

.. warning::

   This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSImap::startOnBoot


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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``mda_simap_startonboot``
     - integer
     - No*
     - 1, 0
     - 0
     - 
   * - ``cascade_to_nodes``
     - integer
     - No
     - 1
     - 
     - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``startOnBootSPOP3``
----------------------------

:Added in Version: 4.7.0-339
:Description: Deprecated.

.. warning::

   This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSpop3::startOnBoot


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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``mda_spop_startonboot``
     - integer
     - No*
     - 1, 0
     - 0
     - 
   * - ``cascade_to_nodes``
     - integer
     - No
     - 1
     - 
     - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``updateImap``
----------------------

:Added in Version: 4.7.0-339
:Description: Deprecated.

.. warning::

   This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailImap::update


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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``imap_mem_limit``
     - integer
     - No*
     - 
     - 256000000
     - (In Bytes)
   * - ``imap_max_connections``
     - integer
     - No*
     - 
     - 40
     - 
   * - ``imap_secure_mem_limit``
     - integer
     - No*
     - 
     - 256000000
     - (In Bytes)
   * - ``imap_secure_max_connections``
     - integer
     - No*
     - 
     - 40
     - 
   * - ``cascade_to_nodes``
     - integer
     - No
     - 1
     - 
     - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``updatePop3``
----------------------

:Added in Version: 4.7.0-339
:Description: Deprecated.

.. warning::

   This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailPop3::update


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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``pop3_mem_limit``
     - integer
     - No*
     - 
     - 256000000
     - (In Bytes)
   * - ``pop3_max_connections``
     - integer
     - No*
     - 
     - 200
     - 
   * - ``pop3_secure_mem_limit``
     - integer
     - No*
     - 
     - 256000000
     - (In Bytes)
   * - ``pop3_secure_max_connections``
     - integer
     - No*
     - 
     - 40
     - 
   * - ``cascade_to_nodes``
     - integer
     - No
     - 1
     - 
     - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually

\* indicates that it's actually required, but probably already has a valid default value.

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

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