Chapter 27: Controller: /nodeworx/mail/mda Up Part II: NodeWorx API Spec Chapter 29: Controller: /nodeworx/mail/pop3 

28 Controller: /nodeworx/mail/mta

Required Permissions "EMAIL"
Action: disableLocalDelivery
Added in version 4.8.0-393
Description Bulk Disable local mail delivery for domains on the system.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
pointer.com, sub.example.com, example.com, secondary.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: enableLocalDelivery
Added in version 4.8.0-393
Description Bulk Enable local mail delivery for domains on the system.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
pointer.com, sub.example.com, example.com, secondary.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryUpdateBounce
Added in version 5.1.0-838
Description Displays the information available to the action "updateBounce".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’bounce_from’ => ’mailer-daemon’,
’bounce_host’ => ’p1.unit.interworx.com’,
’double_bounce_messages’ => ’0’,
’double_bounce_to’ => ’doublebounce’,
’double_bounce_host’ => ’p1.unit.interworx.com’,
),
)
Action: queryUpdateGeneral
Added in version 5.1.0-838
Description Displays the information available to the action "updateGeneral".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’mailserver_hostname’ => ’p1.unit.interworx.com’,
’default_domain’ => ’unit.interworx.com’,
),
)
Action: updateBounce
Added in version 4.7.0-339
Description Update the mail server "bounce" settings.
Input Parameters
Name Type Notes Required?
bounce_from string Help Entry
The email address / user that bounced messages are sent as.
Example Default Value
mailer-daemon
No*
bounce_host string Help Entry
The hostname or IP that bounced messages are sent as.
Example Default Value
p1.unit.interworx.com
No*
double_bounce_messages integer Help Entry
Setting this to ’yes’ will allow Qmail to double bounce e-mail messages.
Example Values
1, 0
Example Default Value
0
No*
double_bounce_to string Help Entry
The e-mail address to double bounce messages to.
Example Default Value
doublebounce
No*
double_bounce_host string Help Entry
The hostname or IP that double bounced messages are sent as.
Example Default Value
p1.unit.interworx.com
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: updateGeneral
Added in version 4.7.0-339
Description Update mail server default-domain and hostname.
Input Parameters
Name Type Notes Required?
mailserver_hostname string Help Entry
The mail server hostname.
Example Default Value
p1.unit.interworx.com
No*
default_domain string Help Entry
The default domain appending to any address that does not include a domain portion (i.e. a missing @domain.com will be translated to use the default domain).
Example Default Value
unit.interworx.com
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 Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSmtp::updateInbound
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
Action: updateOutbound
Added in version 4.7.0-339
Description Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSend::update
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
Action: updateRrd
Added in version 4.7.0-339
Description Show or hide the mail server RRD graph in the web interface.
Input Parameters
Name Type Notes Required?
rrd integer Help Entry
A graph showing the number of messages in the queue.
Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
 Chapter 27: Controller: /nodeworx/mail/mda Up Part II: NodeWorx API Spec Chapter 29: Controller: /nodeworx/mail/pop3 

(C) 2017 by InterWorx LLC