models

Classes:

• BaseEmailMessage –

  Common base class for all email messages

• EmailMessage –

  Pydantic model which represents an email message to send with explicit body contents.

• RawEmailMessage –

  Pydantic model which represents an email message to send which contains a raw message to send.

BaseEmailMessage

Bases: BaseModel

Common base class for all email messages

Attributes:

• from_address (Optional[NameEmail]) –
• to_addresses (list[NameEmail]) –
• cc_addresses (list[NameEmail]) –
• bcc_addresses (list[NameEmail]) –
• reply_to_addresses (Optional[list[NameEmail]]) –
• feedback_forwarding_address (Optional[NameEmail]) –
• tags (dict[str, str]) –

from_address class-attribute instance-attribute

from_address = None

to_addresses class-attribute instance-attribute

to_addresses = Field(default_factory=list)

cc_addresses class-attribute instance-attribute

cc_addresses = Field(default_factory=list)

bcc_addresses class-attribute instance-attribute

bcc_addresses = Field(default_factory=list)

reply_to_addresses class-attribute instance-attribute

reply_to_addresses = Field(default_factory=list)

feedback_forwarding_address class-attribute instance-attribute

feedback_forwarding_address = None

tags class-attribute instance-attribute

tags = Field(default_factory=dict)

EmailMessage

Bases: BaseEmailMessage

Pydantic model which represents an email message to send with explicit body contents.

Methods:

• ensure_body_text –

Attributes:

• subject (str) –
• body_text (Optional[str]) –
• body_html (Optional[str]) –
• from_address (Optional[NameEmail]) –
• to_addresses (list[NameEmail]) –
• cc_addresses (list[NameEmail]) –
• bcc_addresses (list[NameEmail]) –
• reply_to_addresses (Optional[list[NameEmail]]) –
• feedback_forwarding_address (Optional[NameEmail]) –
• tags (dict[str, str]) –

subject instance-attribute

subject

body_text class-attribute instance-attribute

body_text = None

body_html class-attribute instance-attribute

body_html = None

from_address class-attribute instance-attribute

from_address = None

to_addresses class-attribute instance-attribute

to_addresses = Field(default_factory=list)

cc_addresses class-attribute instance-attribute

cc_addresses = Field(default_factory=list)

bcc_addresses class-attribute instance-attribute

bcc_addresses = Field(default_factory=list)

reply_to_addresses class-attribute instance-attribute

reply_to_addresses = Field(default_factory=list)

feedback_forwarding_address class-attribute instance-attribute

feedback_forwarding_address = None

tags class-attribute instance-attribute

tags = Field(default_factory=dict)

ensure_body_text

ensure_body_text()

RawEmailMessage

Bases: BaseEmailMessage

Pydantic model which represents an email message to send which contains a raw message to send. This should ideally only be used by libraries as the requirements on the raw message format are quite strict.

See: https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_RawMessage.html

Attributes:

• raw_message (str) –
• from_address (Optional[NameEmail]) –
• to_addresses (list[NameEmail]) –
• cc_addresses (list[NameEmail]) –
• bcc_addresses (list[NameEmail]) –
• reply_to_addresses (Optional[list[NameEmail]]) –
• feedback_forwarding_address (Optional[NameEmail]) –
• tags (dict[str, str]) –

raw_message instance-attribute

raw_message

from_address class-attribute instance-attribute

from_address = None

to_addresses class-attribute instance-attribute

to_addresses = Field(default_factory=list)

cc_addresses class-attribute instance-attribute

cc_addresses = Field(default_factory=list)

bcc_addresses class-attribute instance-attribute

bcc_addresses = Field(default_factory=list)

reply_to_addresses class-attribute instance-attribute

reply_to_addresses = Field(default_factory=list)

feedback_forwarding_address class-attribute instance-attribute

feedback_forwarding_address = None

tags class-attribute instance-attribute

tags = Field(default_factory=dict)