@nest-boot/mailer

Namespaces

Mailer

Classes

Mailer

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:17

Creates an object for exposing the Mail API

Extends

EventEmitter

Type Parameters

Type Parameter
`T`
`DefaultTransportOptions`

Constructors

Constructor

new Mailer<T, DefaultTransportOptions>(
   transporter, 
   options?, 
defaults?): Mailer<T, DefaultTransportOptions>;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:180

Parameters

Parameter	Type
`transporter`	`Transport`<`T`>
`options?`	`TransportOptions`
`defaults?`	`DefaultTransportOptions`

Returns

Mailer<T, DefaultTransportOptions>

Overrides

EventEmitter.constructor

Properties

_defaults

_defaults: DefaultTransportOptions;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:178

dkim

dkim: DKIM;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:171

logger

logger: Logger;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:173

MailMessage

MailMessage: MailMessage<T>;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:176

Usage: typeof transporter.MailMessage

options

options: Options;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:169

transporter

transporter: Transport<T>;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:172

captureRejections

static captureRejections: boolean;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:425

Value: boolean

Change the default captureRejections option on all new EventEmitter objects.

Since

v13.4.0, v12.16.0

Inherited from

EventEmitter.captureRejections

captureRejectionSymbol

readonly static captureRejectionSymbol: typeof captureRejectionSymbol;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:418

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

Since

v13.4.0, v12.16.0

Inherited from

EventEmitter.captureRejectionSymbol

defaultMaxListeners

static defaultMaxListeners: number;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:464

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property can be used. If this value is not a positive number, a RangeError is thrown.

Take caution when setting the events.defaultMaxListeners because the change affects all EventEmitter instances, including those created before the change is made. However, calling emitter.setMaxListeners(n) still has precedence over events.defaultMaxListeners.

This is not a hard limit. The EventEmitter instance will allow more listeners to be added but will output a trace warning to stderr indicating that a "possible EventEmitter memory leak" has been detected. For any single EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners() methods can be used to temporarily avoid this warning:

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

The --trace-warnings command-line flag can be used to display the stack trace for such warnings.

The emitted warning can be inspected with process.on('warning') and will have the additional emitter, type, and count properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

Since

v0.11.2

Inherited from

EventEmitter.defaultMaxListeners

errorMonitor

readonly static errorMonitor: typeof errorMonitor;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:411

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

Since

v13.6.0, v12.17.0

Inherited from

EventEmitter.errorMonitor

Methods

[captureRejectionSymbol]()?

optional [captureRejectionSymbol]<K>(
   error, 
   event, ...
   args): void;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:103

Type Parameters

Type Parameter
`K`

Parameters

Parameter	Type
`error`	`Error`
`event`	`string` \| `symbol`
...`args`	`AnyRest`

Returns

void

Inherited from

EventEmitter.[captureRejectionSymbol]

addListener()

Call Signature

