Setting up Mailgun with TypeScript on Firebase Cloud Functions

Question

Setting up Mailgun with TypeScript on Firebase Cloud Functions

Currently, I am working on a Cloud Function within Firebase to integrate with Mailgun for sending emails, following the guidelines provided in the Mailgun documentation.

My challenge lies in implementing this functionality using TypeScript, as I have been unable to locate any examples demonstrating how to configure the API KEY, DOMAIN, and ultimately send the email. Most resources available only show examples in JavaScript.

Here is an example in JavaScript:

var API_KEY = 'YOUR_API_KEY';
var DOMAIN = 'YOUR_DOMAIN_NAME';
var mailgun = require('mailgun-js')({apiKey: API_KEY, domain: DOMAIN});

const data = {
  from: 'Excited User <<a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="04696144776569746861772a6965d686d6c63636b6669692a69686e67616a23686569">[email protected]</a>>',
  to: '<a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="ee888181ae8b968f839e828bc08d81898386878e89898b82">[email protected]</a>, <a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="6705061527021f060a170b024904080a">[email protected]</a>',
  subject: 'Hello',
  text: 'Testing some Mailgun awesomeness!'
};

mailgun.messages().send(data, (error, body) => {
  console.log(body);
});

And here's what it looks like in TypeScript:

const API_KEY = 'YOUR_API_KEY';
const DOMAIN = 'YOUR_DOMAIN_NAME';

import * as mailgun from 'mailgun-js';
// How do I set this up ?

// How can I send the email ?

Although I attempted to use the ts-mailgun package, which simplifies email sending tasks, I encountered issues when deploying the function due to errors.

Ultimately, my objective is to successfully configure Mailgun using TypeScript to effectively deliver emails to users.

typescript google-cloud-functions mailgun

Answer 1

Answer №1

npm install ts-mailgun

After installing, follow these steps:


import { NodeMailgun } from 'ts-mailgun';

const mailer = new NodeMailgun();
mailer.apiKey = 'YOUR_API_KEY_HERE'; // Enter your API key
mailer.domain = 'mail.my-sample-app.com'; // Enter the domain you registered earlier
mailer.fromEmail = 'your-email@example.com'; // Set your email address
mailer.fromTitle = 'My Sample App'; // Set the name you are sending from

mailer.init();

// Sending an email to sample@example.com
mailer
    .send('sample@example.com', 'Hello!', '<h1>Sample Message</h1>')
    .then((result) => console.log('Email sent successfully', result))
    .catch((error) => console.error('Error sending email: ', error));

Source: ts-mailgun documentation

Answer 2

npm install ts-mailgun

After installing, follow these steps:


import { NodeMailgun } from 'ts-mailgun';

const mailer = new NodeMailgun();
mailer.apiKey = 'YOUR_API_KEY_HERE'; // Enter your API key
mailer.domain = 'mail.my-sample-app.com'; // Enter the domain you registered earlier
mailer.fromEmail = 'your-email@example.com'; // Set your email address
mailer.fromTitle = 'My Sample App'; // Set the name you are sending from

mailer.init();

// Sending an email to sample@example.com
mailer
    .send('sample@example.com', 'Hello!', '<h1>Sample Message</h1>')
    .then((result) => console.log('Email sent successfully', result))
    .catch((error) => console.error('Error sending email: ', error));

Source: ts-mailgun documentation

Answer 3

Answer №2

Even though this question was asked more than a year ago, I took a look at the GitHub page linked in the @types/mailgun-js documentation here:

https://github.com/DefinitelyTyped/DefinitelyTyped/blob/58081d555e64d07049d2da6115e5118240162c73/types/mailgun-js/index.d.ts#L18

Upon examining the ConstructorParams interface and its usage, it became apparent that initializing the mailgun object as shown below is necessary. Upon making this change, the types started functioning correctly for me.

import mg from 'mailgun-js';

const api_key = process.env.MG_API_KEY as string;
const DOMAIN = process.env.MG_DOMAIN as string;
const mailgun = new mg({apiKey: api_key, domain: DOMAIN});
const UsersMailList = mailgun.lists(process.env.USERS_LIST as string);

Answer 4

Even though this question was asked more than a year ago, I took a look at the GitHub page linked in the @types/mailgun-js documentation here:

https://github.com/DefinitelyTyped/DefinitelyTyped/blob/58081d555e64d07049d2da6115e5118240162c73/types/mailgun-js/index.d.ts#L18

Upon examining the ConstructorParams interface and its usage, it became apparent that initializing the mailgun object as shown below is necessary. Upon making this change, the types started functioning correctly for me.

import mg from 'mailgun-js';

const api_key = process.env.MG_API_KEY as string;
const DOMAIN = process.env.MG_DOMAIN as string;
const mailgun = new mg({apiKey: api_key, domain: DOMAIN});
const UsersMailList = mailgun.lists(process.env.USERS_LIST as string);

Setting up Mailgun with TypeScript on Firebase Cloud Functions

Answer №1

Answer №2

Similar questions

Transitioning a JavaScriptIonicAngular 1 application to TypescriptIonic 2Angular 2 application

Struggling with an issue in React and Bootstrap4 while developing an application with create-react-app

Guide on incorporating Kendo UI typings into a TypeScript module

Ways to manage an rxjs observable reaction that may potentially have no data?

Looking to implement nested routes in Angular to ensure that each component's view updates properly

Error: THREE.MTLLoader cannot be instantiated 2.0

How can I detect if a control value has been changed in a FormGroup within Angular 2? Are there any specific properties to look

Utilizing the URL path name for data retrieval in Next.js 14 - A step-by-step guide

Using TypeScript to Import Modules without Default Exports (CommonJS)

Achieving the incorporation of multiple components within a parent component using Angular 6

The module '@ngmodule/material-carousel' could not be located

What is the best way to select types conditionally based on the presence of a property in another type?

What are some ways to incorporate advanced/nested type variables when using arrow functions?

Incorporating an external module into your Angular application for local use

Tips for identifying the most effective element locator in the DOM with Playwright

Ways to utilize a field from an interface as a type of index

Strange occurrences with HTML image tags

Exploring the possibilities with Rollbar and TypeScript

The ngx-datatable encountered a resolution issue with its dependency tree and was unable to resolve it

Having trouble creating a unit test for exporting to CSV in Angular