Skip to content

Email Providers

EmailProvider

Bases: ABC

Email delivery provider.

name property

name

Provider name (e.g. 'sendgrid', 'ses').

send abstractmethod async

send(event, to, from_=None, subject=None)

Send an email message.

Parameters:

Name Type Description Default
event RoomEvent

The room event containing the message content.

required
to str

Recipient email address.

required
from_ str | None

Sender email address override.

None
subject str | None

Email subject line.

None

Returns:

Type Description
ProviderResult

Result with provider-specific delivery metadata.

parse_inbound async

parse_inbound(payload)

Parse an inbound email payload into an InboundMessage.

close async

close()

Release resources. Override in subclasses that hold connections.

MockEmailProvider

MockEmailProvider()

Bases: EmailProvider

Records sent emails for verification in tests.