Send email with SendPelican

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$response = $client->post('https://sendpelican.com/v1/emails', [
    'headers' => [
        'Authorization' => 'Bearer <YOUR_API_TOKEN>',
        'Content-Type' => 'application/json',
    ],
    'body' => <<<'JSON'
    {
      "from": {
        "email": "hello@yourdomain.com"
      },
      "to": [
        "recipient@example.com"
      ],
      "subject": "Hello from yourdomain.com",
      "html": "<p>Sent with SendPelican.</p>",
      "text": "Sent with SendPelican.",
      "category": "welcome"
    }
    JSON,
]);

echo $response->getStatusCode(), ' ', $response->getBody(), PHP_EOL;

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<YOUR_API_TOKEN>')
    ->withBody(<<<'JSON'
        {
          "from": {
            "email": "hello@yourdomain.com"
          },
          "to": [
            "recipient@example.com"
          ],
          "subject": "Hello from yourdomain.com",
          "html": "<p>Sent with SendPelican.</p>",
          "text": "Sent with SendPelican.",
          "category": "welcome"
        }
        JSON)
    ->post('https://sendpelican.com/v1/emails')
    ->throw();

echo $response->json('data.batch');

// Node.js 18+, saved as send.mjs
const response = await fetch('https://sendpelican.com/v1/emails', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <YOUR_API_TOKEN>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "from": {
      "email": "hello@yourdomain.com"
    },
    "to": [
      "recipient@example.com"
    ],
    "subject": "Hello from yourdomain.com",
    "html": "<p>Sent with SendPelican.</p>",
    "text": "Sent with SendPelican.",
    "category": "welcome"
  }),
});

console.log(response.status, await response.json());

# pip install requests
import requests

response = requests.post(
    "https://sendpelican.com/v1/emails",
    headers={"Authorization": "Bearer <YOUR_API_TOKEN>"},
    json={
      "from": {
        "email": "hello@yourdomain.com"
      },
      "to": [
        "recipient@example.com"
      ],
      "subject": "Hello from yourdomain.com",
      "html": "<p>Sent with SendPelican.</p>",
      "text": "Sent with SendPelican.",
      "category": "welcome"
    },
)
print(response.status_code, response.json())

require "net/http"
require "uri"

