✉️ Bloggify plugin for sending emails via @sendgrid.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
lib
.gitignore
CONTRIBUTING.md
DOCUMENTATION.md
LICENSE
README.md
package.json

README.md

bloggify-sendgrid

Version Downloads

Bloggify plugin for sending emails via SendGrid.

☁️ Installation

# Using npm
npm install --save bloggify-sendgrid

# Using yarn
yarn add bloggify-sendgrid

📋 Example

const Email = Bloggify.require("bloggify-sendgrid", true);

Email.send({
    to_email: "someone@domain.com"
  , from_email: "me@domain.com"
  , subject: "Hello world!"
  , template_id: "your template id"
  , substitutions: {
      "-name-": "Alice"
    }
}, (err, data) => {
    console.log(err || data);
});

Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛

📝 Documentation

Plugin Configuration

  • Object config:
    • key (String): The Sendgrid API key.

send(data)

Send an email.

Params

  • Object data: An object containing the message object sent to Sendgrid, as documented here. In the Bloggify config you will have to provide the following data:

  • key (String): The SendGrid key.

Return

  • Promise A promise resolving the result from Sendgrid.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

📜 License

MIT © Bloggify