EmailPreview (mailslurp-client-java 15.17.17 API)

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

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

Preview of an email message. For full message (including body and attachments) call the `getEmail` or other email endpoints with the provided email ID.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EmailPreview.CustomTypeAdapterFactory

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

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ATTACHMENTS`
`static String`	`SERIALIZED_NAME_BCC`
`static String`	`SERIALIZED_NAME_CC`
`static String`	`SERIALIZED_NAME_CREATED_AT`
`static String`	`SERIALIZED_NAME_DOMAIN_ID`
`static String`	`SERIALIZED_NAME_FROM`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_READ`
`static String`	`SERIALIZED_NAME_SUBJECT`
`static String`	`SERIALIZED_NAME_TO`

Constructor Summary

Constructors
Constructor and Description

EmailPreview()

Constructors
Constructor and Description
`EmailPreview()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EmailPreview`	`addAttachmentsItem(String attachmentsItem)`
`EmailPreview`	`addBccItem(String bccItem)`
`EmailPreview`	`addCcItem(String ccItem)`
`EmailPreview`	`addToItem(String toItem)`
`EmailPreview`	`attachments(List<String> attachments)`
`EmailPreview`	`bcc(List<String> bcc)`
`EmailPreview`	`cc(List<String> cc)`
`EmailPreview`	`createdAt(OffsetDateTime createdAt)`
`EmailPreview`	`domainId(UUID domainId)`
`boolean`	`equals(Object o)`
`EmailPreview`	`from(String from)`
`static EmailPreview`	`fromJson(String jsonString)` Create an instance of EmailPreview given an JSON string
`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.
`List<String>`	`getCc()` List of `CC` recipients email addresses that the email was addressed to.
`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.
`UUID`	`getId()` ID of the email entity
`Boolean`	`getRead()` Read flag.
`String`	`getSubject()` The subject line of the email message as specified by SMTP subject header
`List<String>`	`getTo()` List of `To` recipient email addresses that the email was addressed to.
`int`	`hashCode()`
`EmailPreview`	`id(UUID id)`
`EmailPreview`	`read(Boolean read)`
`void`	`setAttachments(List<String> attachments)`
`void`	`setBcc(List<String> bcc)`
`void`	`setCc(List<String> cc)`
`void`	`setCreatedAt(OffsetDateTime createdAt)`
`void`	`setDomainId(UUID domainId)`
`void`	`setFrom(String from)`
`void`	`setId(UUID id)`
`void`	`setRead(Boolean read)`
`void`	`setSubject(String subject)`
`void`	`setTo(List<String> to)`
`EmailPreview`	`subject(String subject)`
`EmailPreview`	`to(List<String> to)`
`String`	`toJson()` Convert an instance of EmailPreview to an JSON string
`String`	`toString()`
`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_DOMAIN_ID
```
public static final String SERIALIZED_NAME_DOMAIN_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUBJECT
```
public static final String SERIALIZED_NAME_SUBJECT
```
    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_BCC
```
public static final String SERIALIZED_NAME_BCC
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CC
```
public static final String SERIALIZED_NAME_CC
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATED_AT
```
public static final String SERIALIZED_NAME_CREATED_AT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_READ
```
public static final String SERIALIZED_NAME_READ
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ATTACHMENTS
```
public static final String SERIALIZED_NAME_ATTACHMENTS
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - EmailPreview
```
public EmailPreview()
```
- Method Detail
  - id
```
public EmailPreview id(UUID id)
```
  - getId
```
@Nonnull
public UUID getId()
```
    ID of the email entity
    
    Returns:
    
    id
  - setId
```
public void setId(UUID id)
```
  - domainId
```
public EmailPreview domainId(UUID domainId)
```
  - getDomainId
```
@Nullable
public UUID getDomainId()
```
    ID of the domain that received the email
    
    Returns:
    
    domainId
  - setDomainId
```
public void setDomainId(UUID domainId)
```
  - subject
```
public EmailPreview 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)
```
  - to
```
public EmailPreview to(List<String> to)
```
  - addToItem
```
public EmailPreview addToItem(String toItem)
```
  - getTo
```
@Nullable
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 EmailPreview 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)
```
  - bcc
```
public EmailPreview bcc(List<String> bcc)
```
  - addBccItem
```
public EmailPreview 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)
```
  - cc
```
public EmailPreview cc(List<String> cc)
```
  - addCcItem
```
public EmailPreview 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)
```
  - createdAt
```
public EmailPreview createdAt(OffsetDateTime createdAt)
```
  - getCreatedAt
```
@Nonnull
public OffsetDateTime getCreatedAt()
```
    When was the email received by MailSlurp
    
    Returns:
    
    createdAt
  - setCreatedAt
```
public void setCreatedAt(OffsetDateTime createdAt)
```
  - read
```
public EmailPreview 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)
```
  - attachments
```
public EmailPreview attachments(List<String> attachments)
```
  - addAttachmentsItem
```
public EmailPreview 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)
```
  - 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 EmailPreview
  - fromJson
```
public static EmailPreview fromJson(String jsonString)
                             throws IOException
```
    Create an instance of EmailPreview given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of EmailPreview
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to EmailPreview
  - toJson
```
public String toJson()
```
    Convert an instance of EmailPreview to an JSON string
    
    Returns:
    
    JSON string

Class EmailPreview

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_DOMAIN_ID

SERIALIZED_NAME_SUBJECT

SERIALIZED_NAME_TO

SERIALIZED_NAME_FROM

SERIALIZED_NAME_BCC

SERIALIZED_NAME_CC

SERIALIZED_NAME_CREATED_AT

SERIALIZED_NAME_READ

SERIALIZED_NAME_ATTACHMENTS

openapiFields

openapiRequiredFields

Constructor Detail

EmailPreview

Method Detail

id

getId

setId

domainId

getDomainId

setDomainId

subject

getSubject

setSubject

to

addToItem

getTo

setTo

from

getFrom

setFrom

bcc

addBccItem

getBcc

setBcc

cc

addCcItem

getCc

setCc

createdAt

getCreatedAt

setCreatedAt

read

getRead

setRead

attachments

addAttachmentsItem

getAttachments

setAttachments

equals

hashCode

toString

validateJsonObject

fromJson

toJson