Package africa.sendbyte.domains

Class Domains

java.lang.Object

africa.sendbyte.domains.Domains

public final class Domains
extends Object

The Domains resource: register sending domains, fetch their DNS records, and trigger verification.

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

Constructor Summary

Constructors

Constructor	Description
Domains(RequestExecutor executor)

Method Summary

Modifier and Type	Method	Description
Domain	create(String domain)	Register a sending domain and receive the SPF, DKIM, and DMARC records to publish.
CompletableFuture<Domain>	createAsync(String domain)	Asynchronous create(String).
Domain	get(String id)	Fetch a single domain and its verification status by id.
CompletableFuture<Domain>	getAsync(String id)	Asynchronous get(String).
DomainList	list()	List all domains registered on the account.
CompletableFuture<DomainList>	listAsync()	Asynchronous list().
Domain	verify(String id)	Trigger a live DNS check.
CompletableFuture<Domain>	verifyAsync(String id)	Asynchronous verify(String).

Methods inherited from class java.lang.Object

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

Constructor Details

Domains

public Domains(RequestExecutor executor)

Method Details

create

public Domain create(String domain)

Register a sending domain and receive the SPF, DKIM, and DMARC records to publish. Re-registering an existing domain returns the existing record (idempotent).

Parameters:

domain - the bare domain name, e.g. paylink.ng or mail.paylink.ng

createAsync

public CompletableFuture<Domain> createAsync(String domain)

Asynchronous create(String).

get

public Domain get(String id)

Fetch a single domain and its verification status by id.

getAsync

public CompletableFuture<Domain> getAsync(String id)

Asynchronous get(String).

list

public DomainList list()

List all domains registered on the account.

listAsync

public CompletableFuture<DomainList> listAsync()

Asynchronous list().

verify

public Domain verify(String id)

Trigger a live DNS check. When all required records (SPF + DKIM) pass, the returned domain's status flips to DomainStatus.VERIFIED.

verifyAsync

public CompletableFuture<Domain> verifyAsync(String id)

Asynchronous verify(String).