Przewodnik po używaniu SparkPost z Node.js

Email

·

1 wrz 2017

Przewodnik po używaniu SparkPost z Node.js

Najważniejsze informacje

    • SparkPost oferuje wiele sposobów wysyłania e-maili z Node.js – bezpośrednie wywołania API, transport Nodemailer oraz wielokanałową dostawę notif.me.

    • Przechowuj klucze API w zmiennych środowiskowych, nigdy ich nie koduj na stałe. SparkPost automatycznie wykrywa SPARKPOST_API_KEY.

    • API Transmissions daje Ci potężną elastyczność: szablony, dane zastępcze, załączniki i tagowanie kampanii.

    • Użytkownicy Nodemailer mogą natychmiast przełączyć się na SparkPost z oficjalnym transportem — bez dużych przeróbek kodu.

    • notif.me zapewnia wielokanałową dostawę (e-mail, SMS, powiadomienia push) z strategiami awaryjnymi, co czyni go idealnym dla solidnych systemów powiadamiania.

    • Node.js naturalnie komponuje się z nowoczesnymi chmurowymi API e-mailowymi i bezserwerowymi przepływami pracy, co ułatwia osadzanie możliwości e-mailowych bezpośrednio w Twojej aplikacji.

Podsumowanie pytań i odpowiedzi

  • Jaki jest najszybszy sposób na rozpoczęcie wysyłania e-maili za pomocą SparkPost w Node.js?

    Zainstaluj pakiet sparkpost, zainicjalizuj klienta za pomocą klucza API (najlepiej przez zmienne środowiskowe), a następnie wywołaj metodę transmissions.send() z odbiorcami + treścią.

  • Czy muszę przechowywać swój klucz API SparkPost w kodzie?

    Nie — i nie powinieneś. Użyj zmiennych środowiskowych. Klient automatycznie odczytuje SPARKPOST_API_KEY.

  • Czy mogę wysyłać e-maile za pomocą szablonów zamiast wbudowanego HTML?

    Tak. API Transmissions obsługuje przechowywane szablony, dane do substytucji, listy odbiorców, załączniki, cc/bcc i wiele więcej.

  • Co jeśli już używam Nodemailer?

    Masz zapewnione wsparcie — SparkPost dostarcza oficjalny transport Nodemailer. Po prostu skonfiguruj go z kluczem API i używaj Nodemailer jak zwykle.

  • Czy SparkPost może współpracować z wielokanałowymi systemami wiadomości?

    Tak. Biblioteki takie jak notifme-sdk pozwalają na e-maile, SMS, powiadomienia push i webpush z logiką zapasową, a także zawierają dostawcę SparkPost.

  • Czy Node.js jest odpowiedni do bezserwerowych przepływów pracy związanych z e-mailem?

    Absolutnie. Dobrze współpracuje z Cloud Functions, Lambdas i każdym środowiskiem bezserwerowym wykorzystującym API SparkPost do emaili wywoływanych zdarzeniami.

  • Kto powinien używać Transmissions API zamiast Nodemailer lub notif.me?

    • Użyj Transmissions API, gdy chcesz mieć pełną kontrolę i wydajność.

    • Użyj Nodemailer, jeśli Twój projekt już go używa i chcesz szybkie wdrożenie.

    • Użyj notif.me do wiadomości wielokanałowych lub strategii dostarczania zapasowego.

  • Jakie jest najlepsze najlepsze praktyki przy wysyłaniu e-maili z Node?

    Traktuj swój klucz API jako poufny — tylko zmienne środowiskowe, nigdy nie wprowadzaj go do kodu.

Wprowadzenie do 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ż niezłym programistą backendowym. Mówiąc o przykładowych aplikacjach, Node.js działa świetnie do budowania funkcji serverless, które integrują się z Flow Builder - jak nasz przewodnik po integracji Google Cloud Functions i Vision API. Czy to oznacza, że teraz jestem programistą full stack? Tak czy inaczej, ważne było dla mnie, abyśmy mieli świetną bibliotekę klienta SparkPost dla Node.js. Zatem, zanurzyłem się w to i stałem się współautorem (nawet zanim mnie zatrudniono).

Pozwól, że pomogę Ci zacząć wysyłać e-maile z SparkPost w Twoim projekcie Node.js. Zanim zanurzymy się w specyfikę Node.js, warto zrozumieć podstawy interfejsów API e-mailowych w infrastrukturze chmurowej i jak pasują do nowoczesnego rozwoju aplikacji.

Instalacja i konfiguracja

Zakładam, że masz zainstalowany Node.js. Ponieważ przestrzegamy harmonogramu długoterminowego wsparcia (LTS) Node.js, musisz mieć wersję 4 lub wyższą. Możesz sprawdzić, którą wersję używasz, używając polecenia `node –version` w oknie terminala.

Stwórzmy nowy projekt npm. Jeśli już masz jeden, 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ż zamiast tego 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('TWOJ KLUCZ API')