addListener(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:254

Alias for emitter.on(eventName, listener).

Parameters

Parameter	Type
`event`	`"error"`
`listener`	(`err`) => `void`

Returns

this

Since

v0.1.26

Overrides

EventEmitter.addListener

Call Signature

addListener(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:255

Parameters

Parameter	Type
`event`	`"idle"`
`listener`	() => `void`

Returns

this

Overrides

EventEmitter.addListener

Call Signature

addListener(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:256

Parameters

Parameter	Type
`event`	`"token"`
`listener`	(`token`) => `void`

Returns

this

Overrides

EventEmitter.addListener

close()

close(): void;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:183

Closes all connections in the pool. If there is a message being sent, the connection is closed later

Returns

void

emit()

Call Signature

emit(event, error): boolean;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:258

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Parameters

Parameter	Type
`event`	`"error"`
`error`	`Error`

Returns

boolean

Since

v0.1.26

Overrides

EventEmitter.emit

Call Signature

emit(event): boolean;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:259

Parameters

Parameter	Type
`event`	`"idle"`

Returns

boolean

Overrides

EventEmitter.emit

Call Signature

emit(event, token): boolean;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:260

Parameters

Parameter	Type
`event`	`"token"`
`token`	`Token`

Returns

boolean

Overrides

EventEmitter.emit

eventNames()

eventNames(): (string | symbol)[];

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:967

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

EventEmitter.eventNames

get()

Call Signature

get(key): (user, renew, callback) => void;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:232

Parameters

Parameter	Type
`key`	`"oauth2_provision_cb"`

Returns

(
   user, 
   renew, 
   callback): void;

Parameters

Parameter	Type
`user`	`string`
`renew`	`boolean`
`callback`	(`err`, `accessToken`, `expires`) => `void`

Returns

void

Call Signature

get(key): (proxy, options, callback) => void;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:239

Parameters

Parameter	Type
`key`	\| `"proxy_handler_http"` \| `"proxy_handler_https"` \| `"proxy_handler_socks"` \| `"proxy_handler_socks5"` \| `"proxy_handler_socks4"` \| `"proxy_handler_socks4a"`

Returns

(
   proxy, 
   options, 
   callback): void;

Parameters

Parameter	Type
`proxy`	`Url`
`options`	`TransportOptions`
`callback`	(`err`, `socketOptions`) => `void`

Returns

void

Call Signature

get(key): any;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:252

Parameters

Parameter	Type
`key`	`string`

Returns

any

getMaxListeners()

getMaxListeners(): number;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:819

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

Returns

number

Since

v1.0.0

Inherited from

EventEmitter.getMaxListeners

getVersionString()

getVersionString(): string;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:203

Returns

string

isIdle()

isIdle(): boolean;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:186

Returns true if there are free slots in the queue

Returns

boolean

listenerCount()

listenerCount<K>(eventName, listener?): number;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:913

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type Parameters

Type Parameter
`K`

Parameters

Parameter	Type	Description
`eventName`	`string` \| `symbol`	The name of the event being listened for
`listener?`	`Function`	The event handler function

Returns

number

Since

v3.2.0

Inherited from

EventEmitter.listenerCount

listeners()

Call Signature

listeners(event): (err) => void[];

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:278

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Parameters

Parameter	Type
`event`	`"error"`

Returns

(err) => void[]

Since

v0.1.26

Overrides

EventEmitter.listeners

Call Signature

listeners(event): () => void[];

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:279

Parameters

Parameter	Type
`event`	`"idle"`

Returns

() => void[]

Overrides

EventEmitter.listeners

Call Signature

listeners(event): (token) => void[];

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:280

Parameters

Parameter	Type
`event`	`"end"`

Returns

(token) => void[]

Overrides

EventEmitter.listeners

off()

off<K>(eventName, listener): this;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:792

Alias for emitter.removeListener().

Type Parameters

Type Parameter
`K`

Parameters

Parameter	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`) => `void`

Returns

this

Since

v10.0.0

Inherited from

EventEmitter.off

on()

Call Signature

on(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:262

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Parameters

Parameter	Type	Description
`event`	`"error"`	-
`listener`	(`err`) => `void`	The callback function

Returns

this

Since

v0.1.101

Overrides

EventEmitter.on

Call Signature

on(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:263

Parameters

Parameter	Type
`event`	`"idle"`
`listener`	() => `void`

Returns

this

Overrides

EventEmitter.on

Call Signature

on(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:264

Parameters

Parameter	Type
`event`	`"token"`
`listener`	(`token`) => `void`

Returns

this

Overrides

EventEmitter.on

once()

Call Signature

once(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:266

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Parameters

Parameter	Type	Description
`event`	`"error"`	-
`listener`	(`err`) => `void`	The callback function

Returns

this

Since

v0.3.0

Overrides

EventEmitter.once

Call Signature

once(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:267

Parameters

Parameter	Type
`event`	`"idle"`
`listener`	() => `void`

Returns

this

Overrides

EventEmitter.once

Call Signature

once(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:268

Parameters

Parameter	Type
`event`	`"token"`
`listener`	(`token`) => `void`

Returns

this

Overrides

EventEmitter.once

prependListener()

Call Signature

prependListener(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:270

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

Parameter	Type	Description
`event`	`"error"`	-
`listener`	(`err`) => `void`	The callback function

Returns

this

Since

v6.0.0

Overrides

EventEmitter.prependListener

Call Signature

prependListener(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:271

Parameters

Parameter	Type
`event`	`"idle"`
`listener`	() => `void`

Returns

this

Overrides

EventEmitter.prependListener

Call Signature

prependListener(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:272

Parameters

Parameter	Type
`event`	`"end"`
`listener`	(`token`) => `void`

Returns

this

Overrides

EventEmitter.prependListener

prependOnceListener()

Call Signature

prependOnceListener(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:274

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

Parameter	Type	Description
`event`	`"error"`	-
`listener`	(`err`) => `void`	The callback function

Returns

this

Since

v6.0.0

Overrides

EventEmitter.prependOnceListener

Call Signature

prependOnceListener(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:275

Parameters

Parameter	Type
`event`	`"idle"`
`listener`	() => `void`

Returns

this

Overrides

EventEmitter.prependOnceListener

Call Signature

prependOnceListener(event, listener): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:276

Parameters

Parameter	Type
`event`	`"end"`
`listener`	(`token`) => `void`

Returns

this

Overrides

EventEmitter.prependOnceListener

rawListeners()

rawListeners<K>(eventName): Function[];

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:863

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type Parameters

Type Parameter
`K`

Parameters

Parameter	Type
`eventName`	`string` \| `symbol`

Returns

Function[]

Since

v9.4.0

Inherited from

EventEmitter.rawListeners

removeAllListeners()

removeAllListeners(eventName?): this;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:803

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

Parameter	Type
`eventName?`	`string` \| `symbol`

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.removeAllListeners

removeListener()

removeListener<K>(eventName, listener): this;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:787

Removes the specified listener from the listener array for the event named eventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

Type Parameter
`K`

Parameters

Parameter	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`) => `void`

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.removeListener

sendMail()

Call Signature

sendMail(mailOptions, callback): void;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:195

Sends an email using the preselected transport object

Parameters

Parameter	Type
`mailOptions`	`Options` & `Partial`<`DefaultTransportOptions`>
`callback`	(`err`, `info`) => `void`

Returns

void

Call Signature

sendMail(mailOptions, callback): void;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:199

Sends an email using the preselected transport object

Parameters

Parameter	Type
`mailOptions`	`Options`
`callback`	(`err`, `info`) => `void`

Returns

void

Call Signature

sendMail(mailOptions): Promise<T>;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:200

Sends an email using the preselected transport object

Parameters

Parameter	Type
`mailOptions`	`Options` & `Partial`<`DefaultTransportOptions`>

Returns

Promise<T>

Call Signature

sendMail(mailOptions): Promise<T>;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:201

Sends an email using the preselected transport object

Parameters

Parameter	Type
`mailOptions`	`Options`

Returns

Promise<T>

set()

Call Signature

set(key, value): Map<string, any>;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:208

Parameters

Parameter	Type
`key`	`"oauth2_provision_cb"`
`value`	(`user`, `renew`, `callback`) => `void`

Returns

Map<string, any>

Call Signature

set(key, value): Map<string, any>;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:216

Parameters

Parameter	Type
`key`	\| `"proxy_handler_http"` \| `"proxy_handler_https"` \| `"proxy_handler_socks"` \| `"proxy_handler_socks5"` \| `"proxy_handler_socks4"` \| `"proxy_handler_socks4a"`
`value`	(`proxy`, `options`, `callback`) => `void`

Returns

Map<string, any>

Call Signature

set(key, value): Map<string, any>;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:230

Parameters

Parameter	Type
`key`	`string`
`value`	`any`

Returns

Map<string, any>

setMaxListeners()

setMaxListeners(n): this;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:813

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

Parameter	Type
`n`	`number`

Returns

this

Since

v0.3.5

Inherited from

EventEmitter.setMaxListeners

setupProxy()

setupProxy(proxyUrl): void;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:206

Sets up proxy handler for a Nodemailer object

Parameters

Parameter	Type
`proxyUrl`	`string`

Returns

void

use()

use(step, plugin): this;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:192

Parameters

Parameter	Type
`step`	`string`
`plugin`	`PluginFunction`<`T`>

Returns

this

verify()

Call Signature

verify(callback): void;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:189

Verifies SMTP configuration

Parameters

Parameter	Type
`callback`	(`err`, `success`) => `void`

Returns

void

Call Signature

verify(): Promise<true>;

Defined in: node_modules/.pnpm/@types+nodemailer@6.4.21/node_modules/@types/nodemailer/lib/mailer/index.d.ts:190

Verifies SMTP configuration

Returns

Promise<true>

addAbortListener()

static addAbortListener(signal, resource): Disposable;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:403

Listens once to the abort event on the provided signal.

Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change this since it would violate the web standard. Additionally, the original API makes it easy to forget to remove listeners.

This API allows safely using AbortSignals in Node.js APIs by solving these two issues by listening to the event such that stopImmediatePropagation does not prevent the listener from running.

Returns a disposable so that it may be unsubscribed from more easily.

import { addAbortListener } from 'node:events';

function example(signal) {
  let disposable;
  try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
    });
  } finally {
    disposable?.[Symbol.dispose]();
  }
}

