diff options
| author | Raphael Kabo <mail@raphaelkabo.com> | 2025-05-27 19:07:27 +0100 | 
|---|---|---|
| committer | Raphael Kabo <mail@raphaelkabo.com> | 2025-05-27 19:07:27 +0100 | 
| commit | bc9e983b16d9ac2d27a4458c0a87f9d11aa80c0e (patch) | |
| tree | 287e122c66548c4e44995492f044b1f3409516c7 /src/lib | |
| parent | 69f75005303d634b9208c23068655385734f4d3a (diff) | |
Add Mailgun email service
Diffstat (limited to 'src/lib')
| -rw-r--r-- | src/lib/config.ts | 7 | ||||
| -rw-r--r-- | src/lib/email.ts | 71 | 
2 files changed, 66 insertions, 12 deletions
diff --git a/src/lib/config.ts b/src/lib/config.ts index 6642eef..3fd6eb7 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -21,7 +21,7 @@ export interface GathioConfig {          email_logo_url: string;          show_kofi: boolean;          show_public_event_list: boolean; -        mail_service: "nodemailer" | "sendgrid" | "none"; +        mail_service: "nodemailer" | "sendgrid" | "mailgun" | "none";          creator_email_addresses: string[];      };      database: { @@ -37,6 +37,11 @@ export interface GathioConfig {      sendgrid?: {          api_key: string;      }; +    mailgun?: { +        api_key: string; +        api_url: string; +        domain: string; +    };      static_pages?: StaticPage[];  } diff --git a/src/lib/email.ts b/src/lib/email.ts index 7c7c2dd..fc585a1 100644 --- a/src/lib/email.ts +++ b/src/lib/email.ts @@ -5,6 +5,8 @@ import nodemailer, { Transporter } from "nodemailer";  import { GathioConfig, getConfig } from "./config.js";  import SMTPTransport from "nodemailer/lib/smtp-transport/index.js";  import { exitWithError } from "./process.js"; +import Mailgun from "mailgun.js"; +import { IMailgunClient } from "node_modules/mailgun.js/Types/Interfaces/index.js";  const config = getConfig(); @@ -24,7 +26,8 @@ type EmailTemplateName =  export class EmailService {      nodemailerTransporter: Transporter | undefined = undefined;      sgMail: typeof sgMail | undefined = undefined; -    hbs: ExpressHandlebars +    mailgunClient: IMailgunClient | undefined = undefined; +    hbs: ExpressHandlebars;      public constructor(config: GathioConfig, hbs: ExpressHandlebars) {          this.hbs = hbs; @@ -40,6 +43,26 @@ export class EmailService {                  console.log("Sendgrid is ready to send emails.");                  break;              } +            case "mailgun": { +                if ( +                    !config.mailgun?.api_key || +                    !config.mailgun?.api_url || +                    !config.mailgun?.domain +                ) { +                    return exitWithError( +                        "Mailgun is configured as the email service, but not all required fields are provided. Please provide all required fields in the config file.", +                    ); +                } +                const mailgun = new Mailgun(FormData); +                this.mailgunClient = mailgun.client({ +                    username: "api", +                    key: config.mailgun.api_key, +                    url: config.mailgun.api_url, +                }); +                // TODO: Can we verify the Mailgun connection? +                console.log("Mailgun is ready to send emails."); +                break; +            }              case "nodemailer": {                  if (config.nodemailer?.smtp_url) {                      this.nodemailerTransporter = nodemailer.createTransport( @@ -73,13 +96,13 @@ export class EmailService {                          nodemailer.createTransport(nodemailerConfig);                  }              } -          }      }      public async verify(): Promise<boolean> {          if (this.nodemailerTransporter) { -            const nodemailerVerified = await this.nodemailerTransporter.verify(); +            const nodemailerVerified = +                await this.nodemailerTransporter.verify();              if (nodemailerVerified) {                  console.log("Nodemailer is ready to send emails.");                  return true; @@ -118,9 +141,36 @@ export class EmailService {                  return true;              } catch (e: unknown | sgHelpers.classes.ResponseError) {                  if (e instanceof sgHelpers.classes.ResponseError) { -                    console.error('sendgrid error', e.response.body); +                    console.error("sendgrid error", e.response.body); +                } else { +                    console.error("sendgrid error", e); +                } +                return false; +            } +        } else if (this.mailgunClient) { +            try { +                if (!config.mailgun?.domain) { +                    return exitWithError( +                        "Mailgun is configured as the email service, but no domain is provided. Please provide a domain in the config file.", +                    ); +                } +                await this.mailgunClient.messages.create( +                    config.mailgun.domain, +                    { +                        from: config.general.email, +                        to, +                        bcc, +                        subject: `${config.general.site_name}: ${subject}`, +                        text, +                        html, +                    }, +                ); +                return true; +            } catch (e: any) { +                if (e.response) { +                    console.error(e.response.body);                  } else { -                    console.error('sendgrid error', e); +                    console.error(e);                  }                  return false;              } @@ -150,15 +200,14 @@ export class EmailService {          bcc = "",          subject,          templateName, -        templateData = {} +        templateData = {},      }: {          to: string | string[];          bcc?: string | string[] | undefined;          subject: string;          templateName: EmailTemplateName;          templateData?: object; -    }, -    ): Promise<boolean> { +    }): Promise<boolean> {          const [html, text] = await Promise.all([              this.hbs.renderView(                  `./views/emails/${templateName}/${templateName}Html.handlebars`, @@ -172,7 +221,7 @@ export class EmailService {                      cache: true,                      layout: "email.handlebars",                      ...templateData, -                } +                },              ),              this.hbs.renderView(                  `./views/emails/${templateName}/${templateName}Text.handlebars`, @@ -186,7 +235,7 @@ export class EmailService {                      cache: true,                      layout: "email.handlebars",                      ...templateData, -                } +                },              ),          ]); @@ -195,7 +244,7 @@ export class EmailService {              bcc,              subject: `${config.general.site_name}: ${subject}`,              text, -            html +            html,          });      }  }  | 