To dobra praktyka, aby unikać umieszczania swojego klucza API w kodzie. Zdecydowanie zalecamy przechowywanie go poza kodem, więc skonfigurowaliśmy bibliotekę klienta do wykrywania zmiennej środowiskowej SPARKPOST_API_KEY .

Wysyłanie emaila

Teraz, gdy masz instancję SparkPost, jesteś gotowy do wysyłania. Istnieje kilka opcji dostępnych do wysyłania, ale zacznijmy od prostego przykładu. Oto jak wysłać e-mail do jednego odbiorcy, określając treść wewnętrzną:

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 obietnic (Promises), ale nie martw się. Również wspieramy funkcje zwrotne.

Dla aplikacji korporacyjnych wymagających kompleksowego zarządzania e-mailem, deweloperzy mogą również potrzebować rozważyć tworzenie systemów archiwizacji e-maili do obsługi wymagań magazynowania i zgodności.

Istnieje więcej opcji dostępnych z transmisjami, w tym określanie zapisanych 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. Sprawdź przykłady, dokumentację zasobów Transmissions oraz dokumentację API Transmissions, aby uzyskać więcej informacji.

Teraz, gdy masz instancję SparkPost, jesteś gotowy do wysyłania. Istnieje kilka opcji dostępnych do wysyłania, ale zacznijmy od prostego przykładu. Oto jak wysłać e-mail do jednego odbiorcy, określając treść wewnętrzną:

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 obietnic (Promises), ale nie martw się. Również wspieramy funkcje zwrotne.

Dla aplikacji korporacyjnych wymagających kompleksowego zarządzania e-mailem, deweloperzy mogą również potrzebować rozważyć tworzenie systemów archiwizacji e-maili do obsługi wymagań magazynowania i zgodności.

Istnieje więcej opcji dostępnych z transmisjami, w tym określanie zapisanych 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. Sprawdź przykłady, dokumentację zasobów Transmissions oraz dokumentację API Transmissions, aby uzyskać więcej informacji.

Teraz, gdy masz instancję SparkPost, jesteś gotowy do wysyłania. Istnieje kilka opcji dostępnych do wysyłania, ale zacznijmy od prostego przykładu. Oto jak wysłać e-mail do jednego odbiorcy, określając treść wewnętrzną:

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 obietnic (Promises), ale nie martw się. Również wspieramy funkcje zwrotne.

Dla aplikacji korporacyjnych wymagających kompleksowego zarządzania e-mailem, deweloperzy mogą również potrzebować rozważyć tworzenie systemów archiwizacji e-maili do obsługi wymagań magazynowania i zgodności.

Istnieje więcej opcji dostępnych z transmisjami, w tym określanie zapisanych 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. Sprawdź przykłady, dokumentację zasobów Transmissions oraz dokumentację API Transmissions, aby uzyskać więcej informacji.

Bonus: Wysyłanie e-maili za pomocą Nodemailer

Nodemailer to popularna biblioteka dla Node.js, która sprawia, że wysyłanie e-maili jest "łatwe jak bułka z masłem." Dla tych z Was, którzy zdecydują się użyć 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. Wciąż najlepszą praktyką jest nigdy nie umieszczać go bezpośrednio w swoim kodzie.

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

Oto jak wysłałbyś 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);
    }
  }
);

Nodemailer to popularna biblioteka dla Node.js, która sprawia, że wysyłanie e-maili jest "łatwe jak bułka z masłem." Dla tych z Was, którzy zdecydują się użyć 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. Wciąż najlepszą praktyką jest nigdy nie umieszczać go bezpośrednio w swoim kodzie.

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

Oto jak wysłałbyś 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);
    }
  }
);

Nodemailer to popularna biblioteka dla Node.js, która sprawia, że wysyłanie e-maili jest "łatwe jak bułka z masłem." Dla tych z Was, którzy zdecydują się użyć 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. Wciąż najlepszą praktyką jest nigdy nie umieszczać go bezpośrednio w swoim kodzie.

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

Oto jak wysłałbyś 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 wiadomości e-mail z notif.me

Wszyscy wiemy, że e-mail jest królem komunikacji, ale czasami chcesz dotrzeć do ludzi za pośrednictwem 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ć e-mail, sms, powiadomienia push czy webpush, możesz to zrobić bez problemu. Posiada również wbudowane strategie awaryjne i okrężne dla wielu dostawców. Niedawno współpracowaliśmy z twórcami, aby stworzyć dostawcę SparkPost. Musisz 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 na tyle 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);

To naprawdę łatwe w użyciu i polecam spojrzeć na inne funkcje.

Porównanie opcji przesyłania e-maili w Node.js

Metoda

Wymagane pakiety

Obsługa klucza API

Najlepsze dla

Uwagi

API SparkPost (node-sparkpost)

sparkpost

Używa zmiennej środowiskowej SPARKPOST_API_KEY

Bezpośrednia kontrola API, pełny dostęp do funkcji transmisji

Największa elastyczność; obsługuje szablony, dane substytucyjne, załączniki, kampanie

