Chapter 32: Controller: /nodeworx/mail/simap Up Part II: NodeWorx API Spec Chapter 34: Controller: /nodeworx/mail/smtp2 

33 Controller: /nodeworx/mail/smtp

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_SMTPSERVER##’,
)
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’ => ’25’,
)
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 => 25,
),
)
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’ => ’smtp’,
’name’ => ’##LG_SMTPSERVER##’,
’ports’ => ’25’,
’page’ => ’/nodeworx/mail/mta’,
’ctrl’ => ’/nodeworx/mail/smtp’,
’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’ => ’smtp’,
)
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/mta’,
)
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 (
’version’ => ’1.03 (qmail)’,
’primary_smtp_port’ => ’25’,
’auth_mode’ => ’auth_optional/tls_optional’,
),
)
Action: queryUpdateInbound
Added in version 5.1.0-838
Description Displays the information available to the action "updateInbound".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’smtp_greeting’ => ’p1.unit.interworx.com InterWorx-CP SMTP Server’,
’concurrency_incoming’ => ’20’,
’timeout_smtpd’ => ’1200’,
’databytes’ => ’20’,
’mta_level_outgoing_email_address_blacklist’ =>
array (
),
’mta_level_email_address_blacklist’ =>
array (
0 => ’.*\\ @.*’,
1 => ’!.*@.*\\..*’,
2 => ’.*%.*’,
),
’realtime_sbl_blacklists’ =>
array (
0 => ’bl.spamcop.net’,
),
),
)
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: 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 Change the auth settings for the primary SMTP server.
Input Parameters
Name Type Notes Required?
auth_mode string Example Values
auth_no/tls_no, auth_no/tls_optional, auth_optional/tls_no, auth_withtls/tls_optional, auth_optional/tls_optional
Example Default Value
auth_optional/tls_optional
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: updateInbound
Added in version 4.7.0-339
Description Update misc inbound mail server settings.
Input Parameters
Name Type Notes Required?
smtp_greeting string Help Entry
The SMTP greeting shown to mail servers when they connect to the SMTP daemon on this server. This must begin with a fully qualified domain name (FQDN) per RFC 2821.
Example Default Value
p1.unit.interworx.com InterWorx-CP SMTP Server
No*
concurrency_incoming integer Help Entry
The total number of inbound remote connections allowed simultaneously.
Example Default Value
20
No*
timeout_smtpd integer Description
In Seconds
Help Entry
The max seconds to wait for communication for inbound SMTP connections.
Example Default Value
1200
No*
databytes integer Description
MB, (0 is Unlimited)
Help Entry
Maximum filesize (in megabytes) allowed for incoming messages
Example Default Value
20
No*
mta_level_outgoing_email_address_blacklist struct (string) No
mta_level_email_address_blacklist struct (string) Help Entry
The MTA level blacklist allows you to blacklist e-mail addresses at a very low level so they are denied before further processing takes place.
Example Default Value
[".*\\ @.*","!.*@.*\\..*",".*%.*"]
No
realtime_sbl_blacklists struct (string) Example Default Value
["bl.spamcop.net"]
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 32: Controller: /nodeworx/mail/simap Up Part II: NodeWorx API Spec Chapter 34: Controller: /nodeworx/mail/smtp2 

(C) 2017 by InterWorx LLC