Controller: /nodeworx/mail/smtp¶
- Required Permissions
EMAIL
Action: fail
¶
- Added in Version
4.7.0-339
- Description
Magic function - test for failure mechanism.
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,
'reply_code' => 205,
)
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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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##',
'reply_code' => 205,
)
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',
'reply_code' => 205,
)
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,
),
'reply_code' => 205,
)
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',
),
'reply_code' => 205,
)
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,
),
'reply_code' => 205,
)
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',
'reply_code' => 205,
)
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',
'reply_code' => 205,
)
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',
),
'reply_code' => 205,
)
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' => 'apidocs.interworx.com InterWorx-CP SMTP Server',
'concurrency_incoming' => '20',
'timeout_smtpd' => '1200',
'databytes' => '20',
'mta_level_outgoing_email_address_blacklist' =>
array (
0 => '[!%#:*^(){}]',
1 => '@.*@',
2 => '@reject$',
),
'mta_level_email_address_blacklist' =>
array (
0 => '.*\\ @.*',
1 => '!.*@.*\\..*',
2 => '.*%.*',
),
'realtime_sbl_blacklists' =>
array (
0 => 'bl.spamcop.net',
),
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
4.7.0-339
- 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: restart
¶
- Added in Version
4.7.0-339
- Description
Restart the service.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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 |
Action: restartOnNode
¶
- Added in Version
4.7.0-339
- Description
Restarts the service on a specific node (Clustering only).
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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
Start the service.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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 |
Action: startOnNode
¶
- Added in Version
4.7.0-339
- Description
Starts the service on a specific node (Clustering only).
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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
Stop the service.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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 |
Action: stopOnNode
¶
- Added in Version
4.7.0-339
- Description
Stops the service on a specific node (Clustering only).
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
auth_no/tls_no, auth_no/tls_optional, auth_optional/tls_no, auth_withtls/tls_optional, auth_optional/tls_optional |
auth_optional/tls_optional |
|
|
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: updateInbound
¶
- Added in Version
4.7.0-339
- Description
Update misc inbound mail server settings.
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: win
¶
- Added in Version
4.7.0-339
- Description
Magic function - test for testing success mechanism.