Chapter 75: Controller: /siteworx/email/spamprefs Up Part III: SiteWorx API Spec Chapter 77: Controller: /siteworx/ftp 

76 Controller: /siteworx/email/spf

Required Permissions "EMAIL"
Action: delete
Added in version 4.7.0-339
Description Delete a domain SPF configuration.
Input Parameters
Name Type Notes Required?
record_id struct (integer) Yes
Action: edit
Added in version 4.7.0-339
Description Edit a single domain SPF configuration.
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*
spf_record_value string Example Default Value
v=spf1
No
spf_version string Example Values
v=spf1, v=spf3
Example Default Value
v=spf1
No*
use_a integer Description
Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail?
Example Values
1, 0
Example Default Value
0
No*
use_mx integer Description
Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail?
Example Values
1, 0
Example Default Value
0
No*
use_ptr integer Description
Should the PTR Records for the sender’s IP be used to validate the sender’s domain? NOT RECOMMENDED.
Example Values
1, 0
Example Default Value
0
No*
other_servers integer Description
Do any other hostnames or IPs need to be authorized to send mail for this domain?
Example Values
1, 0
Example Default Value
0
No*
mechanism_a struct (string) Description
If the domain name has an address record (A or AAAA) that can be resolved to the sender’s address, it will match.
No
mechanism_mx struct (string) Description
If the domain name has an MX record resolving to the sender’s address, it will match (i.e. the mail comes from one of the domain’s mail servers).
No
mechanism_ip4 struct (string) Description
If the sender is in a given IPv4 range, match.
No
mechanism_ip6 struct (string) Description
If the sender is in a given IPv6 range, match.
No
mechanism_ptr struct (string) Description
If the domain name for the client’s address is in the given domain and that domain name resolves to the client’s address, match. Input may use macro-expansion. NOT RECOMMENDED.
No
mechanism_exists struct (string) Description
If there is a valid A Record for the given domain, match. Input may use macro-expansion.
No
mechanism_include struct (string) Description
Used to include the policies of another domain’s SPF record. Similar to the ’Redirect’ parameter.
No
all string Description
Defines how to respond if the record has produced no match.
Example Values
, -all, ~all, ?all, +all
No
redirect string Description
Redirects verification to use the SPF record of the specified domain. This is useful, for example, if you send mail through your ISP’s servers and they have defined an SPF record.
No
explanation string Description
Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: editAll
Added in version 4.7.0-339
Description Edit all domains SPF configuration.
Input Parameters
Name Type Notes Required?
spf_record_value string Example Default Value
v=spf1
No
spf_version string Example Values
v=spf1, v=spf3
Yes
use_a integer Description
Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail?
Example Values
1, 0
Example Default Value
0
No*
use_mx integer Description
Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail?
Example Values
1, 0
Example Default Value
0
No*
use_ptr integer Description
Should the PTR Records for the sender’s IP be used to validate the sender’s domain? NOT RECOMMENDED.
Example Values
1, 0
Example Default Value
0
No*
other_servers integer Description
Do any other hostnames or IPs need to be authorized to send mail for this domain?
Example Values
1, 0
Example Default Value
0
No*
mechanism_a struct (string) Description
If the domain name has an address record (A or AAAA) that can be resolved to the sender’s address, it will match.
No
mechanism_mx struct (string) Description
If the domain name has an MX record resolving to the sender’s address, it will match (i.e. the mail comes from one of the domain’s mail servers).
No
mechanism_ip4 struct (string) Description
If the sender is in a given IPv4 range, match.
No
mechanism_ip6 struct (string) Description
If the sender is in a given IPv6 range, match.
No
mechanism_ptr struct (string) Description
If the domain name for the client’s address is in the given domain and that domain name resolves to the client’s address, match. Input may use macro-expansion. NOT RECOMMENDED.
No
mechanism_exists struct (string) Description
If there is a valid A Record for the given domain, match. Input may use macro-expansion.
No
mechanism_include struct (string) Description
Used to include the policies of another domain’s SPF record. Similar to the ’Redirect’ parameter.
No
all string Description
Defines how to respond if the record has produced no match.
Example Values
, -all, ~all, ?all, +all
No
redirect string Description
Redirects verification to use the SPF record of the specified domain. This is useful, for example, if you send mail through your ISP’s servers and they have defined an SPF record.
No
explanation string Description
Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: listSpfRecords
Added in version 4.8.0-393
Description Lists the SPF records.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’zone_id’ => ’636’,
’record_id’ => ’8258’,
’domain’ => ’example.com’,
’type’ => ’SPF’,
’target’ => ’v=spf1’,
’ttl’ => ’43200’,
),
1 =>
array (
’zone_id’ => ’637’,
’record_id’ => NULL,
’domain’ => ’pointer.com’,
’type’ => NULL,
’target’ => NULL,
’ttl’ => NULL,
),
2 =>
array (
’zone_id’ => ’638’,
’record_id’ => NULL,
’domain’ => ’secondary.com’,
’type’ => NULL,
’target’ => NULL,
’ttl’ => NULL,
),
),
)
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
record_id integer Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’example.com’,
’ttl’ => ’43200’,
’spf_record_value’ => ’v=spf1’,
’spf_version’ => ’v=spf1’,
’use_a’ => ’0’,
’use_mx’ => ’0’,
’use_ptr’ => ’0’,
’other_servers’ => ’0’,
’mechanism_a’ =>
array (
),
’mechanism_mx’ =>
array (
),
’mechanism_ip4’ =>
array (
),
’mechanism_ip6’ =>
array (
),
’mechanism_ptr’ =>
array (
),
’mechanism_exists’ =>
array (
),
’mechanism_include’ =>
array (
),
’all’ => NULL,
’redirect’ => ’’,
’explanation’ => NULL,
’record_id’ => ’8258’,
),
)
 Chapter 75: Controller: /siteworx/email/spamprefs Up Part III: SiteWorx API Spec Chapter 77: Controller: /siteworx/ftp 

(C) 2017 by InterWorx LLC