Package com.mailersend.sdk.domains

Class Domains

java.lang.Object

com.mailersend.sdk.domains.Domains

public class Domains
extends Object

Domains class.

Version:

$Id: $Id

Author:

mailersend

Constructor Summary

Constructors

Constructor	Description
Domains(MailerSend ref)	Do not initialize directly.

Method Summary

Modifier and Type	Method	Description
DomainAddBuilder	addDomainBuilder()	Get the Add Domain builder
Domains	all()	Return both unverified and verified domains
boolean	deleteDomain(String domainId)	Delete a single domain
Domain	getDomain(String domainId)	Gets a single domain
DomainDnsRecords	getDomainDnsRecords(String domainId)	Gets the DNS records of a domain
ApiRecipientsList	getDomainRecipients(String domainId)	Gets the recipients of a domain
DomainsList	getDomains()	Gets a list of domains
Domains	limit(int limit)	Set the results limit (10 - 100)
Domains	onlyUnverified()	Return only unverified domains
Domains	onlyVerified()	Return only verified domains
Domains	page(int page)	Set the page of the request
DomainSettingsUpdateBuilder	updateDomainSettingsBuilder()	Get the Update Domain Settings builder
DomainVerificationStatus	verifyDomain(String domainId)	Verifies the domain with the given id

Methods inherited from class java.lang.Object

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

Constructor Detail

Domains

public Domains(MailerSend ref)

Do not initialize directly. This should only be accessed from MailerSend.domains

Parameters:

ref - a MailerSend object.

Method Detail

addDomainBuilder

public DomainAddBuilder addDomainBuilder()

Get the Add Domain builder

Returns:

a DomainAddBuilder object.

updateDomainSettingsBuilder

public DomainSettingsUpdateBuilder updateDomainSettingsBuilder()

Get the Update Domain Settings builder

Returns:

a DomainSettingsUpdateBuilder object.

page

public Domains page(int page)

Set the page of the request

Parameters:

page - a int.

Returns:

a Domains object.

limit

public Domains limit(int limit)

Set the results limit (10 - 100)

Parameters:

limit - a int.

Returns:

a Domains object.

onlyVerified

public Domains onlyVerified()

Return only verified domains

Returns:

a Domains object.

onlyUnverified

public Domains onlyUnverified()

Return only unverified domains

Returns:

a Domains object.

all

public Domains all()

Return both unverified and verified domains

Returns:

a Domains object.

getDomains

public DomainsList getDomains()
                       throws MailerSendException

Gets a list of domains

Returns:

a DomainsList object.

Throws:

MailerSendException

getDomain

public Domain getDomain(String domainId)
                 throws MailerSendException

Gets a single domain

Parameters:

domainId - a String object.

Returns:

a Domain object.

Throws:

MailerSendException

deleteDomain

public boolean deleteDomain(String domainId)
                     throws MailerSendException

Delete a single domain

Parameters:

domainId - a String object.

Returns:

a boolean.

Throws:

MailerSendException

getDomainRecipients

public ApiRecipientsList getDomainRecipients(String domainId)
                                      throws MailerSendException

Gets the recipients of a domain

Parameters:

domainId - a String object.

Returns:

a ApiRecipientsList object.

Throws:

MailerSendException

getDomainDnsRecords

public DomainDnsRecords getDomainDnsRecords(String domainId)
                                     throws MailerSendException

Gets the DNS records of a domain

Parameters:

domainId - a String object.

Returns:

a DomainDnsRecords object.

Throws:

MailerSendException

verifyDomain

public DomainVerificationStatus verifyDomain(String domainId)
                                      throws MailerSendException

Verifies the domain with the given id

Parameters:

domainId - a String object.

Returns:

a DomainVerificationStatus object.

Throws:

MailerSendException