Prev Chapter 30: Controller: /nodeworx/mail/queue
Up Part II: NodeWorx API Spec
Chapter 32: Controller: /nodeworx/mail/simap Next
31 Controller: /nodeworx/mail/send
Required Permissions "EMAIL"
Added in version 4.7.0-339
Description Magic function - test for failure mechanism.
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (’status’ => 0,
’payload’ => true,
)
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 | |||
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_OUTBOUND_MAIL##’,
)
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’ => ’##LG_NOT_APPLICABLE##’,
)
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 => ’##LG_NOT_APPLICABLE##’,
),
)
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’,
),
)
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (’status’ => 0,
’payload’ =>
array (
’id’ => ’send’,
’name’ => ’##LG_OUTBOUND_MAIL##’,
’ports’ => ’##LG_NOT_APPLICABLE##’,
’page’ => ’/nodeworx/mail/mta’,
’ctrl’ => ’/nodeworx/mail/send’,
’is_running’ => 1,
),
)
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (’status’ => 0,
’payload’ => ’send’,
)
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (’status’ => 0,
’payload’ => ’/nodeworx/mail/mta’,
)
Added in version 5.1.0-838
Description Displays the information available to the action "update".
Sample output
array (’status’ => 0,
’payload’ =>
array (
’concurrency_remote’ => ’255’,
’timeout_remote’ => ’600’,
’timeout_connect’ => ’60’,
’queue_lifetime’ => ’604800’,
’smtp_routes’ =>
array (
),
),
)
Added in version 4.7.0-339
Description Action to re-route from the current controller to a different one.
Input Parameters
| Name | Type | Notes | Required? |
| controller | string |
Example Values Index, Overview, Users, Lang, Themes, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Simplescripts, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailPop3, MailSpop3, MailImap, MailSimap, MailSpam, MailVirus, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, ... |
Yes |
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 |
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 | |||
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 |
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 | |||
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 |
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 | |||
Added in version 4.7.0-339
Description Update misc outbound mail server settings.
Input Parameters
| Name | Type | Notes | Required? |
| concurrency_remote | integer |
Help Entry The concurrency remote tells Qmail the maximum number of outbound connections that it can have open at any one time. Example Default Value 255 |
No* |
| timeout_remote | integer |
Description In Seconds Help Entry "Timeout Remote" changes the amount of time that Qmail will wait for a remote connection to respond to most communications. Example Default Value 600 |
No* |
| timeout_connect | integer |
Description In Seconds Help Entry "Timeout Connect" changes the amount of time that Qmail will wait for a remote connection to an SMTP server. Example Default Value 60 |
No* |
| queue_lifetime | integer |
Description In Seconds Help Entry Queue lifetime limits the number of seconds that a mail entry will live in the queue before it is delivered or purged. Example Default Value 604800 |
No* |
| smtp_routes | struct (string) |
Help Entry Artificial SMTP routes. If the domain matches the host, qmail-remote will connect to relay, as if host had relay as its only MX Record. The syntax for this field is [domain]:[destination server] and [domain] may be blank if you want all mail to be routed to [destination server] |
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 | |||
Added in version 4.7.0-339
Description Magic function - test for testing success mechanism.
Prev Chapter 30: Controller: /nodeworx/mail/queue
Up Part II: NodeWorx API Spec
Chapter 32: Controller: /nodeworx/mail/simap Next
(C) 2018 by InterWorx LLC