Controller: EmailRemotesetup

API Controller /siteworx/email/remotesetup
Required Permissions ["EMAIL"]
Action Description
addmx Add an MX record.
deletemx Delete an MX record.
disableLocalDelivery Disables local delivery for specified domains.
editmx Edit an MX record.
enableLocalDelivery Enables local delivery for specified domains.
listLocalDeliveryStatus Lists the status of local delivery for domains.
listMxRecordIds List domain MX records by id.
listMxRecords List MX Records for the SiteWorx account.
localDelivery Change whether this box accepts email locally for a domain.

Action: addmx

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

Delete an MX record.

Input Parameters

Name Type Notes Required?
record_id struct (integer) Yes

Action: disableLocalDelivery (Added in version 4.8.0-393)

Disables local delivery for specified domains.

Input Parameters

Name Type Notes Required?
domain struct (string)
Example Values
example.com, pointer.com, secondary.com, sub.example.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

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)

Enables local delivery for specified domains.

Input Parameters

Name Type Notes Required?
domain struct (string)
Example Values
example.com, pointer.com, secondary.com, sub.example.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)

Lists the status of local delivery for domains.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'domain' => 'example.com',
      'domain_type' => 'master',
      'master_domain' => 'example.com',
      'status' => 1,
    ),
    1 => 
    array (
      'domain' => 'pointer.com',
      'domain_type' => 'pointer',
      'master_domain' => 'example.com',
      'status' => 1,
    ),
    2 => 
    array (
      'domain' => 'secondary.com',
      'domain_type' => 'slave',
      'master_domain' => 'example.com',
      'status' => 1,
    ),
  ),
)

Action: listMxRecordIds

List domain MX records by id.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => '1501',
      1 => 'example.com - Preference Number 10 mail.example.com',
    ),
  ),
)

Action: listMxRecords (Added in version 4.8.0-393)

List MX Records for the SiteWorx account.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'record_id' => '1501',
      'zone_id' => '158',
      'type' => 'MX',
      'host' => 'example.com',
      'target' => '10 mail.example.com',
      'ttl' => '43200',
      'last_update' => '1336523005',
      'preference' => '10',
      'mail_server' => 'mail.example.com',
    ),
    1 => 
    array (
      'record_id' => '1516',
      'zone_id' => '159',
      'type' => 'MX',
      'host' => 'pointer.com',
      'target' => '10 mail.pointer.com',
      'ttl' => '43200',
      'last_update' => '1336523348',
      'preference' => '10',
      'mail_server' => 'mail.pointer.com',
    ),
    2 => 
    array (
      'record_id' => '1524',
      'zone_id' => '160',
      'type' => 'MX',
      'host' => 'secondary.com',
      'target' => '10 mail.secondary.com',
      'ttl' => '43200',
      'last_update' => '1336523359',
      'preference' => '10',
      'mail_server' => 'mail.secondary.com',
    ),
  ),
)

Action: localDelivery

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