npmpackage.info

Gathering detailed insights and metrics for sendwithus

Other packages similar to sendwithus

grunt-sendwithus

0.2.0

Grunt plugin to deploy your local HTML email templates to sendwithus

feathers-sendwithus

0.1.0

Feathers service for sending mailers with sendwithus.com.

feathers-sendwithus-batch

0.0.6

Feathers service for sending mailers with sendwithus.com.

sendwithus.node

0.0.1

Sendwithus API client for node.js

Gathering detailed insights and metrics for sendwithus

sendwithus - 6.0.3 | npmpackage.info

sendwithus

Sendwithus NodeJS Client

6.0.3

Apache-2.0

JavaScript

110.72 kB

3.9

Installations

npm install sendwithus

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10.0.0

Node Version

18.17.1

NPM Version

9.6.7 Pull Requests

Open

0

Total

53

Closed

10

Merged

43

Issues

Open

2

Total

14

Closed

12

Releases

v6.0.3

Updated on Jan 13, 2025

v6.0.2

Updated on Dec 12, 2022

Release v6.0.1

v6.0.1

Updated on Mar 16, 2022

Release v6.0.0

v6.0.0

Updated on Feb 16, 2022

v5.1.0

Updated on Nov 17, 2021

v4.3.2

Updated on Apr 28, 2021

View All 11 releases

Languages

JavaScript

JavaScript (100%)

Developer

sendwithus

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

22 Stars

169 Commits

17 Forks

22 Watchers

3 Branches

34 Contributors

Updated on Jan 13, 2025

Maintainers

View All 34 Contributors

Package Meta Information

Latest Version

6.0.3

Package Id

sendwithus@6.0.3

Unpacked Size

110.72 kB

Size

26.37 kB

File Count

NPM Version

9.6.7

Node Version

18.17.1

Published on

Jan 13, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

node-fetch

Dev Dependencies

mocha

sendwithus node-client

Installation

npm install sendwithus

Usage

All callbacks accept err and response:

1const callback = function(err, response) {
2    if (err) {
3        console.log({message: err.message,  status: response.status, statusText: response.statusText});
4    } else {
5        console.log(response);
6    }
7};

Templates

List Your Templates

1var api = require('sendwithus')('API_KEY');
2api.templates(callback);

Create Template

1var api = require('sendwithus')('API_KEY');
2var data = { name: 'name', subject: 'subject', html: '<html><head></head><body></body></html>', text: 'some text' };
3api.createTemplate(data, callback);

Create Template Version

1var api = require('sendwithus')('API_KEY');
2var data = { name: 'name', subject: 'subject', html: '<html><head></head><body></body></html>', text: 'some text' };
3api.createTemplateVersion(TEMPLATE_ID, data, callback);

Send

Send an Email

NOTE - If a customer does not exist by the specified email (recipient address), the send call will create a customer.

template — Template ID to send
recipient
- address — The recipient's email address
- name (optional) — The recipient's name
template_data (optional) — Object containing email template data
sender (optional)
- address — The sender's email address
- reply_to (optional) — The sender's reply-to address
- name (optional) — The sender's name
cc (optional) — An array of CC recipients, of the format {"address":"cc@email.com"}
bcc (optional) — An array of BCC recipients, of the format {"address":"bcc@email.com"}
headers (optional) — Object contain SMTP headers to be included with the email
esp_account (optional) — ID of the ESP Account to send this email through. ex: esp_1a2b3c4d5e
locale (optional) — Template locale to send (ie: en-US)
version_name (optional) — Template version to send (ie: Version A)

Call with REQUIRED parameters only

The template_data field is optional, but highly recommended!

1var api = require('sendwithus')('API_KEY');
2api.send({
3    template: 'TEMPLATE_ID',
4    recipient: { address: 'us@sendwithus.com' }
5}, callback);

Call with REQUIRED parameters and template_data

1var api = require('sendwithus')('API_KEY');
2api.send({
3    template: 'TEMPLATE_ID',
4    recipient: {
5        address: 'us@sendwithus.com', // required
6        name: 'Matt and Brad'
7    },
8    template_data: { first_name: 'Matt' }
9}, callback);

Optional Sender

sender['address'] is a required sender field

1var api = require('sendwithus')('API_KEY');
2api.send({
3    template: 'TEMPLATE_ID',
4    recipient: { address: 'us@sendwithus.com' },
5    template_data: { first_name: 'Matt' },
6    sender: {
7        address: 'company@company.com', // required
8        name: 'Company'
9    }
10}, callback);

Optional Sender with reply_to address

sender['name'] and sender['reply_to'] are both optional

1var api = require('sendwithus')('API_KEY');
2api.send({
3    template: 'TEMPLATE_ID',
4    recipient: { address: 'us@sendwithus.com' },
5    template_data: { first_name: 'Matt' },
6    sender: {
7        address: 'company@company.com', // required
8        name: 'Company',
9        reply_to: 'info@company.com'
10    }
11}, callback);

Optional BCC/CC

1var api = require('sendwithus')('API_KEY');
2api.send({
3    template: TEMPLATE_ID,
4    recipient: { address: 'us@sendwithus.com' },
5    bcc: [{ address: 'bcc@sendwithus.com' }],
6    cc: [
7        { address: 'cc1@sendwithus.com' },
8        { address: 'cc2@sendwithus.com' }
9    ]
10}, callback);

Optional Headers

1var api = require('sendwithus')('API_KEY');
2api.send({
3    template: TEMPLATE_ID,
4    recipient: { address: 'us@sendwithus.com' },
5    headers:{ 'X-HEADER-ONE': 'header-value' }
6}, callback);

