stellar / stellar-disbursement-platform-backend

Stellar Disbursement Platform Backend
Apache License 2.0
37 stars 22 forks source link

[Good First Issue] Enable SendGrid as an AWS SES Alternative #102

Open reecexlm opened 1 year ago

reecexlm commented 1 year ago

As part of the ongoing efforts to enhance the Stellar Disbursement Platform (SDP), we aim to integrate SendGrid as an alternative to AWS Simple Email Service (SES) for sending emails. This integration will provide additional flexibility and options for email delivery within the platform.

The task involves creating a new SendGrid email client, adapting message formatting to align with SendGrid's API, and extending the existing email client factory to support this new integration. It will also require adding necessary configurations and ensuring seamless integration into the current system, with a focus on maintainability and scalability.

Changes will likely include:

Testing and Validation Unit Tests: Write unit tests for the new SendGrid client ensuring that emails are correctly formatted and sent. Should be able to run them locally.

Error Handling: Implement robust error handling and logging for the SendGrid integration.

Documentation: Update the technical documentation to reflect the new SendGrid integration and its configuration.

Important! - We appreciate you contributing. Please note:

Documentation: Check out our documentation and step-by-step local dev environment setup instructions in the repository README

Thank you!

steven-tomlinson commented 11 months ago

FYI: we're working on integrating this with the PostMark API for our Pakana project.

https://postmark.com

https://communityfund.stellar.org/project/recz9ztUMJstmgCIM

Oyase-shinobi commented 2 months ago

Hello @steven-tomlinson @reecexlm I can do it may I take this issue?