account_filter_rules

Creates, updates, deletes, gets or lists an account_filter_rules resource.

Overview

Name	account_filter_rules
Type	Resource
Id	ovh.email_domain.account_filter_rules

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
header	string	Header to be filtered
operand	string	Rule of filter (checkspf, contains, noContains)
value	string	Rule parameter of filter

list

Rule List

Name	Datatype	Description
id	integer
header	string	Header to be filtered
operand	string	Rule of filter (checkspf, contains, noContains)
value	string	Rule parameter of filter

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_name, domain, id, name		Get a filter rule. Returns the header, the operand (checkspf, contains or noContains) and the value of the rule.
list	select	account_name, domain, name	x_pagination_mode	List filter rules. Returns the IDs of the rules of the filter. Get one to read the header it checks, its operand and its value.
create	insert	account_name, domain, name, header, operand, value		Create a filter rule. Adds a rule to the filter on a header, with an operand (checkspf, contains or noContains) and a value, and returns the task.
delete	delete	account_name, domain, id, name		Delete a filter rule. Removes the rule from the filter and returns the tasks. The filter keeps applying its other rules.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	Name of account (wire: accountName)
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
domain	string	Name of your domain name
id	integer
name	string	Filter name
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a filter rule. Returns the header, the operand (checkspf, contains or noContains) and the value of the rule.

SELECT
id,
header,
operand,
value
FROM ovh.email_domain.account_filter_rules
WHERE account_name = '{{ account_name }}' -- required
AND domain = '{{ domain }}' -- required
AND id = '{{ id }}' -- required
AND name = '{{ name }}' -- required
;

list

List filter rules. Returns the IDs of the rules of the filter. Get one to read the header it checks, its operand and its value.

SELECT
id,
header,
operand,
value
FROM ovh.email_domain.account_filter_rules
WHERE account_name = '{{ account_name }}' -- required
AND domain = '{{ domain }}' -- required
AND name = '{{ name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a filter rule. Adds a rule to the filter on a header, with an operand (checkspf, contains or noContains) and a value, and returns the task.

INSERT INTO ovh.email_domain.account_filter_rules (
header,
operand,
value,
account_name,
domain,
name
)
SELECT 
'{{ header }}' /* required */,
'{{ operand }}' /* required */,
'{{ value }}' /* required */,
'{{ account_name }}',
'{{ domain }}',
'{{ name }}'
RETURNING
id,
account,
action,
domain,
timestamp
;

Manifest

# Description fields are for documentation purposes
- name: account_filter_rules
props:
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the account_filter_rules resource.
  - name: domain
    value: "{{ domain }}"
    description: Required parameter for the account_filter_rules resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the account_filter_rules resource.
  - name: header
    value: "{{ header }}"
    description: |
      Header to be filtered
  - name: operand
    value: "{{ operand }}"
    description: |
      Rule of filter
    valid_values: ['checkspf', 'contains', 'noContains']
  - name: value
    value: "{{ value }}"
    description: |
      Rule parameter of filter

DELETE examples

delete

Delete a filter rule. Removes the rule from the filter and returns the tasks. The filter keeps applying its other rules.

DELETE FROM ovh.email_domain.account_filter_rules
WHERE account_name = '{{ account_name }}' --required
AND domain = '{{ domain }}' --required
AND id = '{{ id }}' --required
AND name = '{{ name }}' --required
;