emailonacid-snapshot
Advanced tools
Mail Visual Regression library based on Email on Acid API service.
emailonacid-snapshot package as devDependency:# yarn
yarn add --dev emailonacid-snapshot
# npm
npm install --save-dev emailonacid-snapshot
Define process.env.EOA_API_KEY and process.env.EOA_ACCOUNT_PASSWORD
API credentials.
Use createEmail with your favorite test runner:
const { createEmail } = require('emailonacid-snapshot');
async function run() {
const email = await createEmail('<html><!-- static markup --></html>');
const screenshot = await email.screenshot('outlook07');
// assert screenshot at this point
await email.clean();
}
run();
Check options docs and examples for futher setup.
You can provide config with either one of package.json#emailonacid,
emailonacid.config.js, and .emailonacidrc.json.
Note: clients and plugins options are not merged but overridden.
clients <?Array<string>> List of default clients to create tests
with.credentials <Object>
apiKey <string> EoA API key. Defaults to process.env.EOA_API_KEY.accountPassword EoA API password. Defaults to
process.env.EOA_ACCOUNT_PASSWORD.debug <?boolean> Enables verbose debug logging. Defaults to
process.env.DEBUG or process.env.EOA_DEBUG.plugins <?Array<Function>> List of plugins to apply for each test.
Default plugins are ThreadBustingPlugin, ContentRendererPlugin,
LocalCopyPlugin, ContentCroppingPlugin. If you're willing to implement custom
plugin, check one of those plugins for reference.poll <?Object> Polling options
See TypeScript typings for more API details.
createEmailimport { createEmail } from 'emailonacid-snapshot';
Creates new email with default and global options. Returns email instance object.
configureCreateEmailimport { configureCreateEmail } from 'emailonacid-snapshot';
Creates new email factory with default, global and provided options. Helpful for
creating multiple createEmail functions to defined different set of targets or
different renderers.
withDefaultPluginsimport { withDefaultPlugins } from 'emailonacid-snapshot/config';
Merges user-provided config with list of default plugins.
withOverridableClientsimport { withOverridableClients } from 'emailonacid-snapshot/config';
Merges user-provided config with a dynamic list of clients which can be
overridden via EOA_CLIENTS environment variable.
MIT Š ResearchGate
FAQs
Mails visual regression tooling via Email on Acid service
We found that emailonacid-snapshot 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.
Security News
/Research
Socket found a Rust typosquat (finch-rust) that loads sha-rust to steal credentials, using impersonation and an unpinned dependency to auto-deliver updates.
Research
/Security Fundamentals
A pair of typosquatted Go packages posing as Googleâs UUID library quietly turn helper functions into encrypted exfiltration channels to a paste site, putting developer and CI data at risk.
Security News
November CVE publications fell 25% YoY even as 2025 totals rose, showing how a few major CNAs can swing âglobalâ counts and skew perceived risk.