Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Mailchimp Email Adapater #45

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

AVDiv
Copy link

@AVDiv AVDiv commented Oct 8, 2023

What does this PR do?

This PR contains an implementation of the mailchimp transactional email adapter.

Test Plan

1. Setup your mailchimp account

  • First of all, Create a Mailchimp account and set it up.

2. Setup the Mandrill credentials

  • When you reach the dashboard, find for the option Automations > Transactional Emails on the left navigation pane.
  • In this page you will find a Launch App
  • Once you reach the mandrill dashboard, you will need to verify your Sending Domains . For that you have to go to Domains > Sending Domains. Next Add your domain, verify your Domain and DKIM settings by adding the relevant TXT records on your DNS.
  • Once you are done with that, you can proceed to creating a new API key on SMTP & API Info > New API Key. Also don't forget to copy the API Key to somewhere safe.

3. Install relevant PHP Extensions and Dependencies

  • You require PHP-extensions like php-curl to run this project, so make sure to get them installed first.

Example (linux-based systems):

sudo apt update &&
sudo apt install php-curl php-mbstring php-xml
  • Next, install the relevant project dependecies by using composer
composer install

3. Test the project with relevant Environment Variables

TEST_EMAIL - The recipient email address
TEST_EMAIL_FROM - The sender email address
MAILCHIMP_API_KEY - The mailchimp API key

  • Fill there 3 environment variables and run the following command to test:
MAILCHIMP_API_KEY=<YOUR_MAILCHIMP_API_KEY> TEST_EMAIL=<YOUR_RECIPIENT_EMAIL> TEST_FROM_EMAIL=<YOUR_SENDER_EMAIL> ./vendor/bin/phpunit tests/e2e/Email/MailchimpTest.php

Related PRs and Issues

closes: appwrite/appwrite#6388

Have you read the Contributing Guidelines on issues?

Yes

@wess
Copy link
Contributor

wess commented Oct 19, 2023

Please run pint/linter :)

@AVDiv
Copy link
Author

AVDiv commented Oct 20, 2023

@wess Resolved linting errors, Please check now.
I'm not allowed to request reviews

@AVDiv
Copy link
Author

AVDiv commented Oct 27, 2023

Hey @wess, any updates?

Copy link

@stnguyen90 stnguyen90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Please also attach a screenshot of successful test

@AVDiv
Copy link
Author

AVDiv commented Nov 1, 2023

Group 16 (1)
These are the test results

@AVDiv AVDiv requested a review from stnguyen90 November 1, 2023 10:29
Copy link

@stnguyen90 stnguyen90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey 👋 awesome work on your PR! We've approved your work and it'll be merged soon!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

💬 Improve Appwrite Messaging with Mailchimp Adapter
4 participants