Email (mailslurp-client-java 15.17.17 API)

java.lang.Object
- com.mailslurp.models.Email

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class Email
extends Object
```
Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body and attachments are written to disk and the fields such as to, from, subject etc are stored in a database. The `body` contains the email content. If you want the original SMTP message see the `getRawEmail` endpoints. The attachments can be fetched using the AttachmentController

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Email.CustomTypeAdapterFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`Email.CustomTypeAdapterFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ANALYSIS`
`static String`	`SERIALIZED_NAME_ATTACHMENTS`
`static String`	`SERIALIZED_NAME_BCC`
`static String`	`SERIALIZED_NAME_BODY`
`static String`	`SERIALIZED_NAME_BODY_EXCERPT`
`static String`	`SERIALIZED_NAME_BODY_M_D5_HASH`
`static String`	`SERIALIZED_NAME_CC`
`static String`	`SERIALIZED_NAME_CHARSET`
`static String`	`SERIALIZED_NAME_CREATED_AT`
`static String`	`SERIALIZED_NAME_DOMAIN_ID`
`static String`	`SERIALIZED_NAME_FROM`
`static String`	`SERIALIZED_NAME_HEADERS`
`static String`	`SERIALIZED_NAME_HEADERS_MAP`
`static String`	`SERIALIZED_NAME_HTML`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_INBOX_ID`
`static String`	`SERIALIZED_NAME_IS_H_T_M_L`
`static String`	`SERIALIZED_NAME_READ`
`static String`	`SERIALIZED_NAME_RECIPIENTS`
`static String`	`SERIALIZED_NAME_REPLY_TO`
`static String`	`SERIALIZED_NAME_SENDER`
`static String`	`SERIALIZED_NAME_SUBJECT`
`static String`	`SERIALIZED_NAME_TEAM_ACCESS`
`static String`	`SERIALIZED_NAME_TO`
`static String`	`SERIALIZED_NAME_UPDATED_AT`
`static String`	`SERIALIZED_NAME_USER_ID`

Constructor Summary

Constructors
Constructor and Description

Email()

