Email (mailslurp-client-java 11.5.20 API)

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-04-02T22:56:45.878Z[GMT]")
public class Email
extends Object

Email model (also referred to as EmailDto). Represents an email that was received by an inbox. If you want the original SMTP message see the `getRawEmail` endpoint.

Field Summary

Fields
Modifier and Type	Field and Description
`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_M_D5_HASH`
`static String`	`SERIALIZED_NAME_CC`
`static String`	`SERIALIZED_NAME_CHARSET`
`static String`	`SERIALIZED_NAME_CREATED_AT`
`static String`	`SERIALIZED_NAME_FROM`
`static String`	`SERIALIZED_NAME_HEADERS`
`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_REPLY_TO`
`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 Instance Methods Concrete 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`	`bodyMD5Hash(String bodyMD5Hash)`
`Email`	`cc(List<String> cc)`
`Email`	`charset(String charset)`
`Email`	`createdAt(OffsetDateTime createdAt)`
`boolean`	`equals(Object o)`
`Email`	`from(String from)`
`EmailAnalysis`	`getAnalysis()` Get analysis
`List<String>`	`getAttachments()` List of IDs of attachments found in the email.
`List<String>`	`getBcc()` List of `BCC` recipients email was addressed to
`String`	`getBody()` The body of the email message
`String`	`getBodyMD5Hash()` A hash signature of the email message
`List<String>`	`getCc()` List of `CC` recipients 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
`String`	`getFrom()` Who the email was sent from
`Map<String,String>`	`getHeaders()` Get headers
`UUID`	`getId()` ID of the email
`UUID`	`getInboxId()` ID of the inbox that received the email
`Boolean`	`getIsHTML()` Was HTML sent in the email body
`Boolean`	`getRead()` Has the email been viewed ever.
`String`	`getReplyTo()` The replyTo field on the received email
`String`	`getSubject()` The subject line of the email message
`Boolean`	`getTeamAccess()` Can the email be accessed by organization team members
`List<String>`	`getTo()` List of `To` recipients email was addressed to
`OffsetDateTime`	`getUpdatedAt()` When was the email last updated
`UUID`	`getUserId()` ID of user that email belongs
`int`	`hashCode()`
`Email`	`headers(Map<String,String> headers)`
`Email`	`id(UUID id)`
`Email`	`inboxId(UUID inboxId)`
`Email`	`isHTML(Boolean isHTML)`
`Email`	`putHeadersItem(String key, String headersItem)`
`Email`	`read(Boolean read)`
`Email`	`replyTo(String replyTo)`
`void`	`setAnalysis(EmailAnalysis analysis)`
`void`	`setAttachments(List<String> attachments)`
`void`	`setBcc(List<String> bcc)`
`void`	`setBody(String body)`
`void`	`setBodyMD5Hash(String bodyMD5Hash)`
`void`	`setCc(List<String> cc)`
`void`	`setCharset(String charset)`
`void`	`setCreatedAt(OffsetDateTime createdAt)`
`void`	`setFrom(String from)`
`void`	`setHeaders(Map<String,String> headers)`
`void`	`setId(UUID id)`
`void`	`setInboxId(UUID inboxId)`
`void`	`setIsHTML(Boolean isHTML)`
`void`	`setRead(Boolean read)`
`void`	`setReplyTo(String replyTo)`
`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`	`toString()`
`Email`	`updatedAt(OffsetDateTime updatedAt)`
`Email`	`userId(UUID userId)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ANALYSIS

public static final String SERIALIZED_NAME_ANALYSIS

See Also:: Constant Field Values

SERIALIZED_NAME_ATTACHMENTS

public static final String SERIALIZED_NAME_ATTACHMENTS

See Also:: Constant Field Values

SERIALIZED_NAME_BCC

public static final String SERIALIZED_NAME_BCC

See Also:: Constant Field Values

SERIALIZED_NAME_BODY

public static final String SERIALIZED_NAME_BODY

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_CC

public static final String SERIALIZED_NAME_CC

See Also:: Constant Field Values

SERIALIZED_NAME_CHARSET

public static final String SERIALIZED_NAME_CHARSET

See Also:: Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:: Constant Field Values

SERIALIZED_NAME_FROM

public static final String SERIALIZED_NAME_FROM

See Also:: Constant Field Values

SERIALIZED_NAME_HEADERS

public static final String SERIALIZED_NAME_HEADERS

See Also:: Constant Field Values

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_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_IS_H_T_M_L

public static final String SERIALIZED_NAME_IS_H_T_M_L

See Also:: Constant Field Values

SERIALIZED_NAME_READ

public static final String SERIALIZED_NAME_READ

See Also:: Constant Field Values

SERIALIZED_NAME_REPLY_TO

public static final String SERIALIZED_NAME_REPLY_TO

See Also:: Constant Field Values

SERIALIZED_NAME_SUBJECT

public static final String SERIALIZED_NAME_SUBJECT

See Also:: Constant Field Values

SERIALIZED_NAME_TEAM_ACCESS

public static final String SERIALIZED_NAME_TEAM_ACCESS

See Also:: Constant Field Values

SERIALIZED_NAME_TO

public static final String SERIALIZED_NAME_TO

See Also:: Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:: Constant Field Values

SERIALIZED_NAME_USER_ID

public static final String SERIALIZED_NAME_USER_ID

See Also:: Constant Field Values

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

Method Detail

analysis

public Email analysis(EmailAnalysis analysis)

getAnalysis

@Nullable
public EmailAnalysis getAnalysis()

Get analysis

Returns:: analysis

setAnalysis

public void setAnalysis(EmailAnalysis analysis)

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)

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

addBccItem

public Email addBccItem(String bccItem)

getBcc
```
@Nullable
public List<String> getBcc()
```
List of `BCC` recipients email was addressed to

Returns:

bcc

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

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

getBody
```
@Nullable
public String getBody()
```
The body of the email message

Returns:

body

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

bodyMD5Hash

public Email bodyMD5Hash(String bodyMD5Hash)

getBodyMD5Hash
```
@Nullable
public String getBodyMD5Hash()
```
A hash signature of the email message

Returns:

bodyMD5Hash

setBodyMD5Hash

public void setBodyMD5Hash(String bodyMD5Hash)

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

addCcItem

public Email addCcItem(String ccItem)

getCc
```
@Nullable
public List<String> getCc()
```
List of `CC` recipients email was addressed to

Returns:

cc

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

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)

createdAt

public Email createdAt(OffsetDateTime createdAt)

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

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

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

getFrom
```
@Nullable
public String getFrom()
```
Who the email was sent from

Returns:

from

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

headers

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

putHeadersItem

public Email putHeadersItem(String key,
                            String headersItem)

getHeaders

@Nullable
public Map<String,String> getHeaders()

Get headers

Returns:: headers

setHeaders

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

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

getId
```
@Nullable
public UUID getId()
```
ID of the email

Returns:

id

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

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

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

Returns:

inboxId

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

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

getIsHTML
```
@Nullable
public Boolean getIsHTML()
```
Was HTML sent in the email body

Returns:

isHTML

setIsHTML

public void setIsHTML(Boolean isHTML)

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

getRead
```
@Nullable
public Boolean getRead()
```
Has the email been viewed ever. This means viewed in the dashboard or requested via the full email entity endpoints

Returns:

read

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

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

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

Returns:

replyTo

setReplyTo

public void setReplyTo(String replyTo)

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

getSubject
```
@Nullable
public String getSubject()
```
The subject line of the email message

Returns:

subject

setSubject

public void setSubject(String subject)

teamAccess

public Email teamAccess(Boolean teamAccess)

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

Returns:

teamAccess

setTeamAccess

public void setTeamAccess(Boolean teamAccess)

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

addToItem

public Email addToItem(String toItem)

getTo
```
@Nullable
public List<String> getTo()
```
List of `To` recipients email was addressed to

Returns:

to

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

updatedAt

public Email updatedAt(OffsetDateTime updatedAt)

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

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

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

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

Returns:

userId

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

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

Class Email

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ANALYSIS

SERIALIZED_NAME_ATTACHMENTS

SERIALIZED_NAME_BCC

SERIALIZED_NAME_BODY

SERIALIZED_NAME_BODY_M_D5_HASH

SERIALIZED_NAME_CC

SERIALIZED_NAME_CHARSET

SERIALIZED_NAME_CREATED_AT

SERIALIZED_NAME_FROM

SERIALIZED_NAME_HEADERS

SERIALIZED_NAME_ID

SERIALIZED_NAME_INBOX_ID

SERIALIZED_NAME_IS_H_T_M_L

SERIALIZED_NAME_READ

SERIALIZED_NAME_REPLY_TO

SERIALIZED_NAME_SUBJECT

SERIALIZED_NAME_TEAM_ACCESS

SERIALIZED_NAME_TO

SERIALIZED_NAME_UPDATED_AT

SERIALIZED_NAME_USER_ID

Constructor Detail

Email

Method Detail

analysis

getAnalysis

setAnalysis

attachments

addAttachmentsItem

getAttachments

setAttachments

bcc

addBccItem

getBcc

setBcc

body

getBody

setBody

bodyMD5Hash

getBodyMD5Hash

setBodyMD5Hash

cc

addCcItem

getCc

setCc

charset

getCharset

setCharset

createdAt

getCreatedAt

setCreatedAt

from

getFrom

setFrom

headers

putHeadersItem

getHeaders

setHeaders

id

getId

setId

inboxId

getInboxId

setInboxId

isHTML

getIsHTML

setIsHTML

read

getRead

setRead

replyTo

getReplyTo

setReplyTo

subject

getSubject