Parameters

Parameter	Type
`signal`	`AbortSignal`
`resource`	(`event`) => `void`

Returns

Disposable

Disposable that removes the abort listener.

Since

v20.5.0

Inherited from

EventEmitter.addAbortListener

getEventListeners()

static getEventListeners(emitter, name): Function[];

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:325

Returns a copy of the array of listeners for the event named eventName.

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

import { getEventListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}

Parameters

Parameter	Type
`emitter`	`EventEmitter`<`DefaultEventMap`> \| `EventTarget`
`name`	`string` \| `symbol`

Returns

Function[]

Since

v15.2.0, v14.17.0

Inherited from

EventEmitter.getEventListeners

getMaxListeners()

static getMaxListeners(emitter): number;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:354

Returns the currently set max amount of listeners.

For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

For EventTargets this is the only way to get the max event listeners for the event target. If the number of event handlers on a single EventTarget exceeds the max set, the EventTarget will print a warning.

import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}

Parameters

Parameter	Type
`emitter`	`EventEmitter`<`DefaultEventMap`> \| `EventTarget`

Returns

number

Since

v19.9.0

Inherited from

EventEmitter.getMaxListeners

listenerCount()

static listenerCount(emitter, eventName): number;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:297

A class method that returns the number of listeners for the given eventName registered on the given emitter.

