Module supertokens_python.ingredients.emaildelivery.services.smtp

Classes

class EmailDeliverySMTPConfig (smtp_settings: SMTPServiceConfig, override: Optional[Callable[[ServiceInterface[~_T]], ServiceInterface[~_T]]] = None)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def getitem(self, key: KT) -> VT: … # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

Expand source code

class EmailDeliverySMTPConfig(Generic[_T]):
    def __init__(self,
                 smtp_settings: SMTPServiceConfig,
                 override: Union[Callable[[ServiceInterface[_T]], ServiceInterface[_T]], None] = None
                 ) -> None:
        self.smtp_settings = smtp_settings
        self.override = override

Ancestors

• typing.Generic

class GetContentResult (body: str, subject: str, to_email: str, is_html: bool)

Expand source code

class GetContentResult:
    def __init__(self, body: str, subject: str, to_email: str, is_html: bool) -> None:
        self.body = body
        self.subject = subject
        self.to_email = to_email
        self.is_html = is_html

class SMTPServiceConfig (host: str, port: int, from_: SMTPServiceConfigFrom, password: Optional[str] = None, secure: Optional[bool] = None)

Expand source code

class SMTPServiceConfig:
    def __init__(
        self, host: str,
        port: int,
        from_: SMTPServiceConfigFrom,
        password: Union[str, None] = None,
        secure: Union[bool, None] = None,
    ) -> None:
        self.host = host
        self.from_ = from_
        self.password = password
        self.port = port
        self.secure = secure

class SMTPServiceConfigFrom (name: str, email: str)

Expand source code

class SMTPServiceConfigFrom:
    def __init__(self, name: str, email: str) -> None:
        self.name = name
        self.email = email

class ServiceInterface (transporter: Transporter)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class ServiceInterface(ABC, Generic[_T]):
    def __init__(self, transporter: Transporter) -> None:
        self.transporter = transporter

    @abstractmethod
    async def send_raw_email(self,
                             input_: GetContentResult,
                             user_context: Dict[str, Any]
                             ) -> None:
        pass

    @abstractmethod
    async def get_content(self, input_: _T, user_context: Dict[str, Any]) -> GetContentResult:
        pass

Ancestors

• abc.ABC
• typing.Generic

Subclasses

• ServiceImplementation
• ServiceImplementation
• ServiceImplementation
• ServiceImplementation
• ServiceImplementation
• ServiceImplementation
• ServiceImplementation

Methods

async def get_content(self, input_: ~_T, user_context: Dict[str, Any]) ‑> GetContentResult

Expand source code

@abstractmethod
async def get_content(self, input_: _T, user_context: Dict[str, Any]) -> GetContentResult:
    pass

async def send_raw_email(self, input_: GetContentResult, user_context: Dict[str, Any]) ‑> None

Expand source code

@abstractmethod
async def send_raw_email(self,
                         input_: GetContentResult,
                         user_context: Dict[str, Any]
                         ) -> None:
    pass

class Transporter (smtp_settings: SMTPServiceConfig)

Expand source code

class Transporter:
    def __init__(self, smtp_settings: SMTPServiceConfig) -> None:
        self.smtp_settings = smtp_settings

    async def _connect(self):
        try:
            tls_context = ssl.create_default_context()
            if self.smtp_settings.secure:
                # Use TLS from the beginning
                mail = aiosmtplib.SMTP(
                    self.smtp_settings.host, self.smtp_settings.port,
                    use_tls=True, tls_context=tls_context
                )
            else:
                # Start without TLS (but later try upgrading)
                mail = aiosmtplib.SMTP(self.smtp_settings.host, self.smtp_settings.port, use_tls=False)

            await mail.connect()  # type: ignore

            if not self.smtp_settings.secure:
                # Try upgrading to TLS (even if the user opted for secure=False)
                try:
                    await mail.starttls(tls_context=tls_context)
                except aiosmtplib.SMTPException:  # TLS wasn't supported by the server, so ignore.
                    pass

            if self.smtp_settings.password:
                await mail.login(self.smtp_settings.from_.email, self.smtp_settings.password)

            return mail
        except Exception as e:
            log_debug_message("Couldn't connect to the SMTP server: %s", e)
            raise e

    async def send_email(self, input_: GetContentResult,
                         _: Dict[str, Any]) -> None:
        connection = await self._connect()

        from_ = self.smtp_settings.from_
        try:
            from_addr = f"{from_.name} <{from_.email}>"
            if input_.is_html:
                email_content = MIMEText(input_.body, "html")
                email_content["From"] = from_addr
                email_content["To"] = input_.to_email
                email_content["Subject"] = input_.subject
                await connection.sendmail(from_.email, input_.to_email, email_content.as_string())
            else:
                await connection.sendmail(from_addr, input_.to_email, input_.body)
        except Exception as e:
            log_debug_message('Error in sending email: %s', e)
            raise e
        finally:
            await connection.quit()

Methods

async def send_email(self, input_: GetContentResult, _: Dict[str, Any]) ‑> None

Expand source code

async def send_email(self, input_: GetContentResult,
                     _: Dict[str, Any]) -> None:
    connection = await self._connect()

    from_ = self.smtp_settings.from_
    try:
        from_addr = f"{from_.name} <{from_.email}>"
        if input_.is_html:
            email_content = MIMEText(input_.body, "html")
            email_content["From"] = from_addr
            email_content["To"] = input_.to_email
            email_content["Subject"] = input_.subject
            await connection.sendmail(from_.email, input_.to_email, email_content.as_string())
        else:
            await connection.sendmail(from_addr, input_.to_email, input_.body)
    except Exception as e:
        log_debug_message('Error in sending email: %s', e)
        raise e
    finally:
        await connection.quit()