Show or hide the mail server RRD graph in the web interface.
Action: disableLocalDelivery (Added in version 4.7.2-348)
Bulk Disable local mail delivery for domains on the system.
Input Parameters
Name
Type
Notes
Required?
domain
struct (string)
Example Values mydomain.com, example.com, sub.example.com, pointer.com, secondary.com
No*
* indicates that it's actually required, but probably already has a valid default value
Action: enableLocalDelivery (Added in version 4.7.2-348)
Bulk Enable local mail delivery for domains on the system.
Input Parameters
Name
Type
Notes
Required?
domain
struct (string)
Example Values mydomain.com, example.com, sub.example.com, pointer.com, secondary.com
No*
* indicates that it's actually required, but probably already has a valid default value
Action: updateBounce
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 messsages are sent as.
Example Default Value cos5-inst.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 1
No*
double_bounce_to
string
Help Entry The e-mail address to double bounce messages to.
Example Default Value postmaster
No*
double_bounce_host
string
Help Entry The hostname or IP that double bounced messsages are sent as.
Example Default Value cos5-inst.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
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 cos5-inst.interworx.com
No*
default_domain
string
Help Entry The default domain appending to any address that doesn't include a domain portion (i.e. a missing @domain.com will be translated to use the default domain).
Example Default Value interworx.com
No*
* indicates that it's actually required, but probably already has a valid default value
Action: updateInbound
This action has been deprecated as of version 4.2.0-260.
MESSAGE: Use Ctrl_Nodeworx_MailSmtp::updateInbound
Deprecated.
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.
Example Default Value InterWorx-CP SMTP Server
No*
concurrency_incoming
integer
Help Entry The total number of inbound remote connections allowed simultaenously.
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
This action has been deprecated as of version 4.2.0-260.
MESSAGE: Use Ctrl_Nodeworx_MailSend::update
Deprecated.
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 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 a 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
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
Controller: MailMta
updateInboundupdateOutboundAction: disableLocalDelivery (Added in version 4.7.2-348)
Bulk Disable local mail delivery for domains on the system.
Input Parameters
mydomain.com, example.com, sub.example.com, pointer.com, secondary.com
Action: enableLocalDelivery (Added in version 4.7.2-348)
Bulk Enable local mail delivery for domains on the system.
Input Parameters
mydomain.com, example.com, sub.example.com, pointer.com, secondary.com
Action: updateBounce
Update the mail server "bounce" settings.
Input Parameters
The email address / user that bounced messages are sent as.
MAILER-DAEMON
The hostname or IP that bounced messsages are sent as.
cos5-inst.interworx.com
Setting this to yes will allow Qmail to double bounce e-mail messages.
1, 0
1
The e-mail address to double bounce messages to.
postmaster
The hostname or IP that double bounced messsages are sent as.
cos5-inst.interworx.com
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
1
Action: updateGeneral
Update mail server default-domain and hostname.
Input Parameters
The mail server hostname.
cos5-inst.interworx.com
The default domain appending to any address that doesn't include a domain portion (i.e. a missing @domain.com will be translated to use the default domain).
interworx.com
Action: updateInbound
MESSAGE: Use Ctrl_Nodeworx_MailSmtp::updateInbound
Deprecated.
Input Parameters
The SMTP greeting shown to mail servers when they connect to the SMTP daemon on this server.
InterWorx-CP SMTP Server
The total number of inbound remote connections allowed simultaenously.
20
In Seconds
The max seconds to wait for communication for inbound SMTP connections.
1200
MB, (0 is Unlimited)
Maximum filesize (in megabytes) allowed for incoming messages
20
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.
[".*\ @.*","!.*@.*\..*",".*%.*"]
["bl.spamcop.net"]
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
1
Action: updateOutbound
MESSAGE: Use Ctrl_Nodeworx_MailSend::update
Deprecated.
Input Parameters
The concurrency remote tells Qmail the maximum number of outbound connections that it can have open at any one time.
255
In Seconds
Timeout remote changes the amount of time that Qmail will wait for a remote connection to respond most communications.
600
In Seconds
Timeout connect changes the amount of time that Qmail will wait for a remote connection to a SMTP server.
60
In Seconds
Queue lifetime limits the number of seconds that a mail entry will live in the queue before it is delivered or purged.
604800
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]
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
1
Action: updateRrd
Show or hide the mail server RRD graph in the web interface.
Input Parameters
A graph showing the number of messages in the queue.
1, 0
0