SendgridClient

Attributes

Bounces module-attribute

Bounces = List['Bounce']

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]] = None

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] = None

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] = field(default_factory=dict)

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] = field(default=None, metadata={'wire_name': 'isUnsubscribed'})

Is Email Unsubscribed

RecipientLists dataclass

RecipientLists(lists: Optional[List[RecipientList]] = None)

Response for List Recipient Lists

Attributes

lists class-attribute instance-attribute

lists: Optional[List[RecipientList]] = None

List of recipient lists

Recipients dataclass

Recipients(recipients: Optional[List[Recipient]] = None)

Response for List Recipients

Attributes

recipients class-attribute instance-attribute

recipients: Optional[List[Recipient]] = None

List of recipients

EmailResponse dataclass

EmailResponse(message: Optional[str] = None)

Definition: EmailResponse

Attributes

message class-attribute instance-attribute

message: Optional[str] = None

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] = field(default_factory=dict)

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

EmailRequest dataclass

EmailRequest(attachments: Optional[List[EmailAttachment]] = None, from_: Optional[str] = None, fromname: Optional[str] = None, to: Optional[str] = None, toname: Optional[str] = None, subject: Optional[str] = None, text: Optional[str] = None, ishtml: Optional[bool] = 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]] = None

Attachments

from_ class-attribute instance-attribute

from_: Optional[str] = field(default=None, 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] = None

Origination name of your email

to class-attribute instance-attribute

to: Optional[str] = None

Valid email addresses separated by a semicolon or comma

toname class-attribute instance-attribute

toname: Optional[str] = None

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

subject class-attribute instance-attribute

subject: Optional[str] = None

Subject of your email

text class-attribute instance-attribute

text: Optional[str] = None

Content of your email

ishtml class-attribute instance-attribute

ishtml: Optional[bool] = None

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

cc class-attribute instance-attribute

cc: Optional[str] = None

Valid email addresses separated by a semicolon or comma

ccname class-attribute instance-attribute

ccname: Optional[str] = None

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

bcc class-attribute instance-attribute

bcc: Optional[str] = None

Valid email addresses separated by a semicolon or comma

bccname class-attribute instance-attribute

bccname: Optional[str] = None

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] = None

Attachment file content

filename class-attribute instance-attribute

filename: Optional[str] = None

Attachment file name

contenttype class-attribute instance-attribute

contenttype: Optional[str] = None

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] = None

Unique list id

name class-attribute instance-attribute

name: Optional[str] = None

Name

recipient_count class-attribute instance-attribute

recipient_count: Optional[int] = None

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] = None

Email address

last_name class-attribute instance-attribute

last_name: Optional[str] = None

Last name

first_name class-attribute instance-attribute

first_name: Optional[str] = None

First name

id class-attribute instance-attribute

id: Optional[str] = None

Unique recipient id

ScopeList dataclass

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

Definition: ScopeList

Attributes

scopes class-attribute instance-attribute

scopes: Optional[List[str]] = None

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] = None

Created

email class-attribute instance-attribute

email: Optional[str] = None

Email

reason class-attribute instance-attribute

reason: Optional[str] = None

Reason

status class-attribute instance-attribute

status: Optional[str] = None

Status

SendgridClient

SendgridClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

add_global_suppression_async async

add_global_suppression_async(input: AddGlobalSuppressRequestAndResponse) -> dict[str, Any] | None

Add a global suppression

Add a global suppression

get_global_suppression_async async

get_global_suppression_async(email: str) -> dict[str, Any] | None

Get the global suppression

Get the global suppression

delete_global_suppression_async async

delete_global_suppression_async(email: str) -> None

Delete the global suppression

Delete the global suppression

add_recipient_to_list_async async

add_recipient_to_list_async(list_id: str, recipient_id: str) -> dict[str, Any] | None

Add recipient to list

Add an individual recipient to a recipient list.

get_bounce_async async

get_bounce_async(email: str) -> dict[str, Any] | None

Get bounce for an email

Get a specific bounce for a given email address.

delete_bounce_async async

delete_bounce_async(email: str) -> None

Delete an email from bounce list

Delete an email address from your bounce list.

check_email_is_in_unsubscribes_list_async async

check_email_is_in_unsubscribes_list_async(email: str) -> dict[str, Any] | None

Check if email is in unsubscribed email list

Check if email is in unsubscribed email list.

send_email_async async

send_email_async(input: EmailRequest) -> dict[str, Any] | None

Send email

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

list_recipient_lists_async async

list_recipient_lists_async() -> dict[str, Any] | None

List Recipient Lists

Retrieves all the recipient lists.

list_recipients_async async

list_recipients_async() -> dict[str, Any] | None

List Recipients

Retrieves all registered recipients.