addresses

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

Overview

Name	addresses
Type	Resource
Id	cloudflare.email_routing.addresses

Fields

The following fields are returned by SELECT queries:

get

Get a destination address response

Name	Datatype	Description
errors	array
messages	array
result	object
success	boolean	Whether the API call was successful. (true)

list

List destination addresses response

Name	Datatype	Description
id	string	Destination address identifier. (example: ea95132c15732412d22c1476fa83f27a)
created	string (date-time)	The date and time the destination address has been created. (example: 2014-01-02T02:20:00Z)
email	string	The contact email address of the user. (example: user@example.com)
modified	string (date-time)	The date and time the destination address was last modified. (example: 2014-01-02T02:20:00Z)
tag	string	Destination address tag. (Deprecated, replaced by destination address identifier) (example: ea95132c15732412d22c1476fa83f27a)
verified	string (date-time)	The date and time the destination address has been verified. Null means not verified yet. (example: 2014-01-02T02:20:00Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	destination_address_identifier, account_id		Gets information for a specific destination email already created.
list	select	account_id	page, per_page, direction, verified	Lists existing destination addresses.
create	insert	account_id, email		Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.
delete	delete	destination_address_identifier, account_id		Deletes a specific destination address.

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_id	string	The Cloudflare account ID.
destination_address_identifier	string
direction	string
page	number
per_page	number
verified	boolean

SELECT examples

get

Gets information for a specific destination email already created.

SELECT
errors,
messages,
result,
success
FROM cloudflare.email_routing.addresses
WHERE destination_address_identifier = '{{ destination_address_identifier }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

Lists existing destination addresses.

SELECT
id,
created,
email,
modified,
tag,
verified
FROM cloudflare.email_routing.addresses
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND direction = '{{ direction }}'
AND verified = '{{ verified }}'
;

INSERT examples

create

Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.

INSERT INTO cloudflare.email_routing.addresses (
email,
account_id
)
SELECT 
'{{ email }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: addresses
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the addresses resource.
  - name: email
    value: "{{ email }}"
    description: |
      The contact email address of the user.

DELETE examples

delete

Deletes a specific destination address.

DELETE FROM cloudflare.email_routing.addresses
WHERE destination_address_identifier = '{{ destination_address_identifier }}' --required
AND account_id = '{{ account_id }}' --required
;