Chapter 28: Controller: /nodeworx/mail/mta Up Part II: NodeWorx API Spec Chapter 30: Controller: /nodeworx/mail/queue 

29 Controller: /nodeworx/mail/pop3

Required Permissions "EMAIL"
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,
)
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 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.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_POP3##’,
)
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’,
)
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,
),
)
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’,
),
)
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’ => ’pop3’,
’name’ => ’##LG_POP3##’,
’ports’ => ’110’,
’page’ => ’/nodeworx/mail/mda’,
’ctrl’ => ’/nodeworx/mail/pop3’,
’is_running’ => 1,
),
)
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’ => ’pop3’,
)
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’,
)
Action: queryUpdate
Added in version 5.1.0-838
Description Displays the information available to the action "update".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’pop3_version’ => ’1.03 (qmail-pop3d)’,
’pop3_mem_limit’ => ’256000000’,
’pop3_max_connections’ => ’200’,
’pop3_secure_mem_limit’ => ’256000000’,
’pop3_secure_max_connections’ => ’40’,
),
)
Action: restart
Added in version 4.7.0-339
Description 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.7.0-339
Description 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.7.0-339
Description 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.7.0-339
Description Set pop3 start-on-boot status.
Input Parameters
Name Type Notes Required?
mda_pop_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.7.0-339
Description 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.7.0-339
Description 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.7.0-339
Description 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
Action: update
Added in version 4.7.0-339
Description Update POP3 server settings.
Input Parameters
Name Type Notes Required?
pop3_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
pop3_max_connections integer Example Default Value
200
No*
pop3_secure_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
pop3_secure_max_connections integer Example Default Value
40
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
 Chapter 28: Controller: /nodeworx/mail/mta Up Part II: NodeWorx API Spec Chapter 30: Controller: /nodeworx/mail/queue 

(C) 2017 by InterWorx LLC