Product

Solutions

Resources

Company

Connexion

Commencez gratuitement

Product

Solutions

Resources

Company

Connexion

Commencez gratuitement

Un guide pour utiliser SparkPost avec Node.js

Oiseau

1 sept. 2017

1 min read

Un guide pour utiliser SparkPost avec Node.js

Oiseau

1 sept. 2017

1 min read

Un guide pour utiliser SparkPost avec Node.js

En tant qu'Advocate Développeur pour SparkPost, j'écris beaucoup d'applications de démonstration. Mon expérience est principalement en développement front-end, donc ma langue la plus forte est le JavaScript. Grâce à Node.js, je suis également un développeur back-end compétent. Cela signifie-t-il que je suis maintenant un développeur full stack ?

Introduction à Node.js

Installation & Setup

Envoi d'Email

Bonus : Envoyer un Email avec Nodemailer

Double Bonus : Envoyer un email avec notif.me

Il n'y a pas de mauvaise façon de Node

Business in a box.

Découvrez nos solutions.

Introduction à Node.js

En tant que Developer Advocate pour SparkPost, j'écris beaucoup d'applications d'exemple. Mon expérience est principalement dans le développement front-end, donc ma langue la plus forte est JavaScript. Grâce à Node.js, je suis aussi un développeur backend décent. En parlant d'applications d'exemple, Node.js fonctionne également très bien pour construire des fonctions serverless qui s'intègrent avec Flow Builder - comme notre guide d'intégration Google Cloud Functions and Vision API. Cela signifie-t-il que je suis maintenant un développeur full stack? Quoi qu'il en soit, il était important pour moi que nous ayons une bibliothèque client SparkPost géniale pour Node.js. Alors, j'ai plongé dedans et suis devenu contributeur (même avant d'être embauché).

Permettez-moi de vous aider à démarrer l'envoi d'emails avec SparkPost sur votre projet Node.js. Avant de plonger dans les spécificités de Node.js, vous voudrez peut-être comprendre les fondamentaux des API d'email dans l'infrastructure cloud et comment ils s'intègrent dans le développement d'applications modernes.

Installation & Setup

Je vais supposer que vous avez Node.js installé. Parce que nous suivons le Node.js Long Term Support (LTS), vous devrez utiliser la version 4 ou supérieure. Vous pouvez voir quelle version vous utilisez en exécutant la commande `node –version` dans votre fenêtre de terminal.

Créons un nouveau projet npm. Si vous en avez déjà un, vous pouvez passer cette partie.

> mkdir sparkpost-test > cd sparkpost-test > npm init --yes

Cela créera un nouveau projet et acceptera tous les paramètres par défaut. Vous pouvez également exécuter `npm init` et répondre à tous les messages.

Nous pouvons maintenant installer node-sparkpost:

> npm install sparkpost --save

Une fois installé, vous pouvez importer et créer une instance de la classe SparkPost:

const SparkPost = require('sparkpost') const client = new SparkPost('YOUR API KEY')

C'est une bonne pratique d'éviter de mettre votre clé API dans le code. Nous recommandons fortement de la stocker en dehors de votre code, donc nous avons configuré la bibliothèque client pour détecter la variable d'environnement SPARKPOST_API_KEY.

Créons un nouveau projet npm. Si vous en avez déjà un, vous pouvez passer cette partie.

> mkdir sparkpost-test > cd sparkpost-test > npm init --yes

Cela créera un nouveau projet et acceptera tous les paramètres par défaut. Vous pouvez également exécuter `npm init` et répondre à tous les messages.

Nous pouvons maintenant installer node-sparkpost:

> npm install sparkpost --save

Une fois installé, vous pouvez importer et créer une instance de la classe SparkPost:

const SparkPost = require('sparkpost') const client = new SparkPost('YOUR API KEY')

Créons un nouveau projet npm. Si vous en avez déjà un, vous pouvez passer cette partie.

> mkdir sparkpost-test > cd sparkpost-test > npm init --yes

Cela créera un nouveau projet et acceptera tous les paramètres par défaut. Vous pouvez également exécuter `npm init` et répondre à tous les messages.

Nous pouvons maintenant installer node-sparkpost:

> npm install sparkpost --save

Une fois installé, vous pouvez importer et créer une instance de la classe SparkPost:

const SparkPost = require('sparkpost') const client = new SparkPost('YOUR API KEY')

Envoi d'Email

Maintenant que vous avez une instance de SparkPost, vous êtes prêt à envoyer. Il existe plusieurs options disponibles pour l'envoi, mais commençons par un exemple simple. Voici comment vous envoyez un e-mail à un seul destinataire, en spécifiant le contenu en ligne :

client.transmissions.send({
  content: {
    from: 'test@your-sending-domain.com',
    subject: 'Hello from node-sparkpost',
    html: '<p>Hello world</p>'
  },
  recipients: [
    { address: 'someone@somedomain.com' }
  ]
})
.then(data => {
  console.log('Woohoo! You just sent your first mailing!')
  console.log(data)
})
.catch(err => {
  console.log('Whoops! Something went wrong')
  console.log(err)
})

Remarque : Cet exemple utilise des Promises, mais ne vous inquiétez pas. Nous supportons également les fonctions de rappel.

Pour les applications d'entreprise nécessitant une gestion complète des e-mails, les développeurs peuvent également avoir besoin de prendre en compte la construction de systèmes d'archivage d'e-mails pour gérer les exigences de stockage et de conformité.

Il existe plus d'options disponibles avec les transmissions, y compris la spécification de modèles stockés ou de listes de destinataires, cc et bcc, l'ajout de pièces jointes, la spécification d'une campagne, l'utilisation de données de substitution, et bien plus encore. Consultez les exemples, les documents pour la ressource Transmissions, et la documentation de l'API Transmissions pour plus d'infos.

