Chapter 71: Controller: /siteworx/email/box Up Part III: SiteWorx API Spec Chapter 73: Controller: /siteworx/email/filters 

72 Controller: /siteworx/email/domainkeys

Required Permissions "EMAIL"
Action: add
Added in version 4.7.0-339
Description Add DomainKeys configuration.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, pointer.com, secondary.com
Yes
testing_mode integer Help Entry
Specifies that DomainKeys are being tested for this domain, and unverified e-mail will not be treated any differently from verified e-mail.
Example Values
1, 0
Example Default Value
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: delete
Added in version 4.7.0-339
Description Delete DomainKeys configuration.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
example.com, pointer.com, secondary.com
Yes
Action: edit
Added in version 4.7.0-339
Description Edit DomainKeys configuration.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, pointer.com, secondary.com
Yes
testing_mode integer Help Entry
Specifies that DomainKeys are being tested for this domain, and unverified e-mail will not be treated any differently from verified e-mail.
Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listDomainKeys
Added in version 4.8.0-393
Description Lists the domain keys.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’zone_id’ => ’654’,
’record_id’ => NULL,
’domain’ => ’example.com’,
’type’ => NULL,
’target’ => NULL,
),
1 =>
array (
’zone_id’ => ’655’,
’record_id’ => NULL,
’domain’ => ’pointer.com’,
’type’ => NULL,
’target’ => NULL,
),
2 =>
array (
’zone_id’ => ’656’,
’record_id’ => NULL,
’domain’ => ’secondary.com’,
’type’ => NULL,
’target’ => NULL,
),
),
)
Action: queryDomainKeys
Added in version 4.8.0-393
Description List the domain key DNS records for a given domain.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, pointer.com, secondary.com
Yes
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, pointer.com, secondary.com
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’domain_copy’ => ’example.com’,
’testing_mode’ => ’0’,
’domain’ => ’example.com’,
),
)
Action: queryView
Added in version 5.1.0-838
Description Displays the information available to the action "view".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’domain_copy’ => ’example.com’,
’domain’ => ’example.com’,
),
)
Action: view
Added in version 4.7.0-339
Description View a set of domainkeys for a given domain.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, pointer.com, secondary.com
Yes
 Chapter 71: Controller: /siteworx/email/box Up Part III: SiteWorx API Spec Chapter 73: Controller: /siteworx/email/filters 

(C) 2017 by InterWorx LLC