Skip to content
Cloudflare API
Start here
API Reference
Email Security
Settings

Block Senders

List blocked email senders
email_security.settings.block_senders.list(BlockSenderListParams**kwargs) -> SyncV4PagePaginationArray[BlockSenderListResponse]
GET/accounts/{account_id}/email-security/settings/block_senders
Get a blocked email sender
email_security.settings.block_senders.get(intpattern_id, BlockSenderGetParams**kwargs) -> BlockSenderGetResponse
GET/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}
Create a blocked email sender
email_security.settings.block_senders.create(BlockSenderCreateParams**kwargs) -> BlockSenderCreateResponse
POST/accounts/{account_id}/email-security/settings/block_senders
Update a blocked email sender
email_security.settings.block_senders.edit(intpattern_id, BlockSenderEditParams**kwargs) -> BlockSenderEditResponse
PATCH/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}
Delete a blocked email sender
email_security.settings.block_senders.delete(intpattern_id, BlockSenderDeleteParams**kwargs) -> BlockSenderDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}
ModelsExpand Collapse
class BlockSenderListResponse: …
id: int

The unique identifier for the allow policy.

formatint32
created_at: datetime
formatdate-time
is_regex: bool
last_modified: datetime
formatdate-time
pattern: str
maxLength1024
minLength1
pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"]
One of the following:
"EMAIL"
"DOMAIN"
"IP"
"UNKNOWN"
comments: Optional[str]
maxLength1024
class BlockSenderGetResponse: …
id: int

The unique identifier for the allow policy.

formatint32
created_at: datetime
formatdate-time
is_regex: bool
last_modified: datetime
formatdate-time
pattern: str
maxLength1024
minLength1
pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"]
One of the following:
"EMAIL"
"DOMAIN"
"IP"
"UNKNOWN"
comments: Optional[str]
maxLength1024
class BlockSenderCreateResponse: …
id: int

The unique identifier for the allow policy.

formatint32
created_at: datetime
formatdate-time
is_regex: bool
last_modified: datetime
formatdate-time
pattern: str
maxLength1024
minLength1
pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"]
One of the following:
"EMAIL"
"DOMAIN"
"IP"
"UNKNOWN"
comments: Optional[str]
maxLength1024
class BlockSenderEditResponse: …
id: int

The unique identifier for the allow policy.

formatint32
created_at: datetime
formatdate-time
is_regex: bool
last_modified: datetime
formatdate-time
pattern: str
maxLength1024
minLength1
pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"]
One of the following:
"EMAIL"
"DOMAIN"
"IP"
"UNKNOWN"
comments: Optional[str]
maxLength1024
class BlockSenderDeleteResponse: …
id: int

The unique identifier for the allow policy.

formatint32