Template to send emails #15

phamkelly17 · 2024-06-27T22:56:06Z

Notion ticket link

Email Reminders

Implementation description

Use NodeMailer to be able to send emails
Implemented unstyled template that allows us to send emails

Steps to test

Go to http://localhost:3000/email
Add recipients to the first text input. If you want to send to multiple emails, split them using a comma with no space after the comma. (e.g. "[email protected], [email protected]")
Add the email body to the textbox
Click send
Check your email and you should have received an email from [email protected]

What should reviewers focus on?

functionality

Checklist

My PR name is descriptive and in imperative tense
My commit messages are descriptive and in imperative tense. My commits are atomic and trivial commits are squashed or fixup'd into non-trivial commits
I have run the appropriate linter(s)
I have requested a review from the PL, as well as other devs who have background knowledge on this PR or who will be building on top of this PR

src/pages/api/sendEmail.ts

src/pages/email.tsx

src/pages/index.tsx

package.json

src/pages/api/sendEmail.ts

ChinemeremChigbo · 2024-07-01T18:01:53Z

src/pages/api/sendEmail.ts

+    const transporter = nodemailer.createTransport({
+      service: 'gmail',
+      auth: {
+        user: ['[email protected]'],


I would put these variables in the .env file instead of hardcoding them.

Please contact me to put the email / password in the hashicorp vault. I feel like we should probably use the sistema email instead of kelly's so let me know when you would like to set that up!

src/pages/api/sendEmail.ts

src/pages/email.tsx

tsconfig.json

ChinemeremChigbo · 2024-07-07T18:25:04Z

Please add the following to the .env.sample file:

EMAIL_PASS=
EMAIL_SERVICE=
EMAIL_USER=

ChinemeremChigbo · 2024-07-11T21:46:13Z

tsconfig.json

@@ -1,6 +1,6 @@
 {
  "compilerOptions": {
-    "target": "es5",
+    "target": "es2017",


I would just change this back to es5. Other than that, LGTM.

Could you change it back lol.

RahulTandon1 · 2024-07-14T05:47:19Z

@ChinemeremChigbo could you please help me understand the ticket a bit more.

To the best of my understanding, we're trying to do the following:
Whenever an absence is created/claimed (or edited in any important way), we want to notify all relevant users with an email.

The email follows a template. Example :

// not this does not follow the DB schemas. I'm just made the fields up.

Hey {user.firstName}!
The absence for the class {absence.class}  on `absence.date` has been claimed by {user2.firstName} {user2.lastName}.
More text...

The Sistema Toronto Team

Q1: In the long term / actual product we want the admin to be able to modify this template through a GUI...right?
Q2: The main point of this ticket is to get the email sending functionality up and running...right?
Q3: if there's anything you think is wrong with my understanding, could you please correct it?

RahulTandon1

It's really cool that you were able to get this running with such succinct code. I was expecting NodeMailer to be really tough to get working, but you made it look like easy like a pro dev :-)

src/pages/api/sendEmail.ts

src/pages/email.tsx

RahulTandon1 · 2024-07-14T05:39:55Z

src/pages/email.tsx

+        },
+        body: JSON.stringify({
+          to: emailRecipients,
+          subject: 'Hello World',


Could we add another Input/TextArea in the form and get the subject from there?

src/pages/api/sendEmail.ts

src/pages/email.tsx

phamkelly17 · 2024-07-18T22:38:34Z

@RahulTandon1 to answer your questions:
Q1: I thought the email would be a generic message like "Hi name, we see you haven't uploaded your lesson plan for your lesson in num days. Sincerely, Sistema". So I didn't think the template would be configurable.
Q2: Correct, this ticket is solely for functionality

ChinemeremChigbo · 2024-07-27T16:15:46Z

@ChinemeremChigbo could you please help me understand the ticket a bit more.

To the best of my understanding, we're trying to do the following: Whenever an absence is created/claimed (or edited in any important way), we want to notify all relevant users with an email.

The email follows a template. Example :
// not this does not follow the DB schemas. I'm just made the fields up.

Hey {user.firstName}!
The absence for the class {absence.class}  on `absence.date` has been claimed by {user2.firstName} {user2.lastName}.
More text...

The Sistema Toronto Team
Q1: In the long term / actual product we want the admin to be able to modify this template through a GUI...right? Q2: The main point of this ticket is to get the email sending functionality up and running...right? Q3: if there's anything you think is wrong with my understanding, could you please correct it?

Yes
Yes
There's nothing to correct

RahulTandon1

We're good to ship.
Sorry for all my delays Kelly.
Thank you!

src/pages/api/sendEmail.ts

vercel · 2024-09-21T20:37:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sistema	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 21, 2024 8:56pm

phamkelly17 requested review from ChinemeremChigbo and RahulTandon1 June 27, 2024 23:06

phamkelly17 marked this pull request as ready for review June 27, 2024 23:11