damex.cloudflare.cloudflare_email_routing_address module – Ensure Cloudflare email routing destination address

Note

This module is part of the damex.cloudflare collection (version 1.2.3).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install damex.cloudflare.

To use it in a playbook, specify: damex.cloudflare.cloudflare_email_routing_address.

Synopsis

  • Ensures Cloudflare email routing destination addresses, see the docs: https://developers.cloudflare.com/email-routing/.

  • Destination addresses must be verified before they can be used in routing rules.

  • Creating an address triggers a verification email.

Parameters

Parameter

Comments

account_api_key

string

Cloudflare account API key.

Required together with account_email if api_token is not provided.

account_email

string

Cloudflare account email.

Required together with account_api_key if api_token is not provided.

account_id

string

Cloudflare account identifier.

Required if account_name is not provided.

account_name

string

Cloudflare account name.

Required if account_id is not provided.

Resolved to account identifier via the Cloudflare API.

api_token

string

Cloudflare API token.

Required if account_email and account_api_key are not provided.

Can be specified in CLOUDFLARE_TOKEN environment variable.

email

string / required

Destination email address.

state

string

Destination address state.

Choices:

  • "absent"

  • "present" ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Supports check mode.

diff_mode

Support: full

Supports diff mode.

Examples

- name: Ensure destination address
  damex.cloudflare.cloudflare_email_routing_address:
    email: user@gmail.com
    account_id: 023e105f4ecef8ad9ca31a8372d0c353
    api_token: "{{ cloudflare_api_token }}"

- name: Ensure destination address is absent
  damex.cloudflare.cloudflare_email_routing_address:
    email: old@gmail.com
    account_id: 023e105f4ecef8ad9ca31a8372d0c353
    api_token: "{{ cloudflare_api_token }}"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

address

dictionary

Destination address object from the Cloudflare API.

Returned: when state is present

email

string

Destination email address.

Returned: success

id

string

Address identifier.

Returned: success

verified

string

Verification timestamp, null if not yet verified.

Returned: success

Authors

  • Roman Kuzmitskii (@damex)