Bonus : Envoyer un Email avec Nodemailer

Nodemailer est une bibliothèque populaire pour Node.js qui rend l'envoi d'e-mails « aussi simple qu'un jeu ». Pour ceux d'entre vous qui choisissent d'utiliser cette bibliothèque, nous avons créé un transport SparkPost pour Nodemailer. Vous devrez installer les packages nodemailer et nodemailer-sparkpost-transport dans votre projet.

> npm install nodemailer nodemailer-sparkpost-transport --save

Maintenant, vous pouvez créer une instance de transport nodemailer:

const nodemailer = require('nodemailer') 
const sparkPostTransport = require('nodemailer-sparkpost-transport') 
const transporter = nodemailer.createTransport(sparkPostTransport({ 
  'sparkPostApiKey': process.env.SPARKPOST_API_KEY 
}))

Notez comment je lis la clé API à partir d'une variable d'environnement. C'est toujours une bonne pratique de ne jamais la mettre directement dans votre code.

Il existe plusieurs options pouvant être passées dans le transport SparkPost, comme l'identifiant de campagne et si le message est transactionnel ou non. Consultez le README.md pour toutes les options.

Voici comment vous enverriez le même message ci-dessus en utilisant Nodemailer :

transporter.sendMail(
  {
    from: 'test@your-sending-domain.com',
    to: 'someone@somedomain.com',
    subject: 'Hello from nodemailer-sparkpost-transport',
    html: '<p>Hello world</p>'
  },
  (err, info) => {
    if (err) {
      console.error(err);
    } else {
      console.log(info);
    }
  }
);

Double Bonus : Envoyer un email avec notif.me

Nous savons tous que l'email est roi de la communication, mais parfois vous souhaitez pouvoir atteindre les gens via plusieurs canaux. notif.me est une bibliothèque Node.js pour envoyer toutes sortes de messages transactionnels. Que vous souhaitiez envoyer un email, un sms, une notification push ou des notifications web, vous pouvez le faire facilement. Il possède également des stratégies intégrées de secours et de répartition pour plusieurs fournisseurs. Nous avons récemment travaillé avec les créateurs pour créer un fournisseur SparkPost. Vous devrez installer le package `notifme-sdk` dans votre projet.

> npm install notifme-sdk --save

Vous pouvez maintenant créer une instance notifme avec le fournisseur SparkPost :

const NotifmeSdk = require('notifme-sdk').default;
const notifmeSdk = new NotifmeSdk({
  channels: {
    email: {
      providers: [
        {
          type: 'sparkpost',
          apiKey: process.env.SPARKPOST_API_KEY
        }
      ]
    }
  }
});

Encore une fois, nous tirons la clé API d'une variable d'environnement. Nous l'avons dit trois fois — c'est tellement important. 🙂

Maintenant, répétons cet exemple, cette fois en utilisant notif.me :

notifmeSdk.send({
  email: {
    from: 'test@your-sending-domain.com',
    to: 'someone@somedomain.com',
    subject: 'Hello from the SparkPost notif.me provider',
    html: '<p>Hello world</p>'
  }
})
.then(console.log)
.catch(console.error);

C'est vraiment facile à utiliser et je recommande de regarder les autres fonctionnalités.

Il n'y a pas de mauvaise façon de Node

Quand il s'agit d'envoyer des emails en utilisant Node.js, vous avez plusieurs options. Nous avons travaillé dur pour aider à rendre cela aussi indolore que possible.

Autres news

Lire la suite de cette catégorie

Extension Firebase

Commencez avec l'extension Bird sur Firebase

Constructeur de flux

Comment utiliser Flows avec Google Vision API et Google Cloud Functions

Comment utiliser SWAKS avec SparkPost

Extension Firebase

Commencez avec l'extension Bird sur Firebase

Constructeur de flux

Comment utiliser Flows avec Google Vision API et Google Cloud Functions

Extension Firebase

Commencez avec l'extension Bird sur Firebase

Constructeur de flux

Comment utiliser Flows avec Google Vision API et Google Cloud Functions

A person is standing at a desk while typing on a laptop.

La plateforme AI-native complète qui évolue avec votre business.

Commencez gratuitement

Contactez les ventes

Solutions

Retail et Ecommerce

Fintech B2C

Fintech B2B

Banque

SaaS

Marketplace

Resources

Changelog

Knowledge Base

Développeurs Hub

Centre de Support

Clients

Blog

Intégrations

Company

À propos

Pricing

Partenaires

Carrières

Legal

Terms

Paramètres de confidentialité

À venir bientôt

Support

Ventes

Finance

Newsletter

Restez à jour avec Bird grâce à des
mises à jour hebdomadaires dans votre inbox.

S'inscrire

Social

x.com

Instagram

Contactez le Support

La plateforme AI-native complète qui évolue avec votre business.

Commencez gratuitement

Contactez les ventes

Product

Solutions

Resources

Company

Paramètres de confidentialité

À venir bientôt

À propos

Pricing

Partenaires

Carrières

Legal

Terms

Paramètres de confidentialité

Social

Newsletter

Restez à jour avec Bird grâce aux mises à jour hebdomadaires dans votre boîte de réception.

S'inscrire

Contactez le Support

La plateforme AI-native complète qui évolue avec votre business.

Commencez gratuitement

Contactez les ventes

Product

Solutions

Resources

Company

Paramètres de confidentialité

Social

Newsletter

Restez à jour avec Bird grâce aux mises à jour hebdomadaires dans votre boîte de réception.

S'inscrire

Contactez le Support