Controller: /siteworx/email/domainkeys

Required Permissions

EMAIL, DNS

Action: add

Added in Version

4.7.0-339

Description

Add DomainKeys configuration.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

domain

string

Yes

example.com, pointer.com, secondary.com

testing_mode

integer

No*

1, 0

1

Specifies that DomainKeys are being tested for this domain, and unverified email will not be treated any differently from verified email.

* 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

Required?

Example Values

Default Values

Notes

domain

struct (string)

Yes

example.com, pointer.com, secondary.com

Action: edit

Added in Version

4.7.0-339

Description

Edit DomainKeys configuration.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

domain

string

Yes

example.com, pointer.com, secondary.com

testing_mode

integer

No*

1, 0

1

Specifies that DomainKeys are being tested for this domain, and unverified email will not be treated any differently from verified email.

* indicates that it’s actually required, but probably already has a valid default value.

Action: fail

Added in Version

n/a

Description

Magic function - test for failure mechanism.

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' => '2',
      'record_id' => '64',
      'domain' => 'example.com',
      'type' => 'TXT',
      'target' => 'v=DKIM1; k=rsa; t=y;',
    ),
    1 =>
    array (
      'zone_id' => '4',
      'record_id' => NULL,
      'domain' => 'pointer.com',
      'type' => NULL,
      'target' => NULL,
    ),
    2 =>
    array (
      'zone_id' => '5',
      'record_id' => NULL,
      'domain' => 'secondary.com',
      'type' => NULL,
      'target' => NULL,
    ),
  ),
  'reply_code' => 205,
)

Action: queryDomainKeys

Added in Version

4.8.0-393

Description

List the domain key DNS records for a given domain.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

domain

string

Yes

example.com, pointer.com, secondary.com

Action: queryEdit

Added in Version

5.1.0-838

Description

Displays the information available to the action “edit”.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

domain

string

Yes

example.com, pointer.com, secondary.com

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'domain_copy' => 'example.com',
    'testing_mode' => '1',
    'domain' => 'example.com',
  ),
  'reply_code' => 205,
)

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',
  ),
  'reply_code' => 205,
)

Action: reroute

Added in Version

n/a

Description

Action to re-route from the current controller to a different one.

Action: view

Added in Version

4.7.0-339

Description

View a set of domainkeys for a given domain.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

domain

string

Yes

example.com, pointer.com, secondary.com

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.