Language SDKs

Java

Send published Sendery templates from Java.

Install

<dependency>
  <groupId>co.sendery</groupId>
  <artifactId>sendery-java</artifactId>
  <version>0.1.4</version>
</dependency>

Source code

Requirements

Java 17+.

Set up

Choose a published template and create a project API key. Store the key as SENDERY_API_KEY on your server.

Shell

export SENDERY_API_KEY="your_project_api_key"

Send an email

Replace your-template with your published template’s key and data with its variables.

The response contains the accepted email’s id and status.

Java

import co.sendery.Sendery;
import java.util.Map;

public class SendEmail {
    public static void main(String[] args) {
        var sendery = new Sendery(System.getenv("SENDERY_API_KEY"));
        var receipt = sendery.send("[email protected]", "your-template", Map.of(
            "name", "Alex",
            "action_url", "https://example.com/start"
        ));
        System.out.println(receipt.id());
    }
}

Retrieve an email

Use the returned ID to check delivery status. SendReceipt also provides errorCode(), createdAt(), and submittedAt(). Calls block until the request completes.

Java

var message = sendery.get(receipt.id());
System.out.println(message.status());

Retry a send

Use retry(3) for up to three extra attempts after temporary failures. Keep the same idempotency key and email data on every attempt.

Java

var email = sendery.prepare("[email protected]", "your-template", Map.of(
    "name", "Alex", "action_url", "https://example.com/start"
), null, "your-idempotency-key");
var receipt = email.retry(3).send();

Handle errors

Catch the SDK exception to inspect the status and code. Retry delays are in seconds. The example uses the prepared email from the retry example above.

Java

try {
    var receipt = email.retry(3).send();
    System.out.println(receipt.id());
} catch (co.sendery.SenderyException error) {
    System.err.println(error.status() + ": " + error.code());
    // error.errors() contains field-level validation errors.
    // error.retryAfter() is a delay in seconds, when provided.
    throw error;
}

Send a specific version

Choose a published template version to keep sending it after newer versions are published. By default, Sendery uses the latest version.

Java

import java.util.Map;

var receipt = sendery.prepare("[email protected]", "your-template", Map.of(
    "name", "Alex",
    "action_url", "https://example.com/start"
)).version(3).send();

Attachments

Pass a list of Attachment objects with the filename, file bytes, and MIME type. The SDK handles base64 encoding.

Send up to 10 files totaling 5 MB. See the attachment reference for supported formats and limits.

Example

import co.sendery.Attachment;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;

var file = Files.readAllBytes(Path.of("document.pdf"));

sendery.prepare(
    "[email protected]",
    "your-template",
    Map.of("name", "Alex", "action_url", "https://example.com/start"),
    null,
    "your-idempotency-key",
    List.of(new Attachment("document.pdf", file, "application/pdf"))
).retry().send();