Madmail

NodeJS

Pré-requisitos

Usando o SDK

  1. Instalar o SDK

    O pacote no npm se chama usesend-js — é o SDK do projeto open-source que dá origem ao Madmail, e é esse nome que você instala.

    npm install usesend-js
    yarn add usesend-js
    pnpm add usesend-js
    bun add usesend-js
  2. Inicializar o SDK

    Pegue a chave de API no painel do Madmail e inicialize o cliente:

    import { UseSend } from "usesend-js";
    
    const madmail = new UseSend("us_12345");

    Se você roda a sua própria instância, passe a URL base como segundo argumento:

    const madmail = new UseSend("us_12345", "https://app.madmail.com.br");
  3. Enviar um email
    madmail.emails.send({
      to: "ola@acme.com",
      from: "ola@suaempresa.com.br",
      subject: "Email pelo Madmail",
      html: "<p>O Madmail é o jeito mais simples de enviar emails transacionais</p>",
      text: "O Madmail é o jeito mais simples de enviar emails transacionais",
      headers: {
        "X-Campaign": "boas-vindas",
      },
    });

    Cabeçalhos personalizados são repassados como vieram. O Madmail só controla os cabeçalhos X-Usesend-Email-ID e References.

Adicionando contatos pela API

  1. Pegar o id da lista de contatos

    Pegue o id da lista de contatos no painel do Madmail e copie o valor.

  2. Adicionar contatos
    madmail.contacts
      .create("clzeydgeygff", {
        email: "ola@exemplo.com.br",
        firstName: "Ana",
        lastName: "Souza",
      })
  3. Atualizar um contato
    madmail.contacts.update("clzeydgeygff", contactId, {
      firstName: "Ana",
      lastName: "Souza",
    });