import { EventEmitter, listenerCount } from 'node:events';

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

Parameters

Parameter	Type	Description
`emitter`	`EventEmitter`	The emitter to query
`eventName`	`string` \| `symbol`	The event name

Returns

number

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Inherited from

EventEmitter.listenerCount

on()

Call Signature

static on(
   emitter, 
   eventName, 
options?): AsyncIterator<any[]>;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:270

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // The execution of this inner block is synchronous and it
  // processes one event at a time (even with await). Do not use
  // if concurrent execution is required.
  console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
  ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
  console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

Parameters

Parameter	Type
`emitter`	`EventEmitter`
`eventName`	`string` \| `symbol`
`options?`	`StaticEventEmitterIteratorOptions`

Returns

AsyncIterator<any[]>

An AsyncIterator that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

EventEmitter.on

Call Signature

static on(
   emitter, 
   eventName, 
options?): AsyncIterator<any[]>;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:275

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // The execution of this inner block is synchronous and it
  // processes one event at a time (even with await). Do not use
  // if concurrent execution is required.
  console.log(event); // prints ['bar'] [42]
}
// Unreachable here

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
  ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
  console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

Parameters

Parameter	Type
`emitter`	`EventTarget`
`eventName`	`string`
`options?`	`StaticEventEmitterIteratorOptions`

Returns

AsyncIterator<any[]>

An AsyncIterator that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

EventEmitter.on

once()

Call Signature

static once(
   emitter, 
   eventName, 
options?): Promise<any[]>;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:184

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
  ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
  ee.emit('error', err);
});

try {
  await once(ee, 'myevent');
} catch (err) {
  console.error('error happened', err);
}

The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Parameters

Parameter	Type
`emitter`	`EventEmitter`
`eventName`	`string` \| `symbol`
`options?`	`StaticEventEmitterOptions`

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Inherited from

EventEmitter.once

Call Signature

static once(
   emitter, 
   eventName, 
options?): Promise<any[]>;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:189

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
  ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
  ee.emit('error', err);
});

