Produkt

Rozwiązania

Zasoby

Company

Produkt

Rozwiązania

Zasoby

Company

Przewodnik po korzystaniu z SparkPost z Node.js

Ptak

1 wrz 2017

Email

1 min read

Przewodnik po korzystaniu z SparkPost z Node.js

Ptak

1 wrz 2017

Email

1 min read

Przewodnik po korzystaniu z SparkPost z Node.js

Jako Developer Advocate w SparkPost piszę wiele przykładowych aplikacji. Moje doświadczenie to głównie rozwój front-end, dlatego moim najsilniejszym językiem jest JavaScript. Dzięki Node.js jestem również przyzwoitym deweloperem back-end. Czy to oznacza, że teraz jestem deweloperem full stack?

Wprowadzenie do Node.js

Jako Developer Advocate dla SparkPost, piszę wiele aplikacji przykładowych. Moje doświadczenie to głównie rozwój front-end, dlatego moim najsilniejszym językiem jest JavaScript. Dzięki Node.js jestem również przyzwoitym programistą backendowym. Mówiąc o aplikacjach przykładowych, Node.js doskonale nadaje się do tworzenia funkcji bezserwerowych, które integrują się z Flow Builder - jak nasz poradnik integracji Google Cloud Functions i Vision API. Czy to oznacza, że teraz jestem pełnoprawnym programistą full stack? Tak czy inaczej, ważne było dla mnie, że mamy wspaniałą bibliotekę klienta SparkPost dla Node.js. Więc zagłębiłem się w to i stałem się jednym z współtwórców (nawet zanim zostałem zatrudniony).

Pozwól mi pomóc ci rozpocząć wysyłanie e-maili z SparkPost w twoim projekcie Node.js. Zanim zagłębisz się w szczegóły dotyczące Node.js, możesz chcieć zrozumieć podstawy API e-mail w infrastrukturze chmury i jak wpisują się one w nowoczesny rozwój aplikacji.

Instalacja i konfiguracja

Zakładam, że masz zainstalowany Node.js. Ponieważ stosujemy harmonogram wsparcia długoterminowego (LTS) Node.js, musisz używać wersji 4 lub wyższej. Możesz sprawdzić, której wersji używasz, korzystając z polecenia `node –version` w oknie terminala.

Stwórzmy nowy projekt npm. Jeśli już masz taki projekt, możesz pominąć tę część.

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

To stworzy nowy projekt i zaakceptuje wszystkie domyślne ustawienia. Możesz również uruchomić `npm init` i odpowiedzieć na wszystkie pytania.

Teraz możemy zainstalować node-sparkpost:

> npm install sparkpost --save

Po zainstalowaniu możesz zaimportować i utworzyć instancję klasy SparkPost:

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

Dobrym zwyczajem jest unikanie umieszczania klucza API w kodzie. Gorąco zalecamy przechowywanie go poza kodem, dlatego skonfigurowaliśmy bibliotekę klienta do wykrywania zmiennej środowiskowej SPARKPOST_API_KEY.

Zakładam, że masz zainstalowany Node.js. Ponieważ stosujemy harmonogram wsparcia długoterminowego (LTS) Node.js, musisz używać wersji 4 lub wyższej. Możesz sprawdzić, której wersji używasz, korzystając z polecenia `node –version` w oknie terminala.

Stwórzmy nowy projekt npm. Jeśli już masz taki projekt, możesz pominąć tę część.

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

To stworzy nowy projekt i zaakceptuje wszystkie domyślne ustawienia. Możesz również uruchomić `npm init` i odpowiedzieć na wszystkie pytania.

Teraz możemy zainstalować node-sparkpost:

> npm install sparkpost --save

Po zainstalowaniu możesz zaimportować i utworzyć instancję klasy SparkPost:

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

Dobrym zwyczajem jest unikanie umieszczania klucza API w kodzie. Gorąco zalecamy przechowywanie go poza kodem, dlatego skonfigurowaliśmy bibliotekę klienta do wykrywania zmiennej środowiskowej SPARKPOST_API_KEY.

Zakładam, że masz zainstalowany Node.js. Ponieważ stosujemy harmonogram wsparcia długoterminowego (LTS) Node.js, musisz używać wersji 4 lub wyższej. Możesz sprawdzić, której wersji używasz, korzystając z polecenia `node –version` w oknie terminala.

Stwórzmy nowy projekt npm. Jeśli już masz taki projekt, możesz pominąć tę część.

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

To stworzy nowy projekt i zaakceptuje wszystkie domyślne ustawienia. Możesz również uruchomić `npm init` i odpowiedzieć na wszystkie pytania.

