Controller: /nodeworx/mail/msa
==============================

:Required Permissions: EMAIL

Action: ``convertToSubmission``
-------------------------------

:Added in Version: 6.7.1-1732
:Description: Enable Dovecot submission server.

Action: ``dovecotMsaSettings``
------------------------------

:Added in Version: 6.7.1-1732
:Description: Update Dovecot submission server configuration settings.

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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``protocols``
     - struct (string)
     - No*
     - submission, submission-legacy
     - ["submission"]
     - Enables Dovecot submission server. Allows port 465 and 587 smtp.
   * - ``custom_submission_port``
     - integer
     - No*
     - 
     - 0
     - The custom submission port allows you to define an alternate port to enable SMTP Submission Service on. - *0 means disabled*
   * - ``custom_submission_port_ssl``
     - string
     - No*
     - yes, no
     - yes
     - If "Yes" the alternate port SMTP Submission Service will require explicit SSL. If "No" the alternate port service will utilize STARTTLS for encryption.
   * - ``mail_max_userip_connections``
     - integer
     - No*
     - 
     - 10
     - 

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

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