Controller: MailSimap

API Controller	/nodeworx/mail/simap
Required Permissions	["EMAIL"]

Action	Description
isRunning	Checks if the service is running or not.
isRunningOnNode	Checks if the service is running on a specific node (Clustering only).
listGeneralName	Lists the "normal" name - ie "web server" instead of "httpd".
listPortNumbers	Lists a string of the port numbers that this service uses, comma-seperated.
listPortNumbersArray	Lists array of port numbers and ranges that this service uses.
listRequiredPermissions	Lists an array of permissions required to control the service.
listServiceInfo	Lists the service name, ports, page, and status.
listServiceName	Lists the service name - ie "httpd" instead of "web server".
listServicePage	Lists the page that controls the service.
restart	Restarts the service.
restartOnNode	Restarts the service on a specific node (Clustering only).
start	Starts the service.
startOnBoot	Set secure imap4 start-on-boot status.
startOnNode	Starts the service on a specific node (Clustering only).
stop	Stops the service.
stopOnNode	Stops the service on a specific node (Clustering only).

Action: isRunning (Added in version 4.2.0-260)

Checks if the service is running or not.

Example Output

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

Action: isRunningOnNode (Added in version 4.3.0-290)

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

Input Parameters

Name	Type	Notes	Required?
node_id	string		No*
* indicates that it's actually required, but probably already has a valid default value

Action: listGeneralName (Added in version 4.2.0-260)

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

Example Output

array (
  'status' => 0,
  'payload' => '##LG_SECURE_IMAP##',
)

Action: listPortNumbers (Added in version 4.2.0-260)

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

Example Output

array (
  'status' => 0,
  'payload' => '993',
)

Action: listPortNumbersArray (Added in version 4.2.0-260)

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

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 993,
  ),
)

Action: listRequiredPermissions (Added in version 4.2.0-260)

Lists an array of permissions required to control the service.

Example Output

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

Action: listServiceInfo (Added in version 4.2.0-260)

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

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    'id' => 'imap4ssl',
    'name' => '##LG_SECURE_IMAP##',
    'ports' => '993',
    'page' => '/nodeworx/mail/mda',
    'ctrl' => '/nodeworx/mail/simap',
    'is_running' => 1,
  ),
)

Action: listServiceName (Added in version 4.2.0-260)

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

Example Output

array (
  'status' => 0,
  'payload' => 'imap4ssl',
)

Action: listServicePage (Added in version 4.2.0-260)

Lists the page that controls the service.

Example Output

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

Action: restart (Added in version 4.2.0-260)

Restarts the service.

Input Parameters

Name	Type	Notes	Required?
cascade_to_nodes	integer	Help Entry 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 Example Values 1	No

Action: restartOnNode (Added in version 4.3.0-290)

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

Input Parameters

Name	Type	Notes	Required?
node_id	string		No*
* indicates that it's actually required, but probably already has a valid default value

Action: start (Added in version 4.2.0-260)

Starts the service.

Input Parameters

Name	Type	Notes	Required?
cascade_to_nodes	integer	Help Entry 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 Example Values 1	No

Action: startOnBoot (Added in version 4.2.0-260)

Set secure imap4 start-on-boot status.

Input Parameters

Name	Type	Notes	Required?
mda_simap_startonboot	integer	Example Values 1, 0 Example Default Value 1	No*
cascade_to_nodes	integer	Help Entry 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 Example Values 1	No
* indicates that it's actually required, but probably already has a valid default value

Action: startOnNode (Added in version 4.3.0-290)

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

Input Parameters

Name	Type	Notes	Required?
node_id	string		No*
* indicates that it's actually required, but probably already has a valid default value

Action: stop (Added in version 4.2.0-260)

Stops the service.

Input Parameters

Name	Type	Notes	Required?
cascade_to_nodes	integer	Help Entry 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 Example Values 1	No

Action: stopOnNode (Added in version 4.3.0-290)

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

Input Parameters

Name	Type	Notes	Required?
node_id	string		No*
* indicates that it's actually required, but probably already has a valid default value