Constructors
Constructor and Description
`Email()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Email`	`addAttachmentsItem(String attachmentsItem)`
`Email`	`addBccItem(String bccItem)`
`Email`	`addCcItem(String ccItem)`
`Email`	`addToItem(String toItem)`
`Email`	`analysis(EmailAnalysis analysis)`
`Email`	`attachments(List<String> attachments)`
`Email`	`bcc(List<String> bcc)`
`Email`	`body(String body)`
`Email`	`bodyExcerpt(String bodyExcerpt)`
`Email`	`bodyMD5Hash(String bodyMD5Hash)`
`Email`	`cc(List<String> cc)`
`Email`	`charset(String charset)`
`Email`	`createdAt(OffsetDateTime createdAt)`
`Email`	`domainId(UUID domainId)`
`boolean`	`equals(Object o)`
`Email`	`from(String from)`
`static Email`	`fromJson(String jsonString)` Create an instance of Email given an JSON string
`EmailAnalysis`	`getAnalysis()` Get analysis
`List<String>`	`getAttachments()` List of IDs of attachments found in the email.
`List<String>`	`getBcc()` List of `BCC` recipients email addresses that the email was addressed to.
`String`	`getBody()` The body of the email message as text parsed from the SMTP message body (does not include attachments).
`String`	`getBodyExcerpt()` An excerpt of the body of the email message for quick preview .
`String`	`getBodyMD5Hash()` A hash signature of the email message using MD5.
`List<String>`	`getCc()` List of `CC` recipients email addresses that the email was addressed to.
`String`	`getCharset()` Detected character set of the email body such as UTF-8
`OffsetDateTime`	`getCreatedAt()` When was the email received by MailSlurp
`UUID`	`getDomainId()` ID of the domain that received the email
`String`	`getFrom()` Who the email was sent from.
`Map<String,String>`	`getHeaders()` Deprecated.
`Map<String,List<String>>`	`getHeadersMap()` Multi-value map of SMTP headers attached to email
`Boolean`	`getHtml()` Get html
`UUID`	`getId()` ID of the email entity
`UUID`	`getInboxId()` ID of the inbox that received the email
`Boolean`	`getIsHTML()` Is the email body content type HTML?
`Boolean`	`getRead()` Read flag.
`EmailRecipients`	`getRecipients()` Get recipients
`String`	`getReplyTo()` The `replyTo` field on the received email message
`Sender`	`getSender()` Get sender
`String`	`getSubject()` The subject line of the email message as specified by SMTP subject header
`Boolean`	`getTeamAccess()` Can the email be accessed by organization team members
`List<String>`	`getTo()` List of `To` recipient email addresses that the email was addressed to.
`OffsetDateTime`	`getUpdatedAt()` When was the email last updated
`UUID`	`getUserId()` ID of user that email belongs to
`int`	`hashCode()`
`Email`	`headers(Map<String,String> headers)`
`Email`	`headersMap(Map<String,List<String>> headersMap)`
`Email`	`html(Boolean html)`
`Email`	`id(UUID id)`
`Email`	`inboxId(UUID inboxId)`
`Email`	`isHTML(Boolean isHTML)`
`Email`	`putHeadersItem(String key, String headersItem)`
`Email`	`putHeadersMapItem(String key, List<String> headersMapItem)`
`Email`	`read(Boolean read)`
`Email`	`recipients(EmailRecipients recipients)`
`Email`	`replyTo(String replyTo)`
`Email`	`sender(Sender sender)`
`void`	`setAnalysis(EmailAnalysis analysis)`
`void`	`setAttachments(List<String> attachments)`
`void`	`setBcc(List<String> bcc)`
`void`	`setBody(String body)`
`void`	`setBodyExcerpt(String bodyExcerpt)`
`void`	`setBodyMD5Hash(String bodyMD5Hash)`
`void`	`setCc(List<String> cc)`
`void`	`setCharset(String charset)`
`void`	`setCreatedAt(OffsetDateTime createdAt)`
`void`	`setDomainId(UUID domainId)`
`void`	`setFrom(String from)`
`void`	`setHeaders(Map<String,String> headers)`
`void`	`setHeadersMap(Map<String,List<String>> headersMap)`
`void`	`setHtml(Boolean html)`
`void`	`setId(UUID id)`
`void`	`setInboxId(UUID inboxId)`
`void`	`setIsHTML(Boolean isHTML)`
`void`	`setRead(Boolean read)`
`void`	`setRecipients(EmailRecipients recipients)`
`void`	`setReplyTo(String replyTo)`
`void`	`setSender(Sender sender)`
`void`	`setSubject(String subject)`
`void`	`setTeamAccess(Boolean teamAccess)`
`void`	`setTo(List<String> to)`
`void`	`setUpdatedAt(OffsetDateTime updatedAt)`
`void`	`setUserId(UUID userId)`
`Email`	`subject(String subject)`
`Email`	`teamAccess(Boolean teamAccess)`
`Email`	`to(List<String> to)`
`String`	`toJson()` Convert an instance of Email to an JSON string
`String`	`toString()`
`Email`	`updatedAt(OffsetDateTime updatedAt)`
`Email`	`userId(UUID userId)`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)` Validates the JSON Object and throws an exception if issues found

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_INBOX_ID

public static final String SERIALIZED_NAME_INBOX_ID

See Also:: Constant Field Values

SERIALIZED_NAME_DOMAIN_ID

public static final String SERIALIZED_NAME_DOMAIN_ID

See Also:: Constant Field Values

SERIALIZED_NAME_TO

public static final String SERIALIZED_NAME_TO

See Also:: Constant Field Values

SERIALIZED_NAME_FROM

public static final String SERIALIZED_NAME_FROM

See Also:: Constant Field Values

SERIALIZED_NAME_SENDER

public static final String SERIALIZED_NAME_SENDER

See Also:: Constant Field Values

SERIALIZED_NAME_RECIPIENTS

public static final String SERIALIZED_NAME_RECIPIENTS

See Also:: Constant Field Values

SERIALIZED_NAME_REPLY_TO

public static final String SERIALIZED_NAME_REPLY_TO

See Also:: Constant Field Values

SERIALIZED_NAME_CC

public static final String SERIALIZED_NAME_CC

See Also:: Constant Field Values

SERIALIZED_NAME_BCC

public static final String SERIALIZED_NAME_BCC

See Also:: Constant Field Values

SERIALIZED_NAME_HEADERS

public static final String SERIALIZED_NAME_HEADERS

See Also:: Constant Field Values

SERIALIZED_NAME_HEADERS_MAP

public static final String SERIALIZED_NAME_HEADERS_MAP

See Also:: Constant Field Values

SERIALIZED_NAME_ATTACHMENTS

public static final String SERIALIZED_NAME_ATTACHMENTS

See Also:: Constant Field Values

SERIALIZED_NAME_SUBJECT

public static final String SERIALIZED_NAME_SUBJECT

See Also:: Constant Field Values

SERIALIZED_NAME_BODY

public static final String SERIALIZED_NAME_BODY

See Also:: Constant Field Values

SERIALIZED_NAME_BODY_EXCERPT

public static final String SERIALIZED_NAME_BODY_EXCERPT

See Also:: Constant Field Values

SERIALIZED_NAME_BODY_M_D5_HASH

public static final String SERIALIZED_NAME_BODY_M_D5_HASH

See Also:: Constant Field Values

SERIALIZED_NAME_IS_H_T_M_L

public static final String SERIALIZED_NAME_IS_H_T_M_L

See Also:: Constant Field Values

SERIALIZED_NAME_CHARSET

public static final String SERIALIZED_NAME_CHARSET

See Also:: Constant Field Values

SERIALIZED_NAME_ANALYSIS

public static final String SERIALIZED_NAME_ANALYSIS

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_READ

public static final String SERIALIZED_NAME_READ

See Also:: Constant Field Values

SERIALIZED_NAME_TEAM_ACCESS

public static final String SERIALIZED_NAME_TEAM_ACCESS

See Also:: Constant Field Values

SERIALIZED_NAME_HTML

public static final String SERIALIZED_NAME_HTML

See Also:: Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail
- Email
```
public Email()
```

Method Detail

id
```
public Email id(UUID id)
```

getId
```
@Nonnull
public UUID getId()
```
ID of the email entity

Returns:

id

setId
```
public void setId(UUID id)
```

userId
```
public Email userId(UUID userId)
```

getUserId
```
@Nonnull
public UUID getUserId()
```
ID of user that email belongs to

Returns:

userId

setUserId
```
public void setUserId(UUID userId)
```

inboxId
```
public Email inboxId(UUID inboxId)
```

getInboxId
```
@Nonnull
public UUID getInboxId()
```
ID of the inbox that received the email

Returns:

inboxId

setInboxId
```
public void setInboxId(UUID inboxId)
```

domainId
```
public Email domainId(UUID domainId)
```

getDomainId
```
@Nullable
public UUID getDomainId()
```
ID of the domain that received the email

Returns:

domainId

setDomainId

public void setDomainId(UUID domainId)

to
```
public Email to(List<String> to)
```

addToItem

public Email addToItem(String toItem)

getTo
```
@Nonnull
public List<String> getTo()
```
List of `To` recipient email addresses that the email was addressed to. See recipients object for names.

Returns:

to

setTo
```
public void setTo(List<String> to)
```

from
```
public Email from(String from)
```

getFrom
```
@Nullable
public String getFrom()
```
Who the email was sent from. An email address - see fromName for the sender name.

Returns:

from

setFrom
```
public void setFrom(String from)
```

sender
```
public Email sender(Sender sender)
```

getSender
```
@Nullable
public Sender getSender()
```
Get sender

Returns:

sender

setSender
```
public void setSender(Sender sender)
```

recipients

public Email recipients(EmailRecipients recipients)

getRecipients

@Nullable
public EmailRecipients getRecipients()

Get recipients

Returns:: recipients

setRecipients

public void setRecipients(EmailRecipients recipients)

replyTo
```
public Email replyTo(String replyTo)
```

getReplyTo
```
@Nullable
public String getReplyTo()
```
The `replyTo` field on the received email message

Returns:

replyTo

setReplyTo

public void setReplyTo(String replyTo)

cc
```
public Email cc(List<String> cc)
```

addCcItem

public Email addCcItem(String ccItem)

getCc
```
@Nullable
public List<String> getCc()
```
List of `CC` recipients email addresses that the email was addressed to. See recipients object for names.

Returns:

cc

setCc
```
public void setCc(List<String> cc)
```

bcc
```
public Email bcc(List<String> bcc)
```

addBccItem

public Email addBccItem(String bccItem)

getBcc
```
@Nullable
public List<String> getBcc()
```
List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names.

Returns:

bcc

setBcc
```
public void setBcc(List<String> bcc)
```

headers

public Email headers(Map<String,String> headers)

putHeadersItem

public Email putHeadersItem(String key,
                            String headersItem)

getHeaders
```
@Deprecated
 @Nullable
