Controller: /siteworx/email/spf¶
- Required Permissions
EMAIL, DNS
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Delete a domain SPF configuration.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (integer) |
Yes |
Action: edit
¶
- Added in Version
4.7.0-339
- Description
Edit a single domain SPF configuration.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
|||
|
string |
No* |
example.com |
||
|
integer |
No* |
43200 |
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - In Seconds |
|
|
string |
No |
v=spf1 |
||
|
string |
No* |
v=spf1, v=spf3 |
v=spf1 |
|
|
integer |
No* |
1, 0 |
0 |
Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail? |
|
integer |
No* |
1, 0 |
0 |
Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail? |
|
integer |
No* |
1, 0 |
0 |
Should the PTR Records for the sender’s IP be used to validate the sender’s domain? NOT RECOMMENDED. |
|
integer |
No* |
1, 0 |
0 |
Do any other hostnames or IPs need to be authorized to send mail for this domain? |
|
struct (string) |
No |
If the domain name has an address record (A or AAAA) that can be resolved to the sender’s address, it will match. |
||
|
struct (string) |
No |
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). |
||
|
struct (string) |
No |
If the sender is in a given IPv4 range, match. |
||
|
struct (string) |
No |
If the sender is in a given IPv6 range, match. |
||
|
struct (string) |
No |
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. |
||
|
struct (string) |
No |
If there is a valid A Record for the given domain, match. Input may use macro-expansion. |
||
|
struct (string) |
No |
Used to include the policies of another domain’s SPF record. Similar to the ‘Redirect’ parameter. |
||
|
string |
No |
-all, ~all, ?all, +all |
Defines how to respond if the record has produced no match. |
|
|
string |
No |
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. |
||
|
string |
No |
Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported. |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No |
v=spf1 |
||
|
string |
Yes |
v=spf1, v=spf3 |
||
|
integer |
No* |
1, 0 |
0 |
Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail? |
|
integer |
No* |
1, 0 |
0 |
Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail? |
|
integer |
No* |
1, 0 |
0 |
Should the PTR Records for the sender’s IP be used to validate the sender’s domain? NOT RECOMMENDED. |
|
integer |
No* |
1, 0 |
0 |
Do any other hostnames or IPs need to be authorized to send mail for this domain? |
|
struct (string) |
No |
If the domain name has an address record (A or AAAA) that can be resolved to the sender’s address, it will match. |
||
|
struct (string) |
No |
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). |
||
|
struct (string) |
No |
If the sender is in a given IPv4 range, match. |
||
|
struct (string) |
No |
If the sender is in a given IPv6 range, match. |
||
|
struct (string) |
No |
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. |
||
|
struct (string) |
No |
If there is a valid A Record for the given domain, match. Input may use macro-expansion. |
||
|
struct (string) |
No |
Used to include the policies of another domain’s SPF record. Similar to the ‘Redirect’ parameter. |
||
|
string |
No |
-all, ~all, ?all, +all |
Defines how to respond if the record has produced no match. |
|
|
string |
No |
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. |
||
|
string |
No |
Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported. |
* 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: listSpfRecords
¶
- Added in Version
4.8.0-393
- Description
Lists the SPF records.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'zone_id' => '2',
'record_id' => '38',
'domain' => 'example.com',
'type' => 'SPF',
'target' => 'v=spf1',
'ttl' => '43200',
),
1 =>
array (
'zone_id' => '4',
'record_id' => '0',
'domain' => 'pointer.com',
'type' => NULL,
'target' => NULL,
'ttl' => NULL,
),
2 =>
array (
'zone_id' => '5',
'record_id' => '0',
'domain' => 'secondary.com',
'type' => NULL,
'target' => NULL,
'ttl' => NULL,
),
),
'reply_code' => 205,
)
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 |
---|---|---|---|---|---|
|
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' => '38',
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.