From 3c46c391143a52e5d97e0574f4f42ee190cf22b0 Mon Sep 17 00:00:00 2001
From: "Jon@1599" <55296387+Jonathan1599@users.noreply.github.com>
Date: Sun, 7 May 2023 03:38:04 +0530
Subject: [PATCH] feat: catch emails sent locally using Mailhog (#8470)

* feat: added mailhog to catch emails sent locally

* fix: added new line at the end of packages/emails/docker-compose.yml

* chore: removed EMAIL_SERVER_USER and EMAIL_SERVER_PASSWORD for local usage with Mailhog

---------

Co-authored-by: Keith Williams <keithwillcode@gmail.com>
Co-authored-by: Peer Richelsen <peeroke@gmail.com>
---
 .env.example                       | 12 ++++++++----
 README.md                          |  6 ++++++
 packages/emails/docker-compose.yml |  8 ++++++++
 packages/emails/package.json       |  3 +++
 4 files changed, 25 insertions(+), 4 deletions(-)
 create mode 100644 packages/emails/docker-compose.yml

diff --git a/.env.example b/.env.example
index 0a75c7390a..d1023ca7c0 100644
--- a/.env.example
+++ b/.env.example
@@ -138,12 +138,16 @@ API_KEY_PREFIX=cal_
 EMAIL_FROM='notifications@yourselfhostedcal.com'
 
 # Configure SMTP settings (@see https://nodemailer.com/smtp/).
+# Configuration to receive emails locally (mailhog)
+EMAIL_SERVER_HOST='localhost'
+EMAIL_SERVER_PORT=1025
+
 # Note: The below configuration for Office 365 has been verified to work.
-EMAIL_SERVER_HOST='smtp.office365.com'
-EMAIL_SERVER_PORT=587
-EMAIL_SERVER_USER='<office365_emailAddress>'
+# EMAIL_SERVER_HOST='smtp.office365.com'
+# EMAIL_SERVER_PORT=587
+# EMAIL_SERVER_USER='<office365_emailAddress>'
 # Keep in mind that if you have 2FA enabled, you will need to provision an App Password.
-EMAIL_SERVER_PASSWORD='<office365_password>'
+# EMAIL_SERVER_PASSWORD='<office365_password>'
 
 # The following configuration for Gmail has been verified to work.
 # EMAIL_SERVER_HOST='smtp.gmail.com'
diff --git a/README.md b/README.md
index 6ded34330f..dd0fd9a1b5 100644
--- a/README.md
+++ b/README.md
@@ -200,6 +200,12 @@ echo 'NEXT_PUBLIC_DEBUG=1' >> .env
    ```sh
    yarn workspace @calcom/prisma db-deploy
    ```
+1. Run [mailhog](https://github.com/mailhog/MailHog) to view emails sent during development
+
+   ```sh
+   docker pull mailhog/mailhog
+   docker run -d -p 8025:8025 -p 1025:1025 mailhog/mailhog
+   ```
 
 1. Run (in development mode)
 
diff --git a/packages/emails/docker-compose.yml b/packages/emails/docker-compose.yml
new file mode 100644
index 0000000000..4eaf50158d
--- /dev/null
+++ b/packages/emails/docker-compose.yml
@@ -0,0 +1,8 @@
+# Starts mailhog SMTP server on port 1025, web interface on port 8025
+version: "3.6"
+services:    
+  mailhog:
+    image: 'mailhog/mailhog:latest'
+    ports:
+      - "1025:1025"
+      - "8025:8025"
diff --git a/packages/emails/package.json b/packages/emails/package.json
index 9454e7db25..786d6ab25e 100644
--- a/packages/emails/package.json
+++ b/packages/emails/package.json
@@ -3,6 +3,9 @@
   "sideEffects": false,
   "version": "0.0.0",
   "private": true,
+  "scripts": {
+    "dx": "docker compose up -d"
+  },
   "dependencies": {
     "@calcom/dayjs": "*",
     "@calcom/lib": "*",