Cloudflare/email Security
@swamp/cloudflare/email-securityv2026.06.24.1
01README
Cloudflare email-security infrastructure models
02Release Notes
- Added: bulk
03Models
@swamp/cloudflare/email-security/allow-policiesv2026.06.08.1allow_policies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| comments? | string | |
| created_at | string | |
| id | string | Allow policy identifier |
| is_acceptable_sender? | boolean | Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions. |
| is_exempt_recipient? | boolean | Messages to this recipient will bypass all detections |
| is_recipient? | boolean | Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026. |
| is_regex? | boolean | |
| is_sender? | boolean | Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026. |
| is_spoof? | boolean | Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026. |
| is_trusted_sender? | boolean | Messages from this sender will bypass all detections and link following |
| last_modified | string | |
| modified_at? | string | |
| pattern? | string | |
| pattern_type? | enum | Type of pattern matching.\nNote: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.\n |
| verify_sender? | boolean | Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | 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 | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Allow Policies
fn get(id: string)
Get a Allow Policies
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Allow Policies |
fn update()
Update Allow Policies attributes
fn delete(id: string)
Delete the Allow Policies
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Allow Policies |
fn sync()
Sync Allow Policies state from Cloudflare
Resources
state(infinite)— Allow Policies resource state
@swamp/cloudflare/email-security/block-sendersv2026.06.08.1block_senders.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| comments? | string | |
| created_at? | string | |
| id? | string | Blocked sender pattern identifier |
| is_regex? | boolean | |
| last_modified? | string | |
| modified_at? | string | |
| pattern? | string | |
| pattern_type? | enum | Type of pattern matching.\nNote: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.\n |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | 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 | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Block Senders
fn get(id: string)
Get a Block Senders
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Block Senders |
fn update()
Update Block Senders attributes
fn delete(id: string)
Delete the Block Senders
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Block Senders |
fn sync()
Sync Block Senders state from Cloudflare
Resources
state(infinite)— Block Senders resource state
@swamp/cloudflare/email-security/bulkv2026.06.24.1bulk.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| action | enum | |
| comment? | string | |
| destination? | enum | |
| expected_disposition? | enum | |
| search_params | object | |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | 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 | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Bulk
fn get(id: string)
Get a Bulk
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Bulk |
fn delete(id: string)
Delete the Bulk
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Bulk |
fn sync()
Sync Bulk state from Cloudflare
Resources
state(infinite)— Bulk resource state
@swamp/cloudflare/email-security/impersonation-registryv2026.06.08.1impersonation_registry.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| comments? | string | |
| created_at? | string | |
| directory_id? | number | |
| directory_node_id? | number | |
| email? | string | |
| external_directory_node_id? | string | |
| id? | string | Impersonation registry entry identifier |
| is_email_regex? | boolean | |
| last_modified? | string | |
| modified_at? | string | |
| name? | string | |
| provenance? | enum | |
| apiToken? | string | 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 Impersonation Registry
fn get(id: string)
Get a Impersonation Registry
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Impersonation Registry |
fn update()
Update Impersonation Registry attributes
fn delete(id: string)
Delete the Impersonation Registry
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Impersonation Registry |
fn sync()
Sync Impersonation Registry state from Cloudflare
Resources
state(infinite)— Impersonation Registry resource state
@swamp/cloudflare/email-security/sending-domain-restrictionsv2026.06.08.1sending_domain_restrictions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| comments? | string | |
| created_at? | string | |
| domain? | string | Domain that requires TLS enforcement. |
| exclude? | array | Excluded subdomains that are exempt from TLS requirements. |
| id? | string | Sending domain restriction identifier. |
| last_modified? | string | |
| modified_at? | string | |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | 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 | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Sending Domain Restrictions
fn get(id: string)
Get a Sending Domain Restrictions
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Sending Domain Restrictions |
fn update()
Update Sending Domain Restrictions attributes
fn delete(id: string)
Delete the Sending Domain Restrictions
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Sending Domain Restrictions |
fn sync()
Sync Sending Domain Restrictions state from Cloudflare
Resources
state(infinite)— Sending Domain Restrictions resource state
@swamp/cloudflare/email-security/trusted-domainsv2026.06.08.1trusted_domains.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| comments? | string | |
| created_at? | string | |
| id? | string | Trusted domain identifier |
| is_recent? | boolean | Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. |
| is_regex? | boolean | |
| is_similarity? | boolean | Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. |
| last_modified? | string | |
| modified_at? | string | |
| pattern? | string | |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | 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 | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Trusted Domains
fn get(id: string)
Get a Trusted Domains
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Trusted Domains |
fn update()
Update Trusted Domains attributes
fn delete(id: string)
Delete the Trusted Domains
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Trusted Domains |
fn sync()
Sync Trusted Domains state from Cloudflare
Resources
state(infinite)— Trusted Domains resource state
@swamp/cloudflare/email-security/url-ignore-patternsv2026.06.08.1url_ignore_patterns.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| comments? | string | Optional note describing the reason for the ignore pattern. |
| pattern | string | Regular expression matching URLs that should not be rewritten. |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | 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 | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Url Ignore Patterns
fn get(id: string)
Get a Url Ignore Patterns
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Url Ignore Patterns |
fn update()
Update Url Ignore Patterns attributes
fn delete(id: string)
Delete the Url Ignore Patterns
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Url Ignore Patterns |
fn sync()
Sync Url Ignore Patterns state from Cloudflare
Resources
state(infinite)— Url Ignore Patterns resource state
04Previous Versions
2026.06.08.2Jun 8, 2026
- Updated: allow_policies
- Updated: block_senders
- Updated: impersonation_registry
- Updated: sending_domain_restrictions
- Updated: trusted_domains
- Updated: url_ignore_patterns
2026.05.29.1May 29, 2026
- Updated: allow_policies
- Updated: block_senders
- Updated: impersonation_registry
- Updated: sending_domain_restrictions
- Updated: trusted_domains
- Added: url_ignore_patterns
Added 1 models
2026.05.22.1May 22, 2026
- Added: allow_policies
- Added: block_senders
- Added: impersonation_registry
- Added: sending_domain_restrictions
- Added: trusted_domains
05Stats
A
100 / 100
Downloads
0
Archive size
23.9 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