Package africa.sendbyte.emails

Class Emails

java.lang.Object

africa.sendbyte.emails.Emails

public final class Emails
extends Object

The Emails resource: send transactional emails and read them back.

Obtain an instance via client.emails(). Every method has a blocking form and an ...Async form returning a CompletableFuture.

Constructor Summary

Constructors

Constructor	Description
Emails(RequestExecutor executor)

Method Summary

Modifier and Type	Method	Description
Email	get(String id)	Retrieve a single email by id, including its rendered body and full event timeline.
CompletableFuture<Email>	getAsync(String id)	Asynchronous get(String).
EmailList	list()	List sent emails, newest-first, using default paging.
EmailList	list(ListEmailsParams params)	List sent emails with optional filtering and cursor pagination.
CompletableFuture<EmailList>	listAsync(ListEmailsParams params)	Asynchronous list(ListEmailsParams).
Email	send(SendEmailRequest request)	Send a transactional email.
CompletableFuture<Email>	sendAsync(SendEmailRequest request)	Asynchronous send(SendEmailRequest).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Emails

public Emails(RequestExecutor executor)

Method Details

send

public Email send(SendEmailRequest request)

Send a transactional email.

Returns:

the created Email (initially queued); store Email.getId() to look it up later.

sendAsync

public CompletableFuture<Email> sendAsync(SendEmailRequest request)

Asynchronous send(SendEmailRequest).

get

public Email get(String id)

Retrieve a single email by id, including its rendered body and full event timeline.

getAsync

public CompletableFuture<Email> getAsync(String id)

Asynchronous get(String).

list

public EmailList list()

List sent emails, newest-first, using default paging.

list

public EmailList list(ListEmailsParams params)

List sent emails with optional filtering and cursor pagination.

listAsync

public CompletableFuture<EmailList> listAsync(ListEmailsParams params)

Asynchronous list(ListEmailsParams).