https://github.com/mailpace/mailpace.js

The official Node.js library for the https://mailpace.com transactional email API
https://github.com/mailpace/mailpace.js

email email-api nodejs npm npm-package transactional transactional-emails

Last synced: 2 days ago
JSON representation

The official Node.js library for the https://mailpace.com transactional email API

• Host: GitHub
• URL: https://github.com/mailpace/mailpace.js
• Owner: mailpace
• License: mit
• Created: 2020-12-30T15:21:15.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-12T15:26:27.000Z (4 months ago)
• Last Synced: 2025-01-16T23:35:56.363Z (13 days ago)
• Topics: email, email-api, nodejs, npm, npm-package, transactional, transactional-emails
• Language: TypeScript
• Homepage: https://mailpace.com
• Size: 399 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MailPace Node.js Library

[![](https://circleci.com/gh/mailpace/mailpace.js.svg?style=svg)](https://app.circleci.com/pipelines/github/mailpace/mailpace.js)

[![codecov](https://codecov.io/gh/mailpace/mailpace.js/branch/master/graph/badge.svg?token=QDLVU2JGyD)](https://codecov.io/gh/mailpace/mailpace.js)

[![npm version](https://badge.fury.io/js/%40mailpace%2Fmailpace.js.svg)](https://badge.fury.io/js/%40mailpace%2Fmailpace.js)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

This is the official Node.js library for the https://mailpace.com transactional email API

## Quick Start

### Pre-requisites

First you will need to retrieve your API token for your sending domain from [MailPace](https://app.mailpace.com). You can find it under Organization -> Domain -> API Tokens

Your domain must have completed DKIM authorization and have an active plan to send emails.

### Installation

If using NPM

`npm install --save @mailpace/mailpace.js`

If using Yarn

`yarn add @mailpace/mailpace.js`

### Sending an email

```javascript

const MailPace = require('@mailpace/mailpace.js');

const client = new MailPace.DomainClient('API_TOKEN_HERE');

client

  .sendEmail({

    from: '[email protected]',

    to: '[email protected]',

    subject: 'test',

    htmlbody: '
HTML Email
',

  })

  .then((r) => {

    console.log(r);

  });

```


## Documentation

See [the ./docs folder](https://github.com/mailpace/mailpace.js/tree/master/docs) for documentation and options

To regenerate the documentation, run `yarn docs:md`

## Issues, Support & Contributions

If you have any difficulties please contact [email protected] or open an issue on github.

Contributions are always welcome

## License

MIT