Cloudflare/email

@swamp/cloudflare/emailv2026.07.24.1· 8d agoMODELS

01README

Cloudflare email infrastructure models

02Release Notes

Updated: suppression

03Models5

@swamp/cloudflare/email/addressesv2026.07.21.1addresses.ts

Global Arguments

Argument	Type	Required	Description
account_id	string	yes	Cloudflare account ID
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
status?	enum	no	Destination address status. Non-admin callers may only set verified addresses back to unverified; setting to verified requires admin privileges.
email	string	yes	The contact email address of the user.
apiToken?	string	no	Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a Addresses

fn get(id: string)

Get a Addresses

Argument	Type	Required	Description
id	string	yes	The ID of the Addresses

fn lookup()

Look up an existing Addresses by matching global argument values and import it into state

fn adopt(id: string)

Import an existing Addresses by ID into state for management

Argument	Type	Required	Description
id	string	yes	The ID of the Addresses to import

fn update(identifier?: string)

Update Addresses attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific Addresses by id (e.g. one discovered by list)

fn delete(id: string)

Delete the Addresses

Argument	Type	Required	Description
id	string	yes	The ID of the Addresses

fn sync(identifier?: string)

Sync Addresses state from Cloudflare

Argument	Type	Required	Description
identifier?	string	no	Target a specific Addresses by id (e.g. one discovered by list)

Resources

state(infinite)— Addresses resource state

@swamp/cloudflare/email/rulesv2026.07.21.1rules.ts

Global Arguments

Argument	Type	Required	Description
zone_id	string	yes	Cloudflare zone ID
actions	array	yes	List actions patterns.
enabled?	boolean	no	Routing rule status.
matchers	array	yes	Matching patterns to forward to your actions.
name?	string	no	Routing rule name.
owner_worker_tag?	string	no	Public tag (script_tag) of the Worker that owns this rule. Required when\n`source` is `wrangler`.\n
priority?	number	no	Priority of the routing rule.
source?	enum	no	Who manages the rule. `api` covers dashboard, generic API, and Terraform;\n`wrangler` means the rule is managed by a Worker's wrangler.jsonc. Defaults\nto `api` when omitted on write.\n
apiToken?	string	no	Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?	string	no	Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email.
email?	string	no	Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey.

fn create()

Create a Rules

fn get(id: string)

Get a Rules

Argument	Type	Required	Description
id	string	yes	The ID of the Rules

fn lookup()

Look up an existing Rules by matching global argument values and import it into state

fn adopt(id: string)

Import an existing Rules by ID into state for management

Argument	Type	Required	Description
id	string	yes	The ID of the Rules to import

fn update(identifier?: string)

Update Rules attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific Rules by id (e.g. one discovered by list)

fn delete(id: string)

Delete the Rules

Argument	Type	Required	Description
id	string	yes	The ID of the Rules

fn sync(identifier?: string)

Sync Rules state from Cloudflare

Argument	Type	Required	Description
identifier?	string	no	Target a specific Rules by id (e.g. one discovered by list)

Resources

state(infinite)— Rules resource state

@swamp/cloudflare/email/subdomainsv2026.07.21.1subdomains.ts

Global Arguments

Argument	Type	Required	Description
zone_id	string	yes	Cloudflare zone ID
preview_enabled?	boolean	no	Whether sent messages from this subdomain can be previewed in the activity log.
name	string	yes	The subdomain name. Must be within the zone.
apiToken?	string	no	Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?	string	no	Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email.
email?	string	no	Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey.

fn create()

Create a Subdomains

fn get(id: string)

Get a Subdomains

Argument	Type	Required	Description
id	string	yes	The ID of the Subdomains

fn lookup()

Look up an existing Subdomains by matching global argument values and import it into state

fn adopt(id: string)

Import an existing Subdomains by ID into state for management

Argument	Type	Required	Description
id	string	yes	The ID of the Subdomains to import

fn update(identifier?: string)

Update Subdomains attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific Subdomains by id (e.g. one discovered by list)

fn delete(id: string)

Delete the Subdomains

Argument	Type	Required	Description
id	string	yes	The ID of the Subdomains

fn sync(identifier?: string)

Sync Subdomains state from Cloudflare

Argument	Type	Required	Description
identifier?	string	no	Target a specific Subdomains by id (e.g. one discovered by list)

Resources

state(infinite)— Subdomains resource state

@swamp/cloudflare/email/suppressionv2026.07.24.1suppression.ts

Global Arguments

Argument	Type	Required	Description
account_id?	string	no	Cloudflare account ID (provide account_id or zone_id)
zone_id?	string	no	Cloudflare zone ID (provide account_id or zone_id)
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
email	string	yes
expires_at?	string	no
apiToken?	string	no	Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a Suppression

fn get(id: string)

Get a Suppression

Argument	Type	Required	Description
id	string	yes	The ID of the Suppression

fn lookup()

Look up an existing Suppression by matching global argument values and import it into state

fn adopt(id: string)

Import an existing Suppression by ID into state for management

Argument	Type	Required	Description
id	string	yes	The ID of the Suppression to import

fn delete(id: string)

Delete the Suppression

Argument	Type	Required	Description
id	string	yes	The ID of the Suppression

fn sync(identifier?: string)

Sync Suppression state from Cloudflare

Argument	Type	Required	Description
identifier?	string	no	Target a specific Suppression by id (e.g. one discovered by list)

Resources

state(infinite)— Suppression resource state

@swamp/cloudflare/email/suppressionsv2026.07.21.1suppressions.ts

Global Arguments

Argument	Type	Required	Description
account_id	string	yes	Cloudflare account ID
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
email	string	yes
expires_at?	string	no
note?	string	no
apiToken?	string	no	Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a Suppressions

fn get(id: string)

Get a Suppressions

Argument	Type	Required	Description
id	string	yes	The ID of the Suppressions

fn lookup()

Look up an existing Suppressions by matching global argument values and import it into state

fn adopt(id: string)

Import an existing Suppressions by ID into state for management

Argument	Type	Required	Description
id	string	yes	The ID of the Suppressions to import

fn delete(id: string)

Delete the Suppressions

Argument	Type	Required	Description
id	string	yes	The ID of the Suppressions

fn sync(identifier?: string)

Sync Suppressions state from Cloudflare

Argument	Type	Required	Description
identifier?	string	no	Target a specific Suppressions by id (e.g. one discovered by list)

Resources

state(infinite)— Suppressions resource state

04Previous Versions7

2026.07.21.1Jul 21, 2026

Updated: addresses
Updated: rules
Updated: suppression
Updated: subdomains
Updated: suppressions

2026.07.18.2Jul 18, 2026

Modified 5 models

2026.07.14.1Jul 14, 2026

Updated: rules
Updated: subdomains
Added: suppressions

Added 1, modified 1 models

2026.06.24.1Jun 24, 2026

Updated: addresses

Modified 1 models

2026.06.08.2Jun 8, 2026

Updated: addresses
Updated: rules
Updated: suppression
Updated: subdomains

2026.05.29.1May 29, 2026

Updated: addresses
Updated: rules
Updated: suppression
Updated: subdomains

2026.05.22.1May 22, 2026

Added: addresses
Added: rules
Added: suppression
Added: subdomains

05Stats

100 / 100

Downloads

Archive size

21.8 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#cloudflare #email #cloud #infrastructure