Chapter 73: Controller: /siteworx/email/group Up Part III: SiteWorx API Spec Chapter 75: Controller: /siteworx/email/spamprefs 

74 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 Notes Required?
zone_id integer Yes
host string Example Default Value
example.com
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
preference integer Help Entry
An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones.
Yes
mail_server 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 Notes Required?
record_id struct (integer) Yes
Action: disableLocalDelivery
Added in version 4.8.0-393
Description Disables local delivery for specified domains.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
example.com, secondary.com, sub.example.com, pointer.com
Yes
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
Action: editmx
Added in version 4.7.0-339
Description Edit an MX record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
host string Example Default Value
example.com
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
preference integer Help Entry
An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones.
Example Default Value
10
No*
mail_server string Example Default Value
mail.example.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 Enables local delivery for specified domains.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
example.com, secondary.com, sub.example.com, pointer.com
Yes
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
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,
),
),
)
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 => ’6927’,
1 => ’example.com - Preference Number 10 mail.example.com’,
),
1 =>
array (
0 => ’6945’,
1 => ’pointer.com - Preference Number 10 mail.pointer.com’,
),
2 =>
array (
0 => ’6956’,
1 => ’secondary.com - Preference Number 10 mail.secondary.com’,
),
),
)
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’ => ’6927’,
’zone_id’ => ’537’,
’type’ => ’MX’,
’host’ => ’example.com’,
’target’ => ’10 mail.example.com’,
’ttl’ => ’43200’,
’last_update’ => ’1485356758’,
’preference’ => ’10’,
’mail_server’ => ’mail.example.com’,
),
1 =>
array (
’record_id’ => ’6945’,
’zone_id’ => ’538’,
’type’ => ’MX’,
’host’ => ’pointer.com’,
’target’ => ’10 mail.pointer.com’,
’ttl’ => ’43200’,
’last_update’ => ’1485356804’,
’preference’ => ’10’,
’mail_server’ => ’mail.pointer.com’,
),
2 =>
array (
’record_id’ => ’6956’,
’zone_id’ => ’539’,
’type’ => ’MX’,
’host’ => ’secondary.com’,
’target’ => ’10 mail.secondary.com’,
’ttl’ => ’43200’,
’last_update’ => ’1485356805’,
’preference’ => ’10’,
’mail_server’ => ’mail.secondary.com’,
),
),
)
Action: localDelivery
Added in version 4.7.0-339
Description Change whether this box accepts email locally for a domain.
Input Parameters
Name Type Notes Required?
local_delivery_status integer Example Values
1, 0
Example Default Value
1
No*
all_domains integer Help Entry
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.
Example Values
1, 0
Example Default Value
0
No
* 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 Notes Required?
record_id integer Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’example.com’,
’ttl’ => ’43200’,
’preference’ => ’10’,
’mail_server’ => ’mail.example.com’,
’record_id’ => ’6927’,
),
)
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’,
),
)
 Chapter 73: Controller: /siteworx/email/group Up Part III: SiteWorx API Spec Chapter 75: Controller: /siteworx/email/spamprefs 

(C) 2017 by InterWorx LLC