Controller: EmailDomainkeys

API Controller	/siteworx/email/domainkeys
Required Permissions	["EMAIL"]

Action	Description
add	Add DomainKeys configuration.
delete	Delete DomainKeys configuration.
edit	Edit DomainKeys configuration.
listDomainkeyDomains	List DomainKeys compatible domains.
listDomainKeys	Lists the domain keys.
queryDomainKeys	List the domain key DNS records for a given domain.
view	View a set of domainkeys for a given domain.

Action: add

Add DomainKeys configuration.

Input Parameters

Name	Type	Notes	Required?
domain	string	Example Values example.com, pointer.com, secondary.com	Yes
signing_policy	string	Help Entry Specifies which Outbound Signing policy to use. Selecting "Domain signs all mail" requires that the receiving mail server reject any mail that is not properly signed. Selecting "Domain signs some mail" will instruct the receiving mail server to not reject mail that has not been signed (but will generally reject any mail that is improperly signed, such as a key mismatch). Example Values all_mail, some_mail Example Default Value all_mail	No*
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

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.6.0-323)

Edit DomainKeys configuration.

Input Parameters

Name	Type	Notes	Required?
domain	string	Example Values example.com, pointer.com, secondary.com	Yes
signing_policy	string	Help Entry Specifies which Outbound Signing policy to use. Selecting "Domain signs all mail" requires that the receiving mail server reject any mail that is not properly signed. Selecting "Domain signs some mail" will instruct the receiving mail server to not reject mail that has not been signed (but will generally reject any mail that is improperly signed, such as a key mismatch). Example Values all_mail, some_mail	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: listDomainkeyDomains

List DomainKeys compatible domains.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 'example.com',
    1 => 'pointer.com',
    2 => 'secondary.com',
  ),
)

Action: listDomainKeys (Added in version 4.8.0-393)

Lists the domain keys.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'zone_id' => '158',
      'record_id' => NULL,
      'domain' => 'example.com',
      'type' => NULL,
      'target' => NULL,
    ),
    1 => 
    array (
      'zone_id' => '159',
      'record_id' => NULL,
      'domain' => 'pointer.com',
      'type' => NULL,
      'target' => NULL,
    ),
    2 => 
    array (
      'zone_id' => '160',
      'record_id' => NULL,
      'domain' => 'secondary.com',
      'type' => NULL,
      'target' => NULL,
    ),
  ),
)

Action: queryDomainKeys (Added in version 4.8.0-393)

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: view (Added in version 4.6.0-323)

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