Skip to content

SmtpClient

Classes

Attachment dataclass

Attachment(content_data: Optional[str] = None, content_type: Optional[str] = None, file_name: Optional[str] = None, content_id: Optional[str] = None)

Definition: Attachment

Attributes

content_data class-attribute instance-attribute
content_data: Optional[str] = field(default=None, metadata={'wire_name': 'ContentData'})

Content data

content_type class-attribute instance-attribute
content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ContentType'})

Content type

file_name class-attribute instance-attribute
file_name: Optional[str] = field(default=None, metadata={'wire_name': 'FileName'})

File name

content_id class-attribute instance-attribute
content_id: Optional[str] = field(default=None, metadata={'wire_name': 'ContentId'})

Content id

Email dataclass

Email(from_: Optional[str] = None, to: Optional[str] = None, c_c: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, bcc: Optional[str] = None, importance: Optional[str] = None, read_receipt: Optional[str] = None, delivery_receipt: Optional[str] = None, attachments: Optional[List[Attachment]] = None)

Definition: Email

Attributes

from_ class-attribute instance-attribute
from_: Optional[str] = field(default=None, metadata={'wire_name': 'From'})

Email address of sender like sender@domain.com

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Specify email addresses separated by semicolons like recipient1@domain.com;recipient2@domain.com

c_c class-attribute instance-attribute
c_c: Optional[str] = field(default=None, metadata={'wire_name': 'CC'})

Specify email addresses separated by semicolons like recipient1@domain.com;recipient2@domain.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Email subject

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Email body

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

Specify email addresses separated by semicolons like recipient1@domain.com;recipient2@domain.com.

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Importance of the email (High, Normal, or Low)

read_receipt class-attribute instance-attribute
read_receipt: Optional[str] = field(default=None, metadata={'wire_name': 'ReadReceipt'})

Specify email address for Read receipt

delivery_receipt class-attribute instance-attribute
delivery_receipt: Optional[str] = field(default=None, metadata={'wire_name': 'DeliveryReceipt'})

Specify email address for Delivery receipt

attachments class-attribute instance-attribute
attachments: Optional[List[Attachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments to be sent along with the email

SmtpClient

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

Bases: ConnectorClientBase

Typed client for smtp connector.

Initialize a SmtpClient.

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:

send_email_async async
send_email_async(input: Email) -> None

Send Email

This operation sends an email to one or more recipients.