public Map<String,String> getHeaders()
```
Deprecated.

Collection of SMTP headers attached to email

Returns:

headers

setHeaders

public void setHeaders(Map<String,String> headers)

headersMap

public Email headersMap(Map<String,List<String>> headersMap)

putHeadersMapItem

public Email putHeadersMapItem(String key,
                               List<String> headersMapItem)

getHeadersMap
```
@Nullable
public Map<String,List<String>> getHeadersMap()
```
Multi-value map of SMTP headers attached to email

Returns:

headersMap

setHeadersMap

public void setHeadersMap(Map<String,List<String>> headersMap)

attachments

public Email attachments(List<String> attachments)

addAttachmentsItem

public Email addAttachmentsItem(String attachmentsItem)

getAttachments
```
@Nullable
public List<String> getAttachments()
```
List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.

Returns:

attachments

setAttachments

public void setAttachments(List<String> attachments)

subject
```
public Email subject(String subject)
```

getSubject
```
@Nullable
public String getSubject()
```
The subject line of the email message as specified by SMTP subject header

Returns:

subject

setSubject

public void setSubject(String subject)

body
```
public Email body(String body)
```

getBody
```
@Nullable
public String getBody()
```
The body of the email message as text parsed from the SMTP message body (does not include attachments). Fetch the raw content to access the SMTP message and use the attachments property to access attachments. The body is stored separately to the email entity so the body is not returned in paginated results only in full single email or wait requests.

Returns:

body

setBody
```
public void setBody(String body)
```

bodyExcerpt

public Email bodyExcerpt(String bodyExcerpt)

getBodyExcerpt
```
@Nullable
public String getBodyExcerpt()
```
An excerpt of the body of the email message for quick preview .

Returns:

bodyExcerpt

setBodyExcerpt

public void setBodyExcerpt(String bodyExcerpt)

bodyMD5Hash

public Email bodyMD5Hash(String bodyMD5Hash)

getBodyMD5Hash
```
@Nullable
public String getBodyMD5Hash()
```
A hash signature of the email message using MD5. Useful for comparing emails without fetching full body.

Returns:

bodyMD5Hash

setBodyMD5Hash

public void setBodyMD5Hash(String bodyMD5Hash)

isHTML
```
public Email isHTML(Boolean isHTML)
```

getIsHTML
```
@Nullable
public Boolean getIsHTML()
```
Is the email body content type HTML?

Returns:

isHTML

setIsHTML

public void setIsHTML(Boolean isHTML)

charset
```
public Email charset(String charset)
```

getCharset
```
@Nullable
public String getCharset()
```
Detected character set of the email body such as UTF-8

Returns:

charset

setCharset

public void setCharset(String charset)

analysis

public Email analysis(EmailAnalysis analysis)

getAnalysis

@Nullable
public EmailAnalysis getAnalysis()

Get analysis

Returns:: analysis

setAnalysis

public void setAnalysis(EmailAnalysis analysis)

createdAt

public Email createdAt(OffsetDateTime createdAt)

getCreatedAt
```
@Nonnull
public OffsetDateTime getCreatedAt()
```
When was the email received by MailSlurp

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public Email updatedAt(OffsetDateTime updatedAt)

getUpdatedAt
```
@Nonnull
public OffsetDateTime getUpdatedAt()
```
When was the email last updated

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

read
```
public Email read(Boolean read)
```

getRead
```
@Nonnull
public Boolean getRead()
```
Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.

Returns:

read

setRead
```
public void setRead(Boolean read)
```

teamAccess

public Email teamAccess(Boolean teamAccess)

getTeamAccess
```
@Nonnull
public Boolean getTeamAccess()
```
Can the email be accessed by organization team members

Returns:

teamAccess

setTeamAccess

public void setTeamAccess(Boolean teamAccess)

html
```
public Email html(Boolean html)
```

getHtml
```
@Nullable
public Boolean getHtml()
```
Get html

Returns:

html

setHtml
```
public void setHtml(Boolean html)
```

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 Email

fromJson
```
public static Email fromJson(String jsonString)
                      throws IOException