Teraz możemy zainstalować node-sparkpost:

> npm install sparkpost --save

Po zainstalowaniu możesz zaimportować i utworzyć instancję klasy SparkPost:

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

Dobrym zwyczajem jest unikanie umieszczania klucza API w kodzie. Gorąco zalecamy przechowywanie go poza kodem, dlatego skonfigurowaliśmy bibliotekę klienta do wykrywania zmiennej środowiskowej SPARKPOST_API_KEY.

Wysyłanie Email

Teraz, gdy masz instancję SparkPost, jesteś gotowy do wysyłania. Dostępnych jest całkiem sporo opcji wysyłania, ale zacznijmy od prostego przykładu. Oto jak wysłać e-mail do pojedynczego odbiorcy, określając zawartość inline:

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)
})

Uwaga: Ten przykład używa Promises, ale nie martw się. My również obsługujemy funkcje zwrotne.

W przypadku aplikacji korporacyjnych wymagających kompleksowego zarządzania e-mailami, deweloperzy mogą również rozważyć budowę systemów archiwizacji e-mail w celu obsługi wymagań dotyczących przechowywania i zgodności.

Dostępnych jest więcej opcji dla transmisji, w tym możliwość określenia przechowywanych szablonów lub list odbiorców, cc i bcc, dodawanie załączników, określanie kampanii, używanie danych zastępczych i wiele więcej. Zapoznaj się z przykładami, dokumentacją zasobu Transmissions, oraz dokumentacją API Transmissions dla więcej informacji.

Bonus: Wysyłanie Email z Nodemailer

Nodemailer jest popularną biblioteką dla Node.js, która sprawia, że wysyłanie e-maili jest „proste jak ciasto.” Dla tych z Was, którzy decydują się na użycie tej biblioteki, stworzyliśmy transport SparkPost dla Nodemailer. Będziesz musiał zainstalować pakiety nodemailer i nodemailer-sparkpost-transport w swoim projekcie.

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

Teraz możesz utworzyć instancję transportu nodemailer:

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

Zauważ, jak odczytuję klucz API z zmiennej środowiskowej. Nadal obowiązuje najlepsza praktyka, aby nigdy nie umieszczać go bezpośrednio w kodzie.

Istnieje kilka opcji, które można przekazać do transportu SparkPost, jak identyfikator kampanii oraz czy wiadomość jest transakcyjna. Zajrzyj do README.md po wszystkie opcje.

Oto, jak można wysłać tę samą wiadomość powyżej używając 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);
    }
  }
);

Podwójny Bonus: Wysyłanie Email z notif.me

Wszyscy wiemy, że email jest królem komunikacji, ale czasami chcesz móc dotrzeć do ludzi za pomocą wielu kanałów. notif.me to biblioteka Node.js do wysyłania wszelkiego rodzaju wiadomości transakcyjnych. Niezależnie od tego, czy chcesz wysłać email, sms, push, czy webpush, możesz to zrobić z łatwością. Posiada również wbudowane strategie upadku i round robin dla wielu dostawców. Niedawno współpracowaliśmy z twórcami, aby zbudować dostawcę SparkPost. Będziesz musiał zainstalować pakiet `notifme-sdk` w swoim projekcie.

> npm install notifme-sdk --save

Możesz teraz utworzyć instancję notifme z dostawcą SparkPost:

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

Ponownie, pobieramy klucz API z zmiennej środowiskowej. Powiedzieliśmy to trzy razy — to jest tak ważne. 🙂

Teraz powtórzmy ten sam przykład, tym razem używając 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);

Jest naprawdę łatwy w użyciu i polecam zapoznanie się z innymi funkcjami.

Nie ma złego sposobu na Node

Jeśli chodzi o wysyłanie e-maili za pomocą Node.js, masz wiele opcji. Pracowaliśmy ciężko, aby uczynić to jak najprostszym.

Kompletna, AI-native platforma, która skaluje się wraz z Twoim business.

Produkt

Rozwiązania

Zasoby

Company

Ustawienia prywatności

Już wkrótce

Social

Biuletyn

Bądź na bieżąco z Bird dzięki cotygodniowym aktualizacjom do Twojej skrzynki odbiorczej.

Zarejestruj się

Kompletna, AI-native platforma, która skaluje się wraz z Twoim business.

Produkt

Rozwiązania

Zasoby

Company

Ustawienia prywatności

Social

Biuletyn

Bądź na bieżąco z Bird dzięki cotygodniowym aktualizacjom do Twojej skrzynki odbiorczej.

Zarejestruj się