Controller: /nodeworx/mail/dovecot

Required Permissions

EMAIL

Action: dovecotGlobalSettings

Added in Version

6.7.1-1732

Description

Update Dovecot configuration settings.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
ssl	string	No*	off-insecure, on-insecure, required	required	Off prevents MSA port 465.
ssl_min_protocol	string	No*	TLSv1, TLSv1.1, TLSv1.2	TLSv1.2
ssl_cipher_list	string	No*		PROFILE=SYSTEM	This complex directive uses a colon-separated cipher-spec string consisting of OpenSSL cipher specifications to configure the Cipher Suite the client is permitted to negotiate in the SSL handshake phase.
default_process_limit	integer	No*		100

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

Action: dovecotSettings

Added in Version

6.3.0-1630

Description

Update Dovecot configuration settings.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
protocols	struct (string)	No*	imap, imaps, pop3, pop3s	[“pop3”,”pop3s”,”imap”,”imaps”]
imap_mail_max_userip_connections	integer	No*		10
pop3_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

4.7.0-339

Description

Magic function - test for failure mechanism.

Action: isRunning

Added in Version

4.7.0-339

Description

Checks if the service is running or not.

Sample Output

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

Action: isRunningOnNode

Added in Version

4.7.0-339

Description

Checks if the service is running on a specific node (Clustering only).

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
node_id	string	No*

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

Action: listGeneralName

Added in Version

4.7.0-339

Description

Lists the “normal” name - ie “web server” instead of “httpd”.

Sample Output

array (
  'status' => 0,
  'payload' => '##LG_DOVECOT##',
  'reply_code' => 205,
)

Action: listPortNumbers

Added in Version

4.7.0-339

Description

Lists a string of the port numbers that this service uses, comma-seperated.

Sample Output

array (
  'status' => 0,
  'payload' => '110, 995, 143, 993',
  'reply_code' => 205,
)

Action: listPortNumbersArray

Added in Version

4.7.0-339

Description

Lists array of port numbers and ranges that this service uses.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 => 110,
    1 => 995,
    2 => 143,
  ),
  'reply_code' => 205,
)

Action: listRequiredPermissions

Added in Version

4.7.0-339

Description

Lists an array of permissions required to control the service.

Sample Output

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

Action: listServiceInfo

Added in Version

4.7.0-339

Description

Lists the service name, ports, page, and status.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'id' => 'dovecot',
    'name' => '##LG_DOVECOT##',
    'ports' => '110, 995, 143, 993',
    'page' => '/nodeworx/mail/mda',
    'ctrl' => '/nodeworx/mail/dovecot',
    'is_running' => 1,
  ),
  'reply_code' => 205,
)

Action: listServiceName

Added in Version

4.7.0-339

Description

Lists the service name - ie “httpd” instead of “web server”.

Sample Output

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

Action: listServicePage

Added in Version

4.7.0-339

Description

Lists the page that controls the service.

Sample Output

array (
  'status' => 0,
  'payload' => '/nodeworx/mail/mda',
  'reply_code' => 205,
)

Action: reroute

Added in Version

4.7.0-339

Description

Action to re-route from the current controller to a different one.

Input Parameters

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, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, Ip, Ipv6, …

Action: restart

Added in Version

4.7.0-339

Description

Restart the service.

Action: restartOnNode

Added in Version

4.7.0-339

Description

Restarts the service on a specific node (Clustering only).

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
node_id	string	No*

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

Action: start

Added in Version

4.7.0-339

Description

Start the service.

Action: startOnBoot

Added in Version

6.3.0-1630

Description

Set pop3 start-on-boot status.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
mda_dovecot_startonboot	integer	No*	1, 0	1

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

Action: startOnNode

Added in Version

4.7.0-339

Description

Starts the service on a specific node (Clustering only).

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
node_id	string	No*

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

Action: stop

Added in Version

4.7.0-339

Description

Stop the service.

Action: stopOnNode

Added in Version

4.7.0-339

Description

Stops the service on a specific node (Clustering only).

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
node_id	string	No*

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

Action: syncDovecotSniHosts

Added in Version

6.3.0-1630

Description

Update the Dovecot SNI configuration.

Action: wait

Added in Version

8.1.3-2998

Description

Magic function - used to simulate a long-running process

Action: win

Added in Version

4.7.0-339

Description

Magic function - test for testing success mechanism.