@mytelnet/email-transaction-processor v2.0.2

Email transaction processor (Campaign Monitor)

Promise based module to send emails using campaign monitor transaction API. see https://help.campaignmonitor.com/transactional-emails for more information.

Usage Instructions

1. Build a transactional email from a template in Campaign Monitor.
2. Use the smartEmailID related to the email you created and API key assigned to your account
3. Send email using this module :)

You need to include an API key from your Campaign Monitor account

CODE EXAMPLE

import { smartMail, classicMail } from '@mytelnet/email-transaction-processor'

const emailData = {
  first_name: 'shaun',
  voice_spend_this_week: '108',
  voice_spend_last_week: '588',
  voice_balance: '1095',
}

let testcsv = 'price, item \n100, hug';
let attachment = [{
    Content: Buffer.from(testcsv).toString('base64'),
    Name: 'info.csv',
    Type: 'text/csv'
}]

/**
 * Sends a transactional email using Campaign Monitor API
 * @param cmApiKey camunda API key
 * @param emailAddress recpient email address
 * @param smartEmailID smartemail ID from Campaign Monitor
 * @param data object used to populate email
 * @param consentToTrack Recipient consents to tracking links
 * @param addRecipientsToList Add recipients to a list
 * @param attachments base64 encoded files
 * @returns {Object} returns an object
 * @returns {string} result - success or error
 * @returns {Object} data - object containing information relating to success or faliure
 */
smartMail('mycampaignmonitorAPIkey','emailaddress@domain', 'smartEmailID', emailData, false, false, attachment)
  .then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log(err);
  });

       
/**
 * Sends a classic email using Campaign Monitor API
 * @param emailData Object containing data passed to email
 * @param emailData.cmApiKey camunda API key
 * @param emailData.to recpient email address
 * @param emailData.from from email address
 * @param emailData.replyTo reply to email addRecipientsToList
 * @param emailData.subject Email subject
 * @param emailData.html Html email content
 * @param emailData.text text based email content
 * @param emailData.attachments array of attachements in base64
 * @param emailData.consentToTrack Recipient consents to tracking links
 * @param emailData.addRecipientsToList Add recipients to a list
 * @param emailData.trackOpen Track open emails
 * @param emailData.trackClick Track open emails
 * @param emailData.inlineCss 
 * @param emailData.group 
 * @returns {Object} returns an object
 * @returns {Object.result} - success or error
 * @returns {Object.data}  - object containing information relating to success or faliure
 */
classicMail({
            cmApiKey: 'campaign monitor api key',
            to: ['recipient@gmail.com'],
            from: 'sender@gmail.com',
            subject: 'this is a test',
            html: 'html email body',
            text: 'text email body'
        }).then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log(err);
  });

RESPONSE EXAMPLES

success

{ result: 'success',
  data:
   { Status: 'Accepted',
     MessageID: '41ab5fa5-5a73-11e9-99ed-fe925c749502',
     Recipient: 'shaun.botsis@mytelnet.co.za' } }

failure

{ result: 'error',
  data: { Code: 926, Message: 'Smart email not found.' } }

Build Instructions

To build the application there are a few NPM scripts which use gulp to compile an obfuscate the module to its lib folder.

Compile for development

npm run dev

Compile for Production

npm run prod

Need any help just let me know : shaun.botsis@mytelnet.co.za