SendgridClient

Attributes

Bounces module-attribute

Bounces = List['Bounce | Mapping[str, Any]']

Classes

AddGlobalSuppressRequestAndResponse dataclass

AddGlobalSuppressRequestAndResponse(*, recipient_emails: Optional[List[str]] = None)

Response for Add a global suppression

Attributes

recipient_emails class-attribute instance-attribute

recipient_emails: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

Recipient email

GetGlobalSuppressResponse dataclass

GetGlobalSuppressResponse(*, recipient_email: Optional[str] = None)

Response for Get the global suppression

Attributes

recipient_email class-attribute instance-attribute

recipient_email: Optional[str] = dataclass_field(default=None, kw_only=True)

Recipient email

ObjectEntity dataclass

ObjectEntity(*, additional_properties: Dict[str, Any] = dict())

Response for Add recipient to list

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

EmailIsUnsubscribedResponse dataclass

EmailIsUnsubscribedResponse(*, is_unsubscribed: Optional[bool] = None)

Response for Check if email is in unsubscribed email list

Attributes

is_unsubscribed class-attribute instance-attribute

is_unsubscribed: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isUnsubscribed'})

Is Email Unsubscribed

RecipientLists dataclass

RecipientLists(*, lists: Optional[List[RecipientList | Mapping[str, Any]]] = None)

Response for List Recipient Lists

Attributes

lists class-attribute instance-attribute

