Controller: /siteworx/email/remotesetup¶
- Required Permissions
EMAIL
Action: addmx
¶
- Added in Version
4.7.0-339
- Description
Add an MX record.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
|||
|
string |
No* |
example.com |
||
|
integer |
No* |
43200 |
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - In Seconds |
|
|
integer |
Yes |
An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones. |
||
|
string |
Yes |
* indicates that it’s actually required, but probably already has a valid default value.
Action: deletemx
¶
- Added in Version
4.7.0-339
- Description
Delete an MX record.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (integer) |
Yes |
Action: disableLocalDelivery
¶
- Added in Version
4.8.0-393
- Description
Disables local delivery for specified domains.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
example.com, secondary.com, sub.example.com, pointer.com |
||
|
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: editmx
¶
- Added in Version
4.7.0-339
- Description
Edit an MX record.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
|||
|
string |
No* |
example.com |
||
|
integer |
No* |
43200 |
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - In Seconds |
|
|
integer |
No* |
10 |
An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones. |
|
|
string |
No* |
mail.example.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
Enables local delivery for specified domains.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
example.com, secondary.com, sub.example.com, pointer.com |
||
|
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: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: listLocalDeliveryStatus
¶
- Added in Version
4.8.0-393
- Description
Lists the status of local delivery for domains.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'domain' => 'example.com',
'domain_type' => 'master',
'master_domain' => 'example.com',
'is_template' => '0',
'status' => 1,
),
1 =>
array (
'domain' => 'pointer.com',
'domain_type' => 'redirect',
'master_domain' => 'example.com',
'is_template' => '0',
'status' => 1,
),
2 =>
array (
'domain' => 'secondary.com',
'domain_type' => 'slave',
'master_domain' => 'example.com',
'is_template' => '0',
'status' => 1,
),
),
'reply_code' => 205,
)
Action: listMxRecordIds
¶
- Added in Version
4.7.0-339
- Description
List domain MX records by id.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
0 => '21',
1 => 'example.com - Preference Number 10 mail.example.com',
),
1 =>
array (
0 => '49',
1 => 'pointer.com - Preference Number 10 mail.pointer.com',
),
2 =>
array (
0 => '60',
1 => 'secondary.com - Preference Number 10 mail.secondary.com',
),
),
'reply_code' => 205,
)
Action: listMxRecords
¶
- Added in Version
4.8.0-393
- Description
List MX Records for the SiteWorx account.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'record_id' => '21',
'zone_id' => '2',
'type' => 'MX',
'host' => 'example.com',
'target' => '10 mail.example.com',
'ttl' => '43200',
'last_update' => '1578808273',
'preference' => '10',
'mail_server' => 'mail.example.com',
),
1 =>
array (
'record_id' => '49',
'zone_id' => '4',
'type' => 'MX',
'host' => 'pointer.com',
'target' => '10 mail.pointer.com',
'ttl' => '43200',
'last_update' => '1578808273',
'preference' => '10',
'mail_server' => 'mail.pointer.com',
),
2 =>
array (
'record_id' => '60',
'zone_id' => '5',
'type' => 'MX',
'host' => 'secondary.com',
'target' => '10 mail.secondary.com',
'ttl' => '43200',
'last_update' => '1578808273',
'preference' => '10',
'mail_server' => 'mail.secondary.com',
),
),
'reply_code' => 205,
)
Action: localDelivery
¶
- Added in Version
4.7.0-339
- Description
Change whether this box accepts email locally for a domain.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
1, 0 |
1 |
|
|
integer |
No |
1, 0 |
0 |
When this options is selected, local delivery will be disabled for all domains on this account, otherwise only the current domain will have local delivery disabled. |
* indicates that it’s actually required, but probably already has a valid default value.
Action: queryEditmx
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “editmx”.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'host' => 'example.com',
'ttl' => '43200',
'preference' => '10',
'mail_server' => 'mail.example.com',
'record_id' => '21',
),
'reply_code' => 205,
)
Action: queryLocalDelivery
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “localDelivery”.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'local_delivery_status' => '1',
'all_domains' => '0',
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.