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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DomainAddBuilderaddDomainBuilder()Get the Add Domain builderDomainsall()Return both unverified and verified domainsbooleandeleteDomain(String domainId)Delete a single domainDomaingetDomain(String domainId)Gets a single domainDomainDnsRecordsgetDomainDnsRecords(String domainId)Gets the DNS records of a domainApiRecipientsListgetDomainRecipients(String domainId)Gets the recipients of a domainDomainsListgetDomains()Gets a list of domainsDomainslimit(int limit)Set the results limit (10 - 100)DomainsonlyUnverified()Return only unverified domainsDomainsonlyVerified()Return only verified domainsDomainspage(int page)Set the page of the requestDomainSettingsUpdateBuilderupdateDomainSettingsBuilder()Get the Update Domain Settings builderDomainVerificationStatusverifyDomain(String domainId)Verifies the domain with the given id
-
-
-
Constructor Detail
-
Domains
public Domains(MailerSend ref)
Do not initialize directly. This should only be accessed from MailerSend.domains- Parameters:
ref- aMailerSendobject.
-
-
Method Detail
-
addDomainBuilder
public DomainAddBuilder addDomainBuilder()
Get the Add Domain builder- Returns:
- a
DomainAddBuilderobject.
-
updateDomainSettingsBuilder
public DomainSettingsUpdateBuilder updateDomainSettingsBuilder()
Get the Update Domain Settings builder- Returns:
- a
DomainSettingsUpdateBuilderobject.
-
page
public Domains page(int page)
Set the page of the request- Parameters:
page- a int.- Returns:
- a
Domainsobject.
-
limit
public Domains limit(int limit)
Set the results limit (10 - 100)- Parameters:
limit- a int.- Returns:
- a
Domainsobject.
-
onlyUnverified
public Domains onlyUnverified()
Return only unverified domains- Returns:
- a
Domainsobject.
-
getDomains
public DomainsList getDomains() throws MailerSendException
Gets a list of domains- Returns:
- a
DomainsListobject. - Throws:
MailerSendException
-
getDomain
public Domain getDomain(String domainId) throws MailerSendException
Gets a single domain- Parameters:
domainId- aStringobject.- Returns:
- a
Domainobject. - Throws:
MailerSendException
-
deleteDomain
public boolean deleteDomain(String domainId) throws MailerSendException
Delete a single domain- Parameters:
domainId- aStringobject.- Returns:
- a boolean.
- Throws:
MailerSendException
-
getDomainRecipients
public ApiRecipientsList getDomainRecipients(String domainId) throws MailerSendException
Gets the recipients of a domain- Parameters:
domainId- aStringobject.- Returns:
- a
ApiRecipientsListobject. - Throws:
MailerSendException
-
getDomainDnsRecords
public DomainDnsRecords getDomainDnsRecords(String domainId) throws MailerSendException
Gets the DNS records of a domain- Parameters:
domainId- aStringobject.- Returns:
- a
DomainDnsRecordsobject. - Throws:
MailerSendException
-
verifyDomain
public DomainVerificationStatus verifyDomain(String domainId) throws MailerSendException
Verifies the domain with the given id- Parameters:
domainId- aStringobject.- Returns:
- a
DomainVerificationStatusobject. - Throws:
MailerSendException
-
-