Module supertokens_python.recipe.emailpassword.emaildelivery.services.smtp

Expand source code 
# Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

from typing import Any, Dict, Callable, Union

from supertokens_python.ingredients.emaildelivery.services.smtp import Transporter
from supertokens_python.ingredients.emaildelivery.types import (
    EmailDeliveryInterface,
    SMTPServiceInterface,
    SMTPSettings,
)
from supertokens_python.recipe.emailpassword.types import (
    EmailTemplateVars,
    SMTPOverrideInput,
)

from .service_implementation import ServiceImplementation


class SMTPService(EmailDeliveryInterface[EmailTemplateVars]):
    service_implementation: SMTPServiceInterface[EmailTemplateVars]

    def __init__(
        self,
        smtp_settings: SMTPSettings,
        override: Union[Callable[[SMTPOverrideInput], SMTPOverrideInput], None] = None,
    ) -> None:
        transporter = Transporter(smtp_settings)

        oi = ServiceImplementation(transporter)
        self.service_implementation = oi if override is None else override(oi)

    async def send_email(
        self,
        template_vars: EmailTemplateVars,
        user_context: Dict[str, Any],
    ) -> None:
        content = await self.service_implementation.get_content(
            template_vars, user_context
        )
        await self.service_implementation.send_raw_email(content, user_context)

Sub-modules

supertokens_python.recipe.emailpassword.emaildelivery.services.smtp.password_reset
supertokens_python.recipe.emailpassword.emaildelivery.services.smtp.password_reset_email
supertokens_python.recipe.emailpassword.emaildelivery.services.smtp.service_implementation

Classes

class SMTPService (smtp_settings: SMTPSettings, override: Optional[Callable[[SMTPServiceInterface[PasswordResetEmailTemplateVars]], SMTPServiceInterface[PasswordResetEmailTemplateVars]]] = None)

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

Expand source code 
class SMTPService(EmailDeliveryInterface[EmailTemplateVars]):
    service_implementation: SMTPServiceInterface[EmailTemplateVars]

    def __init__(
        self,
        smtp_settings: SMTPSettings,
        override: Union[Callable[[SMTPOverrideInput], SMTPOverrideInput], None] = None,
    ) -> None:
        transporter = Transporter(smtp_settings)

        oi = ServiceImplementation(transporter)
        self.service_implementation = oi if override is None else override(oi)

    async def send_email(
        self,
        template_vars: EmailTemplateVars,
        user_context: Dict[str, Any],
    ) -> None:
        content = await self.service_implementation.get_content(
            template_vars, user_context
        )
        await self.service_implementation.send_raw_email(content, user_context)

Ancestors

Class variables

var service_implementation : SMTPServiceInterface[PasswordResetEmailTemplateVars]

Methods

async def send_email(self, template_vars: PasswordResetEmailTemplateVars, user_context: Dict[str, Any]) ‑> None
Expand source code 
async def send_email(
    self,
    template_vars: EmailTemplateVars,
    user_context: Dict[str, Any],
) -> None:
    content = await self.service_implementation.get_content(
        template_vars, user_context
    )
    await self.service_implementation.send_raw_email(content, user_context)