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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
No* |
example.com, sub.example.com, pointer.com, secondary.com |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
No* |
example.com, sub.example.com, pointer.com, secondary.com |
* indicates that it’s actually required, but probably already has a valid default value.
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
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' => 'apidocs.interworx.com',
'double_bounce_messages' => '1',
'double_bounce_to' => 'postmaster',
'double_bounce_host' => 'apidocs.interworx.com',
),
'reply_code' => 205,
)
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' => 'apidocs.interworx.com',
'default_domain' => 'apidocs.interworx.com',
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, … |
Action: updateBounce
¶
- Added in Version
4.7.0-339
- Description
Update the mail server “bounce” settings.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
MAILER-DAEMON |
The email address / user that bounced messages are sent as. |
|
|
string |
No* |
apidocs.interworx.com |
The hostname or IP that bounced messages are sent as. |
|
|
integer |
No* |
1, 0 |
1 |
Setting this to ‘yes’ will allow Qmail to double bounce email messages. |
|
string |
No* |
postmaster |
The email address to double bounce messages to. |
|
|
string |
No* |
apidocs.interworx.com |
The hostname or IP that double bounced messages are sent as. |
|
|
integer |
No |
1 |
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 |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
apidocs.interworx.com |
The mail server hostname. |
|
|
string |
No |
apidocs.interworx.com |
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). |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
apidocs.interworx.com InterWorx-CP SMTP Server |
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. |
|
|
integer |
No* |
20 |
The total number of inbound remote connections allowed simultaneously. |
|
|
integer |
No* |
1200 |
The max seconds to wait for communication for inbound SMTP connections. - In Seconds |
|
|
integer |
No* |
20 |
Maximum filesize (in megabytes) allowed for incoming messages - MB, (0 is Unlimited) |
|
|
struct (string) |
No |
[“[!%#:*^(){}]”,”@.*@”,”@reject$”] |
MTA level outgoing blacklist, allows you to blacklist email addresses at a very low level so they are denied before further processing takes place. |
|
|
struct (string) |
No |
[“.*\ @.*”,”!.*@.*\..*”,”.*%.*”] |
The MTA level blacklist allows you to blacklist email addresses at a very low level so they are denied before further processing takes place. |
|
|
struct (string) |
No |
[“bl.spamcop.net”] |
||
|
integer |
No |
1 |
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 |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
255 |
The concurrency remote tells Qmail the maximum number of outbound connections that it can have open at any one time. |
|
|
integer |
No* |
600 |
“Timeout Remote” changes the amount of time that Qmail will wait for a remote connection to respond to most communications. - In Seconds |
|
|
integer |
No* |
60 |
“Timeout Connect” changes the amount of time that Qmail will wait for a remote connection to an SMTP server. - In Seconds |
|
|
integer |
No* |
604800 |
Queue lifetime limits the number of seconds that a mail entry will live in the queue before it is delivered or purged. - In Seconds |
|
|
struct (string) |
No |
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] |
||
|
integer |
No |
1 |
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 |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
1, 0 |
0 |
A graph showing the number of messages in the queue. |
* indicates that it’s actually required, but probably already has a valid default value.
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.