Skip to main content

Bloomreach Transactional Email API Client

By

A nonofficial, JavaScript, feature complete, client library for sending transactional emails via Bloomreach.

The aim of the bloomreach-transactional-email package is to get you going with the Bloomreach Transactional Email API as quickly as possible. The sendEmail function takes the minimum number of required parameters to send an email. Other parameters are optional. Full details of all the options can be found in the Bloomreach Transactional Email API documentation.

bloomreach-transactional-email  uses axios, as a peer dependency, to make HTTP calls.

Install

npm i -save bloomreach-transactional-email

Basic Examples

If you have Customer IDs and a default email integration with a sender name and address setup in Bloomreach then you can use the minimum configuration to send an email by specifying a HTML body and a subject:

import { sendEmail } from 'bloomreach-transactional-email';

const auth = {
    username: '...',    // Your APIKeyID
    password: '...',    // Your APISecret
    baseUrl: 'https://api.exponea.com', // Your base url
    projectToken: '...', // Your project token
};

const campaignName = 'MyCampaign';

const customerIds = {
    registered: 'marian@exponea.com'
};

const htmlContent = {
    html: '<!DOCTYPEhtml><body>Hello world</body></html>',
    subject: 'SubjectExample',
}

await sendEmail(auth, campaignName, customerIds, htmlContent);

If you have a template set up you can also send an email using it:

const templateContent = {
    templateId: '60758e2d18883e1048b817a8',
    params: { first_name: 'Marian' }
}

await sendEmail(auth, campaignName, customerIds, templateContent);

If you don’t have Customer IDs setup in Bloomreach you can specify the email address to send the email to (you still need to specify Customer IDs). If you have language variants of your template, you can specify the language. You can also specify the sender name and sender address:

await sendEmail(
    auth,
    campaignName,
    customerIds,
    htmlContent,
    {       
            email: 'jon.doe@example.com',
            language: 'en',
            senderAddress: 'Marian',
            senderName: 'marian@exponea.com'
    }
);

Integrations

You can specify either a single integration:

await sendEmail(
    auth,
    campaignName,
    customerIds,
    htmlContent,
    {       
            integrationId: "5b337eceeb7cdb000d4e20f3"
    }
);

or up to two integrations, a primary and a backup in case the primary fails, with individual sender addresses:

await sendEmail(
    auth,
    campaignName,
    customerIds,
    htmlContent,
    {       
        integrations: [
            {
                id: "5b337eceeb7cdb000d4e20f3",
                senderAddress: "marian@exponea.com",
            },
            {
                id: "3f02e4d000bdc7beece733b5",
                senderAddress: "marian@exponea.com",
            }
            ]
    }
);

Transfer Identity

You can specify a transfer identity of:

  • enabled
  • disabled
  • first_click

await sendEmail(
    auth,
    campaignName,
    customerIds,
    htmlContent,
    {       
            transferIdentity: 'disabled'
    });

Attachments

You can add an array of attachments with base64 encoded content:

await sendEmail(
    auth,
    campaignName,
    customerIds,
    htmlContent,
    {}, // Options object can also be undefined
    [
        {
            filename: 'example1.txt',
            content: 'RXhhbXBsZSBhdHRhY2htZW50',
            contentType: 'text/plain',
        },
        {
            filename: 'example2.txt',
            content: 'RXhhbXBsZSBhdHRhY2htZW50',
            contentType: 'text/plain',
        },
    ]);

Settings

You can also add:

  • Custom Event Properties
  • Custom Headers
  • Url Params
  • Transfer User Identity
  • Consent Category
  • Consent Category Tracking


Check the Bloomreach Transactional Email API documentation for details:

await sendEmail(
    auth,
    campaignName,
    customerIds,
    htmlContent,
    {}, // Options object can also be undefined
    [], // Attachments array can also be undefined
    {
        customEventProperties: {
            bannana: 'yellow',
            1: 2,
        },
            customHeaders: {
            source: 'your-company',
            1: 2,
        },
        urlParams: {
            source: 'email',
            1: 2,
        },
        transferUserIdentity: 'first_click',
        consentCategory: 'sms',
        consentCategoryTracking: 'sms',
    });

Comments

Post a Comment

Popular posts from this blog

Write Your Own Load Balancer: A worked Example

By
I was out walking with a techie friend of mine I’d not seen for a while and he asked me if I’d written anything recently. I hadn’t, other than an article on data sharing a few months before and I realised I was missing it. Well, not the writing itself, but the end result. In the last few weeks, another friend of mine, John Cricket , has been setting weekly code challenges via linkedin and his new website, https://codingchallenges.fyi/ . They were all quite interesting, but one in particular on writing load balancers appealed, so I thought I’d kill two birds with one stone and write up a worked example. You’ll find my worked example below. The challenge itself is italics and voice is that of John Crickets. The Coding Challenge https://codingchallenges.fyi/challenges/challenge-load-balancer/ Write Your Own Load Balancer This challenge is to build your own application layer load balancer. A load balancer sits in front of a group of servers and routes client requests across all of the serv...
Post a Comment
Read more

Catalina-Ant for Tomcat 7

By
I recently upgraded from Tomcat 6 to Tomcat 7 and all of my Ant deployment scripts stopped working. I eventually worked out why and made the necessary changes, but there doesn’t seem to be a complete description of how to use Catalina-Ant for Tomcat 7 on the web so I thought I'd write one. To start with, make sure Tomcat manager is configured for use by Catalina-Ant. Make sure that manager-script is included in the roles for one of the users in TOMCAT_HOME/conf/tomcat-users.xml . For example: <tomcat-users> <user name="admin" password="s3cr£t" roles="manager-gui, manager-script "/> </tomcat-users> Catalina-Ant for Tomcat 6 was encapsulated within a single JAR file. Catalina-Ant for Tomcat 7 requires four JAR files. One from TOMCAT_HOME/bin : tomcat-juli.jar and three from TOMCAT_HOME/lib: catalina-ant.jar tomcat-coyote.jar tomcat-util.jar There are at least three ways of making the JARs available to Ant: Copy the JARs into th...
22 comments
Read more

RESTful Behaviour Guide

By
I’ve used a lot of existing Representational State Transfer (REST) APIs and have created several of my own. I see a lot of inconsistency, not just between REST APIs but often within a single REST API. I think most developers understand, at a high level, what a REST API is for and how it should work, but lack a detailed understanding. I think the first thing they forget to consider is that REST APIs allow you to identify and manipulate resources on the web. Here I want to look briefly at what a REST API is and offer some advice on how to structure one, how it should behave and what should be considered when building it. I know this isn’t emacs vs vi, but it can be quite contentious. So, as  Barbossa from Pirates of the Caribbean said, this “...is more what you’d call ‘guidelines’ than actual rules.” Resources & Identifiers In their book, Rest in Practice - Hypermedia and Systems Architecture (‎ISBN: 978-0596805821), Jim Webber, Savas Parastatidis and Ian Robinson describe resour...
1 comment
Read more