Optional ESP Account

1var api = require('sendwithus')('API_KEY');
2api.send({
3    template: TEMPLATE_ID,
4    recipient: { address: 'us@sendwithus.com' },
5    esp_account:'esp_1234asdf1234'
6}, callback);

Optional Locale

1var api = require('sendwithus')('API_KEY');
2api.send({
3    template: TEMPLATE_ID,
4    recipient: { address: 'us@sendwithus.com' },
5    locale:'en-US'
6}, callback);

Optional Version

1var api = require('sendwithus')('API_KEY');
2api.send({
3    template: TEMPLATE_ID,
4    recipient: { address: 'us@sendwithus.com' },
5    version_name:'Version A'
6}, callback);

Customers

Update or Create a Customer

1var api = require('sendwithus')('API_KEY');
2api.customersUpdateOrCreate({
3    email: 'foo@bar.com',
4    locale: 'fr-CA'
5}, callback);

Delete a Customer

1var api = require('sendwithus')('API_KEY');
2api.customersDelete('foo@bar.com', callback);

Drip Campaigns

List Drip Campaigns

1var api = require('sendwithus')('API_KEY');
2api.dripCampaignList(callback);

Show Drip Campaign Details

1var api = require('sendwithus')('API_KEY');
2api.dripCampaignDetails('DRIP_CAMPAIGN_ID', callback);

Start Customer on a Drip Campaign

1var api = require('sendwithus')('API_KEY');
2var data = {
3  recipient: {
4    address: 'RECIPIENT_ADDRESS',
5    name: 'RECIPIENT_NAME'
6  },
7  email_data: {
8    country: 'Latveria'
9  }
10}
11api.dripCampaignActivate('DRIP_CAMPAIGN_ID', data, callback);

Remove Customer from a Single Drip Campaign

1var api = require('sendwithus')('API_KEY');
2var data = { recipient_address: 'RECIPIENT_ADDRESS' };
3api.dripCampaignDeactivate('DRIP_CAMPAIGN_ID', data, callback);

Remove Customer from All Drip Campaigns

1var api = require('sendwithus')('API_KEY');
2var data = { recipient_address: 'RECIPIENT_ADDRESS' };
3api.dripCampaignDeactivateAll(data, callback);

Expected Response

Success

1  > response.status;
2  OK
3
4  > response.success;
5  True
6
7  > response.receipt_id;
8  'numeric-receipt-id'
9

Error cases

malformed request

1    > err.statusCode;
2    400

bad API key

1    > err.statusCode;
2    403

Render

Render an Email

1var api = require('sendwithus')('API_KEY');
2api.render({ template: 'SAMPLE_TEMPLATE_ID', template_data: { name: 'Bob' }, strict: true }, callback);

Optional Locale

1var api = require('sendwithus')('API_KEY');
2api.render({ 
3    template: 'SAMPLE_TEMPLATE_ID', 
4    template_data: { name: 'Bob' },
5    locale: 'en-US',
6    strict: true 
7}, callback);

Optional Template Version

1var api = require('sendwithus')('API_KEY');
2api.render({ 
3    template: 'SAMPLE_TEMPLATE_ID', 
4    template_data: { name: 'Bob' },
5    version_id: 'SAMPLE_VERSION_ID',
6    strict: true 
7}, callback);

Sample Response

1{
2    "success": true,
3    "status": "OK",
4    "template": {
5        "id": "ver_r4nd0ml3tt3rsv15h4l0l",
6        "name": "Template name",
7        "version_name": "Template version name",
8        "locale": "en-US"
9    },
10    "subject": "RENDERED SUBJECT WITH DATA",
11    "html": "RENDERED HTML BODY WITH DATA",
12    "text": "RENDERED TEXT BODY WITH DATA"
13}

Logs

Resend

1var api = require('sendwithus')('API_KEY');
2api.resend({"log_id": "log_asdf123456qwerty"}, callback);

Batch

Send

1var api = require('sendwithus')('API_KEY');
2api.batch([{
3    "path": "/api/v1/send",
4    "method": "POST",
5    "body": {
6        "template": "TEMPLATE_ID",
7        "recipient": {
8            "address": "test+1@mydomain.com"
9        }
10    }
11}, {
12    "path": "/api/v1/send",
13    "method": "POST",
14    "body": {
15        "template": "TEMPLATE_ID",
16        "recipient": {
17            "address": "test+2@mydomain.com"
18        }
19    }
20}], callback);

Events

request: function(method, url, headers, body) - emitted when a request has been sent to Sendwithus
response: function(statusCode, body, response) - emitted when a response has been received back from Sendwithus

Run Tests

Install requirements

npm install

Run Unit Tests

npm test

Troubleshooting

General Troubleshooting

Enable debug mode
Make sure you're using the latest Node client
Capture the response data and check your logs — often this will have the exact error

Enable Debug Mode

Debug mode prints out the underlying request information as well as the data payload that gets sent to Sendwithus. You will most likely find this information in your logs. To enable it, simply put debug=true as a parameter when instantiating the API object. Use the debug mode to compare the data payload getting sent to Sendwithus' API docs.

1var api = require('sendwithus')('API_KEY', debug=true);

Response Ranges

Sendwithus' API typically sends responses back in these ranges:

2xx – Successful Request
4xx – Failed Request (Client error)
5xx – Failed Request (Server error)

If you're receiving an error in the 400 response range follow these steps:

Double check the data and ID's getting passed to Sendwithus
Ensure your API key is correct
Log and check the body of the response

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

6

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

3.9

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More