Reapply "SES integration (#23)" (#24) (#25)

This reverts commit 1f2d2af.

Reapply "SES integration (#23)"

Author: sasidharan19

app/config.py

@@ -49,5 +49,9 @@ class Config(BaseSettings):
     DESCRIPTION: str = SWAGGER_APP_DESCRIPTION
     PORT: int = cast(int, os.getenv("PORT", "8000"))
 
+    AWS_SECRET_KEY: str = cast(str, os.getenv("AWS_SECRET_KEY"))
+    AWS_ACCESS_KEY: str = cast(str, os.getenv("AWS_ACCESS_KEY"))
+    AWS_REGION: str = cast(str, os.getenv("AWS_REGION"))
+    AWS_EMAIL: str = cast(str, os.getenv("AWS_EMAIL"))
 
 config = Config()

app/routers/email_router.py

@@ -2,12 +2,16 @@
 Email router for creating and controlling the endpoint. 
 """
 
+from typing import Dict, Union
+
 from fastapi import APIRouter, Depends, HTTPException, status, Request
 from fastapi.templating import Jinja2Templates
+
 from app.services.email_service import EmailService
-from app.schemas.email import SendEmailRequestBody, SendEmailResponseBody
+from app.schemas.email import SendEmailRequestBody, SendEmailResponseBody, EmailProvider
 from app.utils import (
     EmailSender,
+    SESEmailSender,
     success_response,
     get_email_sender,
     require_authentication,
@@ -23,7 +27,9 @@
 async def send_email(
     request: Request,
     email_details: SendEmailRequestBody,
-    email_sender: EmailSender = Depends(get_email_sender),
+    email_sender: Dict[EmailProvider, Union[EmailSender, SESEmailSender]] = Depends(
+        get_email_sender
+    ),
 ):
     """
     Sends an email to the recipient using provided details.

app/schemas/email.py

@@ -3,11 +3,17 @@
 """
 
 from typing import Optional, Dict, List
+from enum import Enum
 from fastapi import HTTPException, status
 from pydantic import BaseModel, EmailStr, field_validator, ValidationInfo
 from app.config import config
 
 
+class EmailProvider(str, Enum):
+    GMAIL = "GMAIL"
+    SES = "SES"
+
+
 class SendEmailRequestBody(BaseModel):
     """
     Request body for sending emails.
@@ -28,6 +34,7 @@ class SendEmailRequestBody(BaseModel):
     cc: Optional[List[EmailStr]] = None
     bcc: Optional[List[EmailStr]] = None
     self: bool = False
+    provider: EmailProvider = EmailProvider.SES
 
     @field_validator("body")
     @classmethod

app/services/email_service.py

@@ -2,45 +2,62 @@
 Third party email service configuration for sending emails.
 """
 
+from typing import Dict, Union
+
 from smtplib import SMTPException, SMTPAuthenticationError, SMTPSenderRefused
-from app.utils import EmailSender
-from app.schemas.email import SendEmailRequestBody
+import botocore.exceptions
+
+from app.utils import EmailSender, SESEmailSender
+from app.schemas.email import SendEmailRequestBody, EmailProvider
 
 
 class EmailService:
     """
     Service layer for handling email sending logic.
     """
 
-    def __init__(self, email_sender: EmailSender):
+    def __init__(
+        self, email_sender: Dict[EmailProvider, Union[EmailSender, SESEmailSender]]
+    ):
         self.email_sender = email_sender
 
     def send_email(self, email_details: SendEmailRequestBody, body: str):
         """
         Sends an email based on email details.
-
         Args:
             email_details (SendEmailRequestBody): Details for the email.
             body (str): body of the email.
 
         Returns:
-            bool: True if no failure occured on sending email.
+            dict: A response dictionary containing:
+                - "success" (bool): Indicates whether the email was sent successfully.
+                - "error": Error message if the email sending fails.
         """
         try:
-            result = self.email_sender.send_email(
-                to_email=email_details.recipient,
-                subject=email_details.subject,
-                body=body,
-                cc=email_details.cc,
-                bcc=email_details.bcc,
-                is_html=True,
-            )
+            result = self._send_email_by_provider(email_details, body)
             return result
-        except SMTPAuthenticationError as exc:
-            raise PermissionError(
-                "Failed to authenticate with the SMTP server."
-            ) from exc
-        except SMTPSenderRefused as exc:
-            raise ValueError("Sender address refused by the SMTP server.") from exc
-        except SMTPException as smtp_exc:
-            raise ConnectionError(f"SMTP error occurred: {smtp_exc}") from smtp_exc
+        except Exception as error:
+            self._handle_email_error(error)
+
+    def _send_email_by_provider(self, email_details: SendEmailRequestBody, body: str):
+        provider = email_details.provider
+        sender = self.email_sender.get(provider)
+        result = sender.send_email(
+            to_email=email_details.recipient,
+            subject=email_details.subject,
+            body=body,
+            cc=email_details.cc,
+            bcc=email_details.bcc,
+            is_html=True,
+        )
+        return result
+
+    def _handle_email_error(self, error: Exception):
+        if isinstance(
+            error, (SMTPAuthenticationError, botocore.exceptions.ClientError)
+        ):
+            raise PermissionError(f"Authentication failed: {str(error)}") from error
+        elif isinstance(error, SMTPSenderRefused):
+            raise ValueError(f"Email address refused: {str(error)}") from error
+        else:
+            raise ConnectionError(f"Email sending failed: {str(error)}") from error

app/utils/__init__.py

@@ -1,4 +1,4 @@
-from .email_sender import EmailSender
+from .email_sender import EmailSender, SESEmailSender
 from .dependencies import require_authentication, get_email_sender
 from .response import error_response, success_response
 from .exceptions import custom_http_exception_handler, custom_general_exception_handler

app/utils/dependencies.py

@@ -3,9 +3,11 @@
 """
 
 from functools import wraps
+from typing import Dict, Union
 from fastapi import HTTPException, Request
 from app.config import config
-from .email_sender import EmailSender
+from app.schemas.email import EmailProvider
+from .email_sender import EmailSender, SESEmailSender
 
 
 def require_authentication():
@@ -27,14 +29,23 @@ async def wrapper(request: Request, *args, **kwargs):
     return decorator
 
 
-def get_email_sender() -> EmailSender:
+def get_email_sender() -> Dict[EmailProvider, Union[EmailSender, SESEmailSender]]:
     """
-    Creates and returns an EmailSender object.
+    Creates and returns a dictionary of email sender objects.
     This function is used as a dependency injection in the controller.
     """
-    return EmailSender(
+    gmail_sender = EmailSender(
         smtp_server=config.EMAIL_HOST,
         smtp_port=config.EMAIL_PORT,
         username=config.EMAIL_ADDRESS,
         password=config.EMAIL_PASSWORD,
     )
+
+    ses_sender = SESEmailSender(
+        aws_access_key=config.AWS_ACCESS_KEY,
+        aws_secret_key=config.AWS_SECRET_KEY,
+        aws_region=config.AWS_REGION,
+        aws_email=config.AWS_EMAIL,
+    )
+
+    return {EmailProvider.GMAIL: gmail_sender, EmailProvider.SES: ses_sender}

app/utils/email_sender.py

@@ -3,6 +3,7 @@
 """
 
 import smtplib
+import boto3
 from email.message import EmailMessage
 from typing import List
 
@@ -48,7 +49,7 @@ def send_email(
         cc: List[EmailStr],
         bcc: List[EmailStr],
         is_html: bool = False,
-    ) -> bool:
+    ) -> dict:
         """
         Sends an email using the configured SMTP settings.
 
@@ -58,9 +59,10 @@ def send_email(
             body (str): The body of the email, which can be in plain text or HTML.
             is_html (bool, optional): Specifies whether the email body is HTML content.
                                       Defaults to False.
-
         Returns:
-            dict: A response dictionary containing the success of the email send action.
+            dict: A response dictionary containing:
+                - "success" (bool): Indicates whether the email was sent successfully.
+                - "error": Error message if the email sending fails.
 
         Raises:
             Exception: If there is an error during the email-sending process,
@@ -82,5 +84,56 @@ def send_email(
                 server.login(self.username, self.password)
                 server.send_message(msg)
             return {"success": True}
-        except Exception as e:
-            raise e
+        except Exception as error:
+            raise ConnectionError(f"Email sending failed: {str(error)}") from error
+
+
+class SESEmailSender:
+    """
+    A helper class for sending emails using AWS SES.
+
+    This class provides methods for sending emails through Amazon Simple Email Service (SES).
+    """
+
+    def __init__(
+        self, aws_access_key: str, aws_secret_key: str, aws_region: str, aws_email: str
+    ):
+        self.aws_access_key = aws_access_key
+        self.aws_secret_key = aws_secret_key
+        self.aws_region = aws_region
+        self.aws_email = aws_email
+
+    def send_email(
+        self,
+        to_email: str,
+        subject: str,
+        body: str,
+        cc: List[EmailStr],
+        bcc: List[EmailStr],
+        is_html: bool = False,
+    ) -> dict:
+        try:
+            ses_client = boto3.client(
+                "ses",
+                region_name=self.aws_region,
+                aws_access_key_id=self.aws_access_key,
+                aws_secret_access_key=self.aws_secret_key,
+            )
+            message = {"Subject": {"Data": subject}, "Body": {}}
+            if is_html:
+                message["Body"]["Html"] = {"Data": body}
+            else:
+                message["Body"]["Text"] = {"Data": body}
+            destination = {
+                "ToAddresses": [to_email] if to_email else [],
+            }
+            if cc:
+                destination["CcAddresses"] = cc
+            if bcc:
+                destination["BccAddresses"] = bcc
+            response = ses_client.send_email(
+                Source=self.aws_email, Destination=destination, Message=message
+            )
+            return {"success": True, "message_id": response["MessageId"]}
+        except Exception as error:
+            raise ConnectionError(f"Email sending failed: {str(error)}") from error

env_example

@@ -5,4 +5,8 @@ EMAIL_PASSWORD=somepassword
 APP_SECRET=appsectsdjsnd
 ENV=development
 ORIGINS=https://abc.com,https://kbc.com
-PORT=5000
+PORT=5000
+AWS_SECRET_KEY=somesecretkey
+AWS_ACCESS_KEY=someaccesskey
+AWS_REGION=someregion
+AWS_EMAIL=awsverifiedemail

requirements.txt

@@ -35,3 +35,4 @@ typing_extensions==4.12.2
 uvicorn==0.32.0
 watchfiles==0.24.0
 websockets==13.1
+boto3>=1.37.27

run.py

@@ -13,4 +13,4 @@
 if __name__ == "__main__":
     # uvicorn.run("app.main:app", port=config.PORT, reload=True)
     # --> run locally with auto reload on change
-    uvicorn.run(app, port=config.PORT) # to run on vercel
+    uvicorn.run(app, port=config.PORT) # to run on vercel