lists: Optional[List[RecipientList | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of recipient lists

Recipients dataclass

Recipients(*, recipients: Optional[List[Recipient | Mapping[str, Any]]] = None)

Response for List Recipients

Attributes

recipients class-attribute instance-attribute

recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of recipients

EmailResponse dataclass

EmailResponse(*, message: Optional[str] = None)

Definition: EmailResponse

Attributes

message class-attribute instance-attribute

message: Optional[str] = dataclass_field(default=None, kw_only=True)

Status message from send email response

GetGlobalSuppressEmptyResponse dataclass

GetGlobalSuppressEmptyResponse(*, additional_properties: Dict[str, Any] = dict())

Definition: GetGlobalSuppressEmptyResponse

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

EmailRequest dataclass

EmailRequest(from_: str, to: str, subject: str, text: str, ishtml: bool, *, attachments: Optional[List[EmailAttachment | Mapping[str, Any]]] = None, fromname: Optional[str] = None, toname: Optional[str] = None, cc: Optional[str] = None, ccname: Optional[str] = None, bcc: Optional[str] = None, bccname: Optional[str] = None)

Definition: EmailRequest

Attributes

attachments class-attribute instance-attribute

attachments: Optional[List[EmailAttachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Attachments

from_ class-attribute instance-attribute

from_: str = dataclass_field(metadata={'wire_name': 'from'})

Origination address of your email. Must be a valid email address from your domain

fromname class-attribute instance-attribute

fromname: Optional[str] = dataclass_field(default=None, kw_only=True)

Origination name of your email

to instance-attribute

to: str

Valid email addresses separated by a semicolon or comma

toname class-attribute instance-attribute

toname: Optional[str] = dataclass_field(default=None, kw_only=True)

A display name for each email address separated by a semicolon or comma

subject instance-attribute

subject: str

Subject of your email

text instance-attribute

text: str

Content of your email

ishtml instance-attribute

ishtml: bool

Specify whether the content of the email is HTML or plain text

cc class-attribute instance-attribute

cc: Optional[str] = dataclass_field(default=None, kw_only=True)

Valid email addresses separated by a semicolon or comma

ccname class-attribute instance-attribute

ccname: Optional[str] = dataclass_field(default=None, kw_only=True)

A display name for each CC email address separated by a semicolon or comma

bcc class-attribute instance-attribute

bcc: Optional[str] = dataclass_field(default=None, kw_only=True)

Valid email addresses separated by a semicolon or comma

bccname class-attribute instance-attribute

bccname: Optional[str] = dataclass_field(default=None, kw_only=True)

A display name for each BCC email address separated by a semicolon or comma

EmailAttachment dataclass

EmailAttachment(*, content: Optional[str] = None, filename: Optional[str] = None, contenttype: Optional[str] = None)

Definition: EmailAttachment

Attributes

content class-attribute instance-attribute

content: Optional[str] = dataclass_field(default=None, kw_only=True)

Attachment file content

filename class-attribute instance-attribute

filename: Optional[str] = dataclass_field(default=None, kw_only=True)

Attachment file name

contenttype class-attribute instance-attribute

contenttype: Optional[str] = dataclass_field(default=None, kw_only=True)

Type of content in the attachment.

RecipientList dataclass

RecipientList(*, id: Optional[int] = None, name: Optional[str] = None, recipient_count: Optional[int] = None)

Definition: RecipientList

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

Unique list id

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name

recipient_count class-attribute instance-attribute

recipient_count: Optional[int] = dataclass_field(default=None, kw_only=True)

Recipient count

Recipient dataclass

Recipient(*, email: Optional[str] = None, last_name: Optional[str] = None, first_name: Optional[str] = None, id: Optional[str] = None)

Definition: Recipient

Attributes

email class-attribute instance-attribute

email: Optional[str] = dataclass_field(default=None, kw_only=True)

Email address

last_name class-attribute instance-attribute

last_name: Optional[str] = dataclass_field(default=None, kw_only=True)

Last name

first_name class-attribute instance-attribute

first_name: Optional[str] = dataclass_field(default=None, kw_only=True)

First name

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique recipient id

ScopeList dataclass

ScopeList(*, scopes: Optional[List[str]] = None)

Definition: ScopeList

Attributes

scopes class-attribute instance-attribute

scopes: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of scopes

Bounce dataclass

Bounce(*, created: Optional[int] = None, email: Optional[str] = None, reason: Optional[str] = None, status: Optional[str] = None)

Definition: Bounce

Attributes

created class-attribute instance-attribute

created: Optional[int] = dataclass_field(default=None, kw_only=True)

Created

email class-attribute instance-attribute

email: Optional[str] = dataclass_field(default=None, kw_only=True)

Email

reason class-attribute instance-attribute

reason: Optional[str] = dataclass_field(default=None, kw_only=True)

Reason

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

Status

SendgridClient

SendgridClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for sendgrid connector.

Initialize a SendgridClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

add_global_suppression async

add_global_suppression(input: AddGlobalSuppressRequestAndResponse | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add a global suppression

Add a global suppression

Swagger operation ID: AddGlobalSuppression.

Parameters:

Name	Type	Description	Default
input	AddGlobalSuppressRequestAndResponse | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_global_suppression async

get_global_suppression(email: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get the global suppression

Get the global suppression

Swagger operation ID: GetGlobalSuppression.

Parameters:

Name	Type	Description	Default
email	str	The email to check.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_global_suppression async

delete_global_suppression(email: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete the global suppression

Delete the global suppression

Swagger operation ID: DeleteGlobalSuppression.

Parameters:

Name	Type	Description	Default
email	str	The email to delete.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_recipient_to_list async

add_recipient_to_list(list_id: str, recipient_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add recipient to list

Add an individual recipient to a recipient list.

Swagger operation ID: AddRecipientToList.

Parameters:

Name	Type	Description	Default
list_id	str	Unique id of the recipient list.	required
recipient_id	str	Unique id of the recipient.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_bounce

list_bounce(email: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get bounce for an email

Get a specific bounce for a given email address.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetBounce.

Parameters:

Name	Type	Description	Default
email	str	The email to check.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_bounce async

delete_bounce(email: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete an email from bounce list

Delete an email address from your bounce list.

Swagger operation ID: DeleteBounce.

Parameters:

Name	Type	Description	Default
email	str	The email to delete.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

check_email_is_in_unsubscribes_list async

check_email_is_in_unsubscribes_list(email: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Check if email is in unsubscribed email list

Check if email is in unsubscribed email list.

Swagger operation ID: CheckEmailIsInUnsubscribesList.

Parameters:

Name	Type	Description	Default
email	str	The email to check.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

send_email async

send_email(input: EmailRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Send email

Sends an email (V4). Limited to 1000 recipients.

Swagger operation ID: SendEmailV4.

Parameters:

Name	Type	Description	Default
input	EmailRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_recipient_lists

list_recipient_lists(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List Recipient Lists

Retrieves all the recipient lists.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListRecipientLists.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_recipients

list_recipients(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List Recipients

Retrieves all registered recipients.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListRecipients.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.