com.mailslurp.models

Class DomainDto

java.lang.Object

com.mailslurp.models.DomainDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class DomainDto
extends Object

Domain plus verification records and status

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DomainDto.CustomTypeAdapterFactory
static class	DomainDto.DomainTypeEnum Type of domain.

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_CATCH_ALL_INBOX_ID
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_DKIM_TOKENS
static String	SERIALIZED_NAME_DOMAIN
static String	SERIALIZED_NAME_DOMAIN_NAME_RECORDS
static String	SERIALIZED_NAME_DOMAIN_TYPE
static String	SERIALIZED_NAME_HAS_MISSING_RECORDS
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_IS_VERIFIED
static String	SERIALIZED_NAME_MISSING_RECORDS_MESSAGE
static String	SERIALIZED_NAME_UPDATED_AT
static String	SERIALIZED_NAME_USER_ID
static String	SERIALIZED_NAME_VERIFICATION_TOKEN

Constructor Summary

Constructors

Constructor and Description
DomainDto()

Method Summary

Modifier and Type	Method and Description
DomainDto	addDkimTokensItem(String dkimTokensItem)
DomainDto	addDomainNameRecordsItem(DomainNameRecord domainNameRecordsItem)
DomainDto	catchAllInboxId(UUID catchAllInboxId)
DomainDto	createdAt(OffsetDateTime createdAt)
DomainDto	dkimTokens(List<String> dkimTokens)
DomainDto	domain(String domain)
DomainDto	domainNameRecords(List<DomainNameRecord> domainNameRecords)
DomainDto	domainType(DomainDto.DomainTypeEnum domainType)
boolean	equals(Object o)
static DomainDto	fromJson(String jsonString) Create an instance of DomainDto given an JSON string
UUID	getCatchAllInboxId() The optional catch all inbox that will receive emails sent to the domain that cannot be matched.
OffsetDateTime	getCreatedAt() Get createdAt
List<String>	getDkimTokens() Unique token DKIM tokens
String	getDomain() Custom domain name
List<DomainNameRecord>	getDomainNameRecords() List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.
DomainDto.DomainTypeEnum	getDomainType() Type of domain.
Boolean	getHasMissingRecords() Whether the domain has missing required records.
UUID	getId() Get id
Boolean	getIsVerified() Whether domain has been verified or not.
String	getMissingRecordsMessage() If the domain is missing records then show which pairs are missing.
OffsetDateTime	getUpdatedAt() Get updatedAt
UUID	getUserId() Get userId
String	getVerificationToken() Verification tokens
int	hashCode()
DomainDto	hasMissingRecords(Boolean hasMissingRecords)
DomainDto	id(UUID id)
DomainDto	isVerified(Boolean isVerified)
DomainDto	missingRecordsMessage(String missingRecordsMessage)
void	setCatchAllInboxId(UUID catchAllInboxId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDkimTokens(List<String> dkimTokens)
void	setDomain(String domain)
void	setDomainNameRecords(List<DomainNameRecord> domainNameRecords)
void	setDomainType(DomainDto.DomainTypeEnum domainType)
void	setHasMissingRecords(Boolean hasMissingRecords)
void	setId(UUID id)
void	setIsVerified(Boolean isVerified)
void	setMissingRecordsMessage(String missingRecordsMessage)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setUserId(UUID userId)
void	setVerificationToken(String verificationToken)
String	toJson() Convert an instance of DomainDto to an JSON string
String	toString()
DomainDto	updatedAt(OffsetDateTime updatedAt)
DomainDto	userId(UUID userId)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj) Validates the JSON Object and throws an exception if issues found
DomainDto	verificationToken(String verificationToken)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_USER_ID

public static final String SERIALIZED_NAME_USER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_DOMAIN

public static final String SERIALIZED_NAME_DOMAIN

See Also:

Constant Field Values

SERIALIZED_NAME_VERIFICATION_TOKEN

public static final String SERIALIZED_NAME_VERIFICATION_TOKEN

See Also:

Constant Field Values

SERIALIZED_NAME_DKIM_TOKENS

public static final String SERIALIZED_NAME_DKIM_TOKENS

See Also:

Constant Field Values

SERIALIZED_NAME_MISSING_RECORDS_MESSAGE

public static final String SERIALIZED_NAME_MISSING_RECORDS_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_HAS_MISSING_RECORDS

public static final String SERIALIZED_NAME_HAS_MISSING_RECORDS

See Also:

Constant Field Values