try {
  await once(ee, 'myevent');
} catch (err) {
  console.error('error happened', err);
}

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Parameters

Parameter	Type
`emitter`	`EventTarget`
`eventName`	`string`
`options?`	`StaticEventEmitterOptions`

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Inherited from

EventEmitter.once

setMaxListeners()

static setMaxListeners(n?, ...eventTargets?): void;

Defined in: node_modules/.pnpm/@types+node@22.19.3/node_modules/@types/node/events.d.ts:369

import { setMaxListeners, EventEmitter } from 'node:events';

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Parameters

Parameter	Type	Description
`n?`	`number`	A non-negative number. The maximum number of listeners per `EventTarget` event.
...`eventTargets?`	(`EventEmitter`<`DefaultEventMap`> \| `EventTarget`)[]	Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, `n` is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

Returns

void

Since

v15.4.0

Inherited from

EventEmitter.setMaxListeners

MailerModule

Defined in: packages/mailer/src/mailer.module.ts:18

Extends

ConfigurableModuleClass

Indexable

[key: string]: any

Constructors

Constructor

new MailerModule(): MailerModule;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Returns

MailerModule

Inherited from

ConfigurableModuleClass.constructor

Properties

register()

static register: (options) => DynamicModule;

Parameters

Parameter	Type
`options`	`MailerModuleOptions` & `Partial`<{ `isGlobal`: `boolean`; }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.register

registerAsync()

static registerAsync: (options) => DynamicModule;

Parameters

Parameter	Type
`options`	`ConfigurableModuleAsyncOptions`<`MailerModuleOptions`, `"create"`> & `Partial`<{ `isGlobal`: `boolean`; }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.registerAsync

Type Aliases

MailerModuleOptions

type MailerModuleOptions = 
  | JSONTransport.Options
  | SESTransport.Options
  | SMTPTransport.Options
  | SendmailTransport.Options
  | StreamTransport.Options;

Defined in: packages/mailer/src/mailer-module-options.interface.ts:7

Namespaces​

Classes​

Mailer​

Extends​

Type Parameters​

Constructors​

Constructor​

Parameters​

Returns​

Overrides​

Properties​

_defaults​

dkim​

logger​

MailMessage​

meta​

options​

transporter​

captureRejections​

Since​

Inherited from​

captureRejectionSymbol​

Since​

Inherited from​

defaultMaxListeners​

Since​

Inherited from​

errorMonitor​

Since​

Inherited from​

Methods​

[captureRejectionSymbol]()?​

Type Parameters​

Parameters​

Returns​

Inherited from​

addListener()​

Call Signature​

Parameters​

Returns​

Since​

Overrides​

Call Signature​

Parameters​

Returns​

Overrides​

Call Signature​

Parameters​

Returns​

Overrides​

close()​

Returns​

emit()​

Call Signature​

Parameters​

Returns​

Since​

Overrides​

Call Signature​

Parameters​

Returns​

Overrides​

Call Signature​

Parameters​

Returns​

Overrides​

eventNames()​

Returns​

Since​

Inherited from​

get()​

Call Signature​

Parameters​

Returns​

Parameters​

Returns​

Call Signature​

Parameters​

Returns​

Parameters​

Namespaces

Classes

Mailer

Extends

Type Parameters

Constructors

Constructor

Parameters

Returns

Overrides

Properties

_defaults

dkim

logger

MailMessage

meta

options

transporter

captureRejections

Since

Inherited from

captureRejectionSymbol

Since

Inherited from

defaultMaxListeners

Since

Inherited from

errorMonitor

Since

Inherited from

Methods

[captureRejectionSymbol]()?

Type Parameters

Parameters

Returns

Inherited from

addListener()

Call Signature

Parameters

Returns

Since

Overrides

Call Signature

Parameters

Returns

Overrides

Call Signature

Parameters

Returns

Overrides

close()

Returns

emit()

Call Signature

Parameters

Returns

Since

Overrides

Call Signature

Parameters

Returns

Overrides

Call Signature

Parameters

Returns

Overrides

eventNames()

Returns

Since

Inherited from

get()

Call Signature

Parameters

Returns

Parameters

Returns

Call Signature

Parameters

Returns

Parameters