
Product
Introducing Scala and Kotlin Support in Socket
Socket now supports Scala and Kotlin, bringing AI-powered threat detection to JVM projects with easy manifest generation and fast, accurate scans.
This jest
extension module provides an ad-hoc SMTP server, as well as custom jest matchers, in order to test email sendings. This is meant to use in end-to-end webserver tests.
It leverages Nodemailer's smtp-server
and mailparser
modules.
npm i -D jest-smtp
In the jest
section of your package.json
file:
"jest": {
...,
"setupFilesAfterEnv": [
"jest-smtp",
"<rootDir>/tests/jest-setup.ts"
...
],
}
You can add jest-smtp
globally to your jest-setup
file.
import { createJestSMTPServer } from 'jest-smtp';
beforeAll(() => {
global.smtpServer = createJestSMTPServer();
});
afterAll(() => {
global.smtpServer.close();
});
beforeEach(() => {
global.smtpServer.resetMails();
});
If you use typescript you should add this declaration in your jest.d.ts
file:
declare namespace NodeJS {
export interface Global {
smtpServer: import('jest-smtp').JestSMTPServer;
}
}
import { createJestSMTPServer } from 'jest-smtp';
describe('test my server', () => {
const smtpServer = createJestSMTPServer();
afterAll(() => {
smtpServer.close();
});
beforeEach(() => {
smtpServer.resetMails();
});
})
jest-smtp
provides custom matchers
This tests the number of mails received by the server.
expect(smtpServer).toHaveReceivedEmails(1);
This tests if an email matching the provided fields was sent. This is useful so you don't have to provide an exact match but only test the relevant fields.
The fields are structured by mailparser
, you can find the reference here: https://nodemailer.com/extras/mailparser/#mail-object
Be especially aware that the to
, from
, cc
etc... fields are structured as objects, not strings.
expect(smtpServer).toHaveReceivedEmailMatching({
subject: 'My e-mail subject',
from: {
name: 'Don\'t reply',
address: 'noreply@myapp.com'
}
});
jest-smtp
only exports one function :
const { emails, server, close, resetMails } = createJestSMTPServer({
port: 465,
host: undefined,
options: ()
})
port
: the port the server will be listening on. Default is 465.
host
: the host the server will be listening on (pretty unuseful is you ask me)
options
: these options will be passed to the smtp-server
instance constructor. See here for reference: https://nodemailer.com/extras/smtp-server/#usage
The default options provided are :
{
authMethods: ["PLAIN", "LOGIN"],
authOptional: true,
onData: ... // if you override this function it will break the main features of the plugin
};
resetEmails
convenience method to reset the list of received emails between the tests.
close
shortcut to server.close
method. This must be called after all tests or jest will timeout.
emails
The list of ParsedMail
objects received. You can access it to do extra tests on the content of the emails.
server
The smtp-server
instance.
FAQs
Jest utilities for testing email sends
The npm package jest-smtp receives a total of 3 weekly downloads. As such, jest-smtp popularity was classified as not popular.
We found that jest-smtp demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports Scala and Kotlin, bringing AI-powered threat detection to JVM projects with easy manifest generation and fast, accurate scans.
Application Security
/Security News
Socket CEO Feross Aboukhadijeh and a16z partner Joel de la Garza discuss vibe coding, AI-driven software development, and how the rise of LLMs, despite their risks, still points toward a more secure and innovative future.
Research
/Security News
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.