SERIALIZED_NAME_IS_VERIFIED

public static final String SERIALIZED_NAME_IS_VERIFIED

See Also:

Constant Field Values

SERIALIZED_NAME_DOMAIN_NAME_RECORDS

public static final String SERIALIZED_NAME_DOMAIN_NAME_RECORDS

See Also:

Constant Field Values

SERIALIZED_NAME_CATCH_ALL_INBOX_ID

public static final String SERIALIZED_NAME_CATCH_ALL_INBOX_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_DOMAIN_TYPE

public static final String SERIALIZED_NAME_DOMAIN_TYPE

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

DomainDto

public DomainDto()

Method Detail

id

public DomainDto id(UUID id)

getId

@Nonnull
public UUID getId()

Get id

Returns:

id

setId

public void setId(UUID id)

userId

public DomainDto userId(UUID userId)

getUserId

@Nonnull
public UUID getUserId()

Get userId

Returns:

userId

setUserId

public void setUserId(UUID userId)

domain

public DomainDto domain(String domain)

getDomain

@Nonnull
public String getDomain()

Custom domain name

Returns:

domain

setDomain

public void setDomain(String domain)

verificationToken

public DomainDto verificationToken(String verificationToken)

getVerificationToken

@Nonnull
public String getVerificationToken()

Verification tokens

Returns:

verificationToken

setVerificationToken

public void setVerificationToken(String verificationToken)

dkimTokens

public DomainDto dkimTokens(List<String> dkimTokens)

addDkimTokensItem

public DomainDto addDkimTokensItem(String dkimTokensItem)

getDkimTokens

@Nonnull
public List<String> getDkimTokens()

Unique token DKIM tokens

Returns:

dkimTokens

setDkimTokens

public void setDkimTokens(List<String> dkimTokens)

missingRecordsMessage

public DomainDto missingRecordsMessage(String missingRecordsMessage)

getMissingRecordsMessage

@Nullable
public String getMissingRecordsMessage()

If the domain is missing records then show which pairs are missing.

Returns:

missingRecordsMessage

setMissingRecordsMessage

public void setMissingRecordsMessage(String missingRecordsMessage)

hasMissingRecords

public DomainDto hasMissingRecords(Boolean hasMissingRecords)

getHasMissingRecords

@Nonnull
public Boolean getHasMissingRecords()

Whether the domain has missing required records. If true then see the domain in the dashboard app.

Returns:

hasMissingRecords

setHasMissingRecords

public void setHasMissingRecords(Boolean hasMissingRecords)

isVerified

public DomainDto isVerified(Boolean isVerified)

getIsVerified

@Nonnull
public Boolean getIsVerified()

Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.

Returns:

isVerified

setIsVerified

public void setIsVerified(Boolean isVerified)

domainNameRecords

public DomainDto domainNameRecords(List<DomainNameRecord> domainNameRecords)

addDomainNameRecordsItem

public DomainDto addDomainNameRecordsItem(DomainNameRecord domainNameRecordsItem)

getDomainNameRecords

@Nonnull
public List<DomainNameRecord> getDomainNameRecords()

List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.

Returns:

domainNameRecords

setDomainNameRecords

public void setDomainNameRecords(List<DomainNameRecord> domainNameRecords)

catchAllInboxId

public DomainDto catchAllInboxId(UUID catchAllInboxId)

getCatchAllInboxId

@Nullable
public UUID getCatchAllInboxId()

The optional catch all inbox that will receive emails sent to the domain that cannot be matched.

Returns:

catchAllInboxId

setCatchAllInboxId

public void setCatchAllInboxId(UUID catchAllInboxId)

createdAt

public DomainDto createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nonnull
public OffsetDateTime getCreatedAt()

Get createdAt

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public DomainDto updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nonnull
public OffsetDateTime getUpdatedAt()

Get updatedAt

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

domainType

public DomainDto domainType(DomainDto.DomainTypeEnum domainType)

getDomainType

@Nonnull
public DomainDto.DomainTypeEnum getDomainType()

Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.

Returns:

domainType

setDomainType

public void setDomainType(DomainDto.DomainTypeEnum domainType)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to DomainDto

fromJson

public static DomainDto fromJson(String jsonString)
                          throws IOException

Create an instance of DomainDto given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DomainDto

Throws:

IOException - if the JSON string is invalid with respect to DomainDto

toJson

public String toJson()

Convert an instance of DomainDto to an JSON string

Returns:

JSON string