Skip to content

FlowAppPlatform/flow-mailjet-component

Repository files navigation

Flow Mailjet component

The component sends email using Mailjet and is designed to work with Flow SDK

To get started, install the package in your NodeJS project

npm i flow-mailjet-component --save

Use the component as below

// require the component
const Component = require('flow-mailjet-component');

// create instance of the component
const component = new Component();

Provide mailjet credentials, public and private api keys

component.getProperty('API_KEY_PUBLIC').data = 'Your_Public_Mailjet_Key';
component.getProperty('API_KEY_PRIVATE').data = 'Your_Private_Mailjet_Key';

Provide email fields

// provide from and to address of the email
component.getProperty('From').data = 'fro@domain';
component.getProperty('To').data = 'to@domain';

// provide the subject and body for the email
component.getProperty('Subject').data = 'Checking your availability';
component.getProperty('Body').data = 'Hello, Merrari.';

Listen in for port emit events

component.getPort('Sent').onEmit(function(){
  // email was sent
  // the server response can be accessed through the 'Data' property of the port
  let response = component.getPort('Sent').getProperty('Data').data;
});

component.getPort('Bounced').onEmit(function(){
  // email bounced
  // the actual error can be accessed through the 'Data' property of the port
  let err = component.getPort('Bounced').getProperty('Data').data;
});

component.getPort('Error').onEmit(function(){
  // a seperate error occured
  // the actual error can be accessed through the 'Data' property of the port
  let err = component.getPort('Error').getProperty('Data').data;
});

Execute the component

// add the component to a graph before executing it
const Graph = require('flow-platform-sdk').Graph;
new Graph("graph-1").addComponent(component);

component.execute();

Conclusion

If you are having trouble sending emails, check that you are using the correct Mailjet API keys and the right sender address.

About

Send Email Component of Mailjet designed to work with Flow SDK

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •