Skip to main content

Cloudflare/email

@swamp/cloudflare/emailv2026.06.08.2· 8d agoMODELS
01README

Cloudflare email infrastructure models

02Release Notes
  • Updated: addresses
  • Updated: rules
  • Updated: suppression
  • Updated: subdomains
03Models4
@swamp/cloudflare/email/addressesv2026.06.08.1addresses.ts

Global Arguments

ArgumentTypeDescription
account_idstringCloudflare account ID
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
emailstringThe contact email address of the user.
apiToken?stringCloudflare 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
ArgumentTypeDescription
idstringThe ID of the Addresses
fn delete(id: string)
Delete the Addresses
ArgumentTypeDescription
idstringThe ID of the Addresses
fn sync()
Sync Addresses state from Cloudflare

Resources

state(infinite)— Addresses resource state
@swamp/cloudflare/email/rulesv2026.06.08.1rules.ts

Global Arguments

ArgumentTypeDescription
zone_idstringCloudflare zone ID
actionsarrayList actions patterns.
enabled?booleanRouting rule status.
matchersarrayMatching patterns to forward to your actions.
name?stringRouting rule name.
priority?numberPriority of the routing rule.
apiToken?stringCloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?stringCloudflare 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?stringCloudflare 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
ArgumentTypeDescription
idstringThe ID of the Rules
fn update()
Update Rules attributes
fn delete(id: string)
Delete the Rules
ArgumentTypeDescription
idstringThe ID of the Rules
fn sync()
Sync Rules state from Cloudflare

Resources

state(infinite)— Rules resource state
@swamp/cloudflare/email/subdomainsv2026.06.08.1subdomains.ts

Global Arguments

ArgumentTypeDescription
zone_idstringCloudflare zone ID
namestringThe subdomain name. Must be within the zone.
apiToken?stringCloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?stringCloudflare 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?stringCloudflare 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
ArgumentTypeDescription
idstringThe ID of the Subdomains
fn delete(id: string)
Delete the Subdomains
ArgumentTypeDescription
idstringThe ID of the Subdomains
fn sync()
Sync Subdomains state from Cloudflare

Resources

state(infinite)— Subdomains resource state
@swamp/cloudflare/email/suppressionv2026.06.08.1suppression.ts

Global Arguments

ArgumentTypeDescription
account_id?stringCloudflare account ID (provide account_id or zone_id)
zone_id?stringCloudflare zone ID (provide account_id or zone_id)
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
emailstring
expires_at?string
apiToken?stringCloudflare 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
ArgumentTypeDescription
idstringThe ID of the Suppression
fn delete(id: string)
Delete the Suppression
ArgumentTypeDescription
idstringThe ID of the Suppression
fn sync()
Sync Suppression state from Cloudflare

Resources

state(infinite)— Suppression resource state
04Previous Versions2
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
A
100 / 100
Downloads
1
Archive size
14.1 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
06Platforms
07Labels