```
Create an instance of Email given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Email

Throws:

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

toJson
```
public String toJson()
```
Convert an instance of Email to an JSON string

Returns:

JSON string

Class Email

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_USER_ID

SERIALIZED_NAME_INBOX_ID

SERIALIZED_NAME_DOMAIN_ID

SERIALIZED_NAME_TO

SERIALIZED_NAME_FROM

SERIALIZED_NAME_SENDER

SERIALIZED_NAME_RECIPIENTS

SERIALIZED_NAME_REPLY_TO

SERIALIZED_NAME_CC

SERIALIZED_NAME_BCC

SERIALIZED_NAME_HEADERS

SERIALIZED_NAME_HEADERS_MAP

SERIALIZED_NAME_ATTACHMENTS

SERIALIZED_NAME_SUBJECT

SERIALIZED_NAME_BODY

SERIALIZED_NAME_BODY_EXCERPT

SERIALIZED_NAME_BODY_M_D5_HASH

SERIALIZED_NAME_IS_H_T_M_L

SERIALIZED_NAME_CHARSET

SERIALIZED_NAME_ANALYSIS

SERIALIZED_NAME_CREATED_AT

SERIALIZED_NAME_UPDATED_AT

SERIALIZED_NAME_READ

SERIALIZED_NAME_TEAM_ACCESS

SERIALIZED_NAME_HTML

openapiFields

openapiRequiredFields

Constructor Detail

Email

Method Detail

id

getId

setId

userId

getUserId

setUserId

inboxId

getInboxId

setInboxId

domainId

getDomainId

setDomainId

to

addToItem

getTo

setTo

from

getFrom

setFrom

sender

getSender

setSender

recipients

getRecipients

setRecipients

replyTo

getReplyTo

setReplyTo

cc

addCcItem

getCc

setCc

bcc

addBccItem

getBcc

setBcc

headers

putHeadersItem

getHeaders

setHeaders

headersMap

putHeadersMapItem