Nodemailer + Transport SparkPost

nodemailer, nodemailer-sparkpost-transport

Używa zmiennej środowiskowej w konfiguracji transportu

Deweloperzy już używający Nodemailer

Najłatwiejsza ścieżka migracji; minimalne zmiany w kodzie

notif.me + Dostawca SparkPost

notifme-sdk

Używa zmiennej środowiskowej w konfiguracji dostawcy

Wielokanałowe przesyłanie wiadomości (e-mail, SMS, powiadomienia push)

Zawiera strategie awaryjne + okrężne pomiędzy dostawcami

Wszyscy wiemy, że e-mail jest królem komunikacji, ale czasami chcesz dotrzeć do ludzi za pośrednictwem 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ć e-mail, sms, powiadomienia push czy webpush, możesz to zrobić bez problemu. Posiada również wbudowane strategie awaryjne i okrężne dla wielu dostawców. Niedawno współpracowaliśmy z twórcami, aby stworzyć dostawcę SparkPost. Musisz 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 na tyle 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);

To naprawdę łatwe w użyciu i polecam spojrzeć na inne funkcje.

Porównanie opcji przesyłania e-maili w Node.js

Metoda

Wymagane pakiety

Obsługa klucza API

Najlepsze dla

Uwagi

API SparkPost (node-sparkpost)

sparkpost

Używa zmiennej środowiskowej SPARKPOST_API_KEY

Bezpośrednia kontrola API, pełny dostęp do funkcji transmisji

Największa elastyczność; obsługuje szablony, dane substytucyjne, załączniki, kampanie

Nodemailer + Transport SparkPost

nodemailer, nodemailer-sparkpost-transport

Używa zmiennej środowiskowej w konfiguracji transportu

Deweloperzy już używający Nodemailer

Najłatwiejsza ścieżka migracji; minimalne zmiany w kodzie

notif.me + Dostawca SparkPost

notifme-sdk

Używa zmiennej środowiskowej w konfiguracji dostawcy

Wielokanałowe przesyłanie wiadomości (e-mail, SMS, powiadomienia push)

Zawiera strategie awaryjne + okrężne pomiędzy dostawcami

Wszyscy wiemy, że e-mail jest królem komunikacji, ale czasami chcesz dotrzeć do ludzi za pośrednictwem 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ć e-mail, sms, powiadomienia push czy webpush, możesz to zrobić bez problemu. Posiada również wbudowane strategie awaryjne i okrężne dla wielu dostawców. Niedawno współpracowaliśmy z twórcami, aby stworzyć dostawcę SparkPost. Musisz 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 na tyle 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);

To naprawdę łatwe w użyciu i polecam spojrzeć na inne funkcje.

Porównanie opcji przesyłania e-maili w Node.js

Metoda

Wymagane pakiety

Obsługa klucza API

Najlepsze dla

Uwagi

API SparkPost (node-sparkpost)

sparkpost

Używa zmiennej środowiskowej SPARKPOST_API_KEY

Bezpośrednia kontrola API, pełny dostęp do funkcji transmisji

Największa elastyczność; obsługuje szablony, dane substytucyjne, załączniki, kampanie

Nodemailer + Transport SparkPost

nodemailer, nodemailer-sparkpost-transport

Używa zmiennej środowiskowej w konfiguracji transportu

Deweloperzy już używający Nodemailer

Najłatwiejsza ścieżka migracji; minimalne zmiany w kodzie

notif.me + Dostawca SparkPost

notifme-sdk

Używa zmiennej środowiskowej w konfiguracji dostawcy

Wielokanałowe przesyłanie wiadomości (e-mail, SMS, powiadomienia push)

Zawiera strategie awaryjne + okrężne pomiędzy dostawcami

Nie ma złego sposobu na Node

Kiedy chodzi o wysyłanie e-maili za pomocą Node.js, masz wiele opcji. Ciężko pracowaliśmy, aby uczynić to jak najmniej bolesnym.

Inne wiadomości

Przeczytaj więcej z tej kategorii

1 cze 2021

Rozpocznij korzystanie z rozszerzenia Bird na Firebase

6 paź 2020

Jak używać Flows z Google Vision API i Google Cloud Functions

24 cze 2021

Jak używać SWAKS z SparkPost

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

Kompletna platforma oparta na sztucznej inteligencji, która rośnie wraz z Twoim biznesem.

Skontaktuj się z działem sprzedaży

Zacznij za darmo

© 2026 Ptak

Skontaktuj się z pomocą techniczną

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

Kompletna platforma oparta na sztucznej inteligencji, która rośnie wraz z Twoim biznesem.

Skontaktuj się z działem sprzedaży

Zacznij za darmo

© 2026 Ptak

Skontaktuj się z pomocą techniczną

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

Kompletna platforma oparta na sztucznej inteligencji, która rośnie wraz z Twoim biznesem.

Skontaktuj się z działem sprzedaży

Zacznij za darmo

© 2026 Ptak

Skontaktuj się z pomocą techniczną