uri = URI("https://sendpelican.com/v1/emails")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <YOUR_API_TOKEN>"
request["Content-Type"] = "application/json"
request.body = <<~JSON
  {
    "from": {
      "email": "hello@yourdomain.com"
    },
    "to": [
      "recipient@example.com"
    ],
    "subject": "Hello from yourdomain.com",
    "html": "<p>Sent with SendPelican.</p>",
    "text": "Sent with SendPelican.",
    "category": "welcome"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts response.code, response.body

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := `{
	  "from": {
	    "email": "hello@yourdomain.com"
	  },
	  "to": [
	    "recipient@example.com"
	  ],
	  "subject": "Hello from yourdomain.com",
	  "html": "<p>Sent with SendPelican.</p>",
	  "text": "Sent with SendPelican.",
	  "category": "welcome"
	}`

	req, err := http.NewRequest("POST", "https://sendpelican.com/v1/emails", strings.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <YOUR_API_TOKEN>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

// Java 15+
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SendEmail {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "from": {
                "email": "hello@yourdomain.com"
              },
              "to": [
                "recipient@example.com"
              ],
              "subject": "Hello from yourdomain.com",
              "html": "<p>Sent with SendPelican.</p>",
              "text": "Sent with SendPelican.",
              "category": "welcome"
            }
            """;

        HttpRequest request = HttpRequest.newBuilder(URI.create("https://sendpelican.com/v1/emails"))
            .header("Authorization", "Bearer <YOUR_API_TOKEN>")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

// .NET 7+ (C# 11 raw strings), top-level Program.cs
using System.Net.Http.Headers;
using System.Text;

var json = """
    {
      "from": {
        "email": "hello@yourdomain.com"
      },
      "to": [
        "recipient@example.com"
      ],
      "subject": "Hello from yourdomain.com",
      "html": "<p>Sent with SendPelican.</p>",
      "text": "Sent with SendPelican.",
      "category": "welcome"
    }
    """;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "<YOUR_API_TOKEN>");

var response = await client.PostAsync("https://sendpelican.com/v1/emails", new StringContent(json, Encoding.UTF8, "application/json"));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

<?php
// composer require phpmailer/phpmailer
require 'vendor/autoload.php';

use PHPMailer\PHPMailer\PHPMailer;

$mail = new PHPMailer(true);
$mail->isSMTP();
$mail->Host = 'smtp.sendpelican.com';
$mail->Port = 587;
$mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;
$mail->SMTPAuth = true;
$mail->Username = '<SMTP_USERNAME>';
$mail->Password = '<SMTP_PASSWORD>';

$mail->setFrom('hello@yourdomain.com');
$mail->addAddress('recipient@example.com');
$mail->Subject = 'Hello from yourdomain.com';
$mail->addCustomHeader('X-Mailflow-Category', 'welcome');
$mail->isHTML(true);
$mail->Body = '<p>Sent with SendPelican.</p>';
$mail->AltBody = 'Sent with SendPelican.';
$mail->send();

// npm install nodemailer, saved as send.mjs
import nodemailer from 'nodemailer';

const transporter = nodemailer.createTransport({
  host: 'smtp.sendpelican.com',
  port: 587,
  secure: false,
  requireTLS: true,
  auth: { user: '<SMTP_USERNAME>', pass: '<SMTP_PASSWORD>' },
});

const info = await transporter.sendMail({
  from: 'hello@yourdomain.com',
  to: 'recipient@example.com',
  subject: 'Hello from yourdomain.com',
  headers: { 'X-Mailflow-Category': 'welcome' },
  html: '<p>Sent with SendPelican.</p>',
  text: 'Sent with SendPelican.',
});
console.log(info.response);

import smtplib
from email.message import EmailMessage

msg = EmailMessage()
msg["From"] = "hello@yourdomain.com"
msg["To"] = "recipient@example.com"
msg["Subject"] = "Hello from yourdomain.com"
msg["X-Mailflow-Category"] = "welcome"
msg.set_content("Sent with SendPelican.")
msg.add_alternative("<p>Sent with SendPelican.</p>", subtype="html")

with smtplib.SMTP("smtp.sendpelican.com", 587) as smtp:
    smtp.starttls()
    smtp.login("<SMTP_USERNAME>", "<SMTP_PASSWORD>")
    smtp.send_message(msg)

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$response = $client->post('https://sendpelican.com/v1/bulk/emails', [
    'headers' => [
        'Authorization' => 'Bearer <YOUR_API_TOKEN>',
        'Content-Type' => 'application/json',
    ],
    'body' => <<<'JSON'
    {
      "from": {
        "email": "hello@yourdomain.com"
      },
      "recipients": [
        {
          "email": "ada@example.com",
          "variables": {
            "name": "Ada",
            "plan": "Pro"
          }
        },
        {
          "email": "grace@example.com",
          "variables": {
            "name": "Grace",
            "plan": "Starter"
          }
        }
      ],
      "subject": "News for you, {{ name }}",
      "html": "<p>Hi {{ name }}, here is what is new on your {{ plan }} plan.</p>",
      "text": "Hi {{ name }}, here is what is new on your {{ plan }} plan.",
      "category": "newsletter"
    }
    JSON,
]);

echo $response->getStatusCode(), ' ', $response->getBody(), PHP_EOL;

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<YOUR_API_TOKEN>')
    ->withBody(<<<'JSON'
        {
          "from": {
            "email": "hello@yourdomain.com"
          },
          "recipients": [
            {
              "email": "ada@example.com",
              "variables": {
                "name": "Ada",
                "plan": "Pro"
              }
            },
            {
              "email": "grace@example.com",
              "variables": {
                "name": "Grace",
                "plan": "Starter"
              }
            }
          ],
          "subject": "News for you, {{ name }}",
          "html": "<p>Hi {{ name }}, here is what is new on your {{ plan }} plan.</p>",
          "text": "Hi {{ name }}, here is what is new on your {{ plan }} plan.",
          "category": "newsletter"
        }
        JSON)
    ->post('https://sendpelican.com/v1/bulk/emails')
    ->throw();

echo $response->json('data.batch');

// Node.js 18+, saved as send.mjs
const response = await fetch('https://sendpelican.com/v1/bulk/emails', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <YOUR_API_TOKEN>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "from": {
      "email": "hello@yourdomain.com"
    },
    "recipients": [
      {
        "email": "ada@example.com",
        "variables": {
          "name": "Ada",
          "plan": "Pro"
        }
      },
      {
        "email": "grace@example.com",
        "variables": {
          "name": "Grace",
          "plan": "Starter"
        }
      }
    ],
    "subject": "News for you, {{ name }}",
    "html": "<p>Hi {{ name }}, here is what is new on your {{ plan }} plan.</p>",
    "text": "Hi {{ name }}, here is what is new on your {{ plan }} plan.",
    "category": "newsletter"
  }),
});

console.log(response.status, await response.json());

# pip install requests
import requests

response = requests.post(
    "https://sendpelican.com/v1/bulk/emails",
    headers={"Authorization": "Bearer <YOUR_API_TOKEN>"},
    json={
      "from": {
        "email": "hello@yourdomain.com"
      },
      "recipients": [
        {
          "email": "ada@example.com",
          "variables": {
            "name": "Ada",
            "plan": "Pro"
          }
        },
        {
          "email": "grace@example.com",
          "variables": {
            "name": "Grace",
            "plan": "Starter"
          }
        }
      ],
      "subject": "News for you, {{ name }}",
      "html": "<p>Hi {{ name }}, here is what is new on your {{ plan }} plan.</p>",
      "text": "Hi {{ name }}, here is what is new on your {{ plan }} plan.",
      "category": "newsletter"
    },
)
print(response.status_code, response.json())

require "net/http"
require "uri"

uri = URI("https://sendpelican.com/v1/bulk/emails")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <YOUR_API_TOKEN>"
request["Content-Type"] = "application/json"
request.body = <<~JSON
  {
    "from": {
      "email": "hello@yourdomain.com"
    },
    "recipients": [
      {
        "email": "ada@example.com",
        "variables": {
          "name": "Ada",
          "plan": "Pro"
        }
      },
      {
        "email": "grace@example.com",
        "variables": {
          "name": "Grace",
          "plan": "Starter"
        }
      }
    ],
    "subject": "News for you, {{ name }}",
    "html": "<p>Hi {{ name }}, here is what is new on your {{ plan }} plan.</p>",
    "text": "Hi {{ name }}, here is what is new on your {{ plan }} plan.",
    "category": "newsletter"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts response.code, response.body

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := `{
	  "from": {
	    "email": "hello@yourdomain.com"
	  },
	  "recipients": [
	    {
	      "email": "ada@example.com",
	      "variables": {
	        "name": "Ada",
	        "plan": "Pro"
	      }
	    },
	    {
	      "email": "grace@example.com",
	      "variables": {
	        "name": "Grace",
	        "plan": "Starter"
	      }
	    }
	  ],
	  "subject": "News for you, {{ name }}",
	  "html": "<p>Hi {{ name }}, here is what is new on your {{ plan }} plan.</p>",
	  "text": "Hi {{ name }}, here is what is new on your {{ plan }} plan.",
	  "category": "newsletter"
	}`

	req, err := http.NewRequest("POST", "https://sendpelican.com/v1/bulk/emails", strings.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <YOUR_API_TOKEN>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

// Java 15+
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SendEmail {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "from": {
                "email": "hello@yourdomain.com"
              },
              "recipients": [
                {
                  "email": "ada@example.com",
                  "variables": {
                    "name": "Ada",
                    "plan": "Pro"
                  }
                },
                {
                  "email": "grace@example.com",
                  "variables": {
                    "name": "Grace",
                    "plan": "Starter"
                  }
                }
              ],
              "subject": "News for you, {{ name }}",
              "html": "<p>Hi {{ name }}, here is what is new on your {{ plan }} plan.</p>",
              "text": "Hi {{ name }}, here is what is new on your {{ plan }} plan.",
              "category": "newsletter"
            }
            """;

        HttpRequest request = HttpRequest.newBuilder(URI.create("https://sendpelican.com/v1/bulk/emails"))
            .header("Authorization", "Bearer <YOUR_API_TOKEN>")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

// .NET 7+ (C# 11 raw strings), top-level Program.cs
using System.Net.Http.Headers;
using System.Text;

var json = """
    {
      "from": {
        "email": "hello@yourdomain.com"
      },
      "recipients": [
        {
          "email": "ada@example.com",
          "variables": {
            "name": "Ada",
            "plan": "Pro"
          }
        },
        {
          "email": "grace@example.com",
          "variables": {
            "name": "Grace",
            "plan": "Starter"
          }
        }
      ],
      "subject": "News for you, {{ name }}",
      "html": "<p>Hi {{ name }}, here is what is new on your {{ plan }} plan.</p>",
      "text": "Hi {{ name }}, here is what is new on your {{ plan }} plan.",
      "category": "newsletter"
    }
    """;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "<YOUR_API_TOKEN>");

var response = await client.PostAsync("https://sendpelican.com/v1/bulk/emails", new StringContent(json, Encoding.UTF8, "application/json"));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

<?php
// composer require phpmailer/phpmailer
require 'vendor/autoload.php';

use PHPMailer\PHPMailer\PHPMailer;

$mail = new PHPMailer(true);
$mail->isSMTP();
$mail->Host = 'smtp.sendpelican.com';
$mail->Port = 2525;
$mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;
$mail->SMTPAuth = true;
$mail->Username = '<SMTP_USERNAME>';
$mail->Password = '<SMTP_PASSWORD>';

$mail->setFrom('app@staging.example.com');
$mail->addAddress('recipient@example.com');
$mail->Subject = 'Hello from staging.example.com';
$mail->addCustomHeader('X-Mailflow-Category', 'welcome');
$mail->isHTML(true);
$mail->Body = '<p>Sent with SendPelican.</p>';
$mail->AltBody = 'Sent with SendPelican.';
$mail->send();

// npm install nodemailer, saved as send.mjs
import nodemailer from 'nodemailer';

const transporter = nodemailer.createTransport({
  host: 'smtp.sendpelican.com',
  port: 2525,
  secure: false,
  requireTLS: true,
  auth: { user: '<SMTP_USERNAME>', pass: '<SMTP_PASSWORD>' },
});

const info = await transporter.sendMail({
  from: 'app@staging.example.com',
  to: 'recipient@example.com',
  subject: 'Hello from staging.example.com',
  headers: { 'X-Mailflow-Category': 'welcome' },
  html: '<p>Sent with SendPelican.</p>',
  text: 'Sent with SendPelican.',
});
console.log(info.response);

import smtplib
from email.message import EmailMessage

msg = EmailMessage()
msg["From"] = "app@staging.example.com"
msg["To"] = "recipient@example.com"
msg["Subject"] = "Hello from staging.example.com"
msg["X-Mailflow-Category"] = "welcome"
msg.set_content("Sent with SendPelican.")
msg.add_alternative("<p>Sent with SendPelican.</p>", subtype="html")

with smtplib.SMTP("smtp.sendpelican.com", 2525) as smtp:
    smtp.starttls()
    smtp.login("<SMTP_USERNAME>", "<SMTP_PASSWORD>")
    smtp.send_message(msg)

import json, os, re, smtplib, urllib.request
from email.message import EmailMessage

API = "https://sendpelican.com/v1/sandbox"
KEY = os.environ["SANDBOX_API_KEY"]      # sandbox:read and sandbox:manage
INBOX = os.environ["SANDBOX_INBOX_ID"]

def api(path, method="GET"):
    request = urllib.request.Request(API + path, method=method, headers={"Authorization": f"Bearer {KEY}"})
    with urllib.request.urlopen(request, timeout=40) as response:
        return response.read()

# In a real test your app sends this; it is here so the script runs on its own.
msg = EmailMessage()
msg["From"], msg["To"], msg["Subject"] = "app@staging.test", "ada@example.com", "Confirm your email"
msg.set_content("Confirm: https://staging.test/confirm/abc123")
msg.add_alternative('<a href="https://staging.test/confirm/abc123">Confirm</a>', subtype="html")
with smtplib.SMTP("smtp.sendpelican.com", 2525) as smtp:
    smtp.starttls()
    smtp.login(os.environ["SANDBOX_SMTP_USERNAME"], os.environ["SANDBOX_SMTP_PASSWORD"])
    smtp.send_message(msg)

message = json.loads(api(f"/inboxes/{INBOX}/messages/wait?to=ada@example.com&timeout=30"))["data"]
html = api(f"/messages/{message['id']}/html").decode()
link = re.search(r'https://[^"]+/confirm/[^"]+', html).group(0)
assert link == "https://staging.test/confirm/abc123", link

api(f"/inboxes/{INBOX}/clean", method="POST")

const crypto = require('node:crypto');

function mailflowSignatureIsValid(header, rawBody, secret, toleranceSeconds = 300) {
  const match = /^t=(\d+),v1=([0-9a-f]{64})$/.exec(header ?? '');
  if (!match) return false;
  const [, t, v1] = match;
  const expected = crypto.createHmac('sha256', secret).update(`${t}.${rawBody}`).digest('hex');
  const fresh = Math.abs(Date.now() / 1000 - Number(t)) <= toleranceSeconds;
  return fresh && crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(v1));
}

// Express: app.post('/hooks/mailflow', express.raw({ type: 'application/json' }), (req, res) => {
//   if (!mailflowSignatureIsValid(req.get('Mailflow-Signature'), req.body.toString('utf8'), secret)) return res.sendStatus(400);
//   res.sendStatus(200);
// });