gmail-node-sender

To use the library, install it with:

npm install gmail-node-sender

Requires Node.js 22.x

Default Values

There are no internal default values for sending email. All fields must be provided via the input interfaces. Optional fields:

• bcc (optional): string or string[]
• replyTo (optional): string

Interfaces

export interface GmailNodeSenderAuth {
  user: string; // Gmail address
  pass: string; // Gmail App Password
}

export interface GmailNodeSenderMessage {
  from: string; // Sender Gmail address
  to: string | string[]; // Recipient(s)
  bcc?: string | string[]; // Optional BCC
  subject: string; // Email subject
  html: string; // Email body (HTML)
  replyTo?: string; // Optional reply-to address
}

export interface GmailNodeSenderSendResponse {
  success: boolean;
  info?: unknown; // Nodemailer info object
  error?: unknown; // Error if failed
}

export type GmailNodeSenderLogger = {
  log: (...args: unknown[]) => void;
  error: (...args: unknown[]) => void;
};

Example Usage

import { sendEmail, GmailNodeSenderAuth, GmailNodeSenderMessage } from 'gmail-node-sender';

const auth: GmailNodeSenderAuth = {
  user: '[email protected]',
  pass: 'your-app-password',
};

const message: GmailNodeSenderMessage = {
  from: '[email protected]',
  to: '[email protected]',
  subject: 'Hello from gmail-node-sender',
  html: '<b>This is a test email</b>',
};

sendEmail(auth, message).then((response) => {
  if (response.success) {
    console.log('Email sent:', response.info);
  } else {
    console.error('Failed to send email:', response.error);
  }
});

Custom Logging

You can provide a custom logger to capture logs and errors:

import { setGmailNodeSenderLogger } from 'gmail-node-sender';

setGmailNodeSenderLogger({
  log: (...args) => {
    /* custom log logic */
  },
  error: (...args) => {
    /* custom error logic */
  },
});

Badges