InboxDto (mailslurp-client-java 15.17.17 API)

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

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class InboxDto
extends Object
```
Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either `SMTP` or `HTTP` mailboxes. The default, `HTTP` inboxes, use AWS SES to process emails and are best suited as test email accounts and do not support IMAP or POP3. `SMTP` inboxes use a custom mail server at `mx.mailslurp.com` and support SMTP login, IMAP and POP3. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class InboxDto.CustomTypeAdapterFactory

static class InboxDto.InboxTypeEnum
Type of inbox.

Nested Classes
Modifier and Type	Class and Description
`static class`	`InboxDto.CustomTypeAdapterFactory`
`static class`	`InboxDto.InboxTypeEnum` Type of inbox.

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_CREATED_AT`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_DOMAIN_ID`
`static String`	`SERIALIZED_NAME_EMAIL_ADDRESS`
`static String`	`SERIALIZED_NAME_EXPIRES_AT`
`static String`	`SERIALIZED_NAME_FAVOURITE`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_INBOX_TYPE`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_READ_ONLY`
`static String`	`SERIALIZED_NAME_TAGS`
`static String`	`SERIALIZED_NAME_USER_ID`
`static String`	`SERIALIZED_NAME_VIRTUAL_INBOX`

Constructor Summary

Constructors
Constructor and Description

InboxDto()

Constructors
Constructor and Description
`InboxDto()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InboxDto`	`addTagsItem(String tagsItem)`
`InboxDto`	`createdAt(OffsetDateTime createdAt)`
`InboxDto`	`description(String description)`
`InboxDto`	`domainId(UUID domainId)`
`InboxDto`	`emailAddress(String emailAddress)`
`boolean`	`equals(Object o)`
`InboxDto`	`expiresAt(String expiresAt)`
`InboxDto`	`favourite(Boolean favourite)`
`static InboxDto`	`fromJson(String jsonString)` Create an instance of InboxDto given an JSON string
`OffsetDateTime`	`getCreatedAt()` When the inbox was created.
`String`	`getDescription()` Description of an inbox for labelling and searching purposes
`UUID`	`getDomainId()` ID of custom domain used by the inbox if any
`String`	`getEmailAddress()` The inbox's email address.
`String`	`getExpiresAt()` Inbox expiration time.
`Boolean`	`getFavourite()` Is the inbox a favorite inbox.
`UUID`	`getId()` ID of the inbox.
`InboxDto.InboxTypeEnum`	`getInboxType()` Type of inbox.
`String`	`getName()` Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
`Boolean`	`getReadOnly()` Is the inbox readOnly for the caller.
`List<String>`	`getTags()` Tags that inbox has been tagged with.
`UUID`	`getUserId()` ID of user that inbox belongs to
`Boolean`	`getVirtualInbox()` Virtual inbox can receive email but will not send emails to real recipients.
`int`	`hashCode()`
`InboxDto`	`id(UUID id)`
`InboxDto`	`inboxType(InboxDto.InboxTypeEnum inboxType)`
`InboxDto`	`name(String name)`
`InboxDto`	`readOnly(Boolean readOnly)`
`void`	`setCreatedAt(OffsetDateTime createdAt)`
`void`	`setDescription(String description)`
`void`	`setDomainId(UUID domainId)`
`void`	`setEmailAddress(String emailAddress)`
`void`	`setExpiresAt(String expiresAt)`
`void`	`setFavourite(Boolean favourite)`
`void`	`setId(UUID id)`
`void`	`setInboxType(InboxDto.InboxTypeEnum inboxType)`
`void`	`setName(String name)`
`void`	`setReadOnly(Boolean readOnly)`
`void`	`setTags(List<String> tags)`
`void`	`setUserId(UUID userId)`
`void`	`setVirtualInbox(Boolean virtualInbox)`
`InboxDto`	`tags(List<String> tags)`
`String`	`toJson()` Convert an instance of InboxDto to an JSON string
`String`	`toString()`
`InboxDto`	`userId(UUID userId)`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)` Validates the JSON Object and throws an exception if issues found
`InboxDto`	`virtualInbox(Boolean virtualInbox)`

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_CREATED_AT
```
public static final String SERIALIZED_NAME_CREATED_AT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DOMAIN_ID
```
public static final String SERIALIZED_NAME_DOMAIN_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DESCRIPTION
```
public static final String SERIALIZED_NAME_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EMAIL_ADDRESS
```
public static final String SERIALIZED_NAME_EMAIL_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXPIRES_AT
```
public static final String SERIALIZED_NAME_EXPIRES_AT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FAVOURITE
```
public static final String SERIALIZED_NAME_FAVOURITE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TAGS
```
public static final String SERIALIZED_NAME_TAGS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INBOX_TYPE
```
public static final String SERIALIZED_NAME_INBOX_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_READ_ONLY
```
public static final String SERIALIZED_NAME_READ_ONLY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VIRTUAL_INBOX
```
public static final String SERIALIZED_NAME_VIRTUAL_INBOX
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - InboxDto
```
public InboxDto()
```
- Method Detail
  - id
```
public InboxDto id(UUID id)
```
  - getId
```
@Nonnull
public UUID getId()
```
    ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.
    
    Returns:
    
    id
  - setId
```
public void setId(UUID id)
```
  - userId
```
public InboxDto userId(UUID userId)
```
  - getUserId
```
@Nullable
public UUID getUserId()
```
    ID of user that inbox belongs to
    
    Returns:
    
    userId
  - setUserId
```
public void setUserId(UUID userId)
```
  - createdAt
```
public InboxDto createdAt(OffsetDateTime createdAt)
```
  - getCreatedAt
```
@Nonnull
public OffsetDateTime getCreatedAt()
```
    When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
    
    Returns:
    
    createdAt
  - setCreatedAt
```
public void setCreatedAt(OffsetDateTime createdAt)
```
  - name
```
public InboxDto name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - domainId
```
public InboxDto domainId(UUID domainId)
```
  - getDomainId
```
@Nullable
public UUID getDomainId()
```
    ID of custom domain used by the inbox if any
    
    Returns:
    
    domainId
  - setDomainId
```
public void setDomainId(UUID domainId)
```
  - description
```
public InboxDto description(String description)
```
  - getDescription
```
@Nullable
public String getDescription()
```
    Description of an inbox for labelling and searching purposes
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - emailAddress
```
public InboxDto emailAddress(String emailAddress)
```
  - getEmailAddress
```
@Nonnull
public String getEmailAddress()
```
    The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
    
    Returns:
    
    emailAddress
  - setEmailAddress
```
public void setEmailAddress(String emailAddress)
```
  - expiresAt
```
public InboxDto expiresAt(String expiresAt)
```
  - getExpiresAt
```
@Nullable
public String getExpiresAt()
```
    Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
    
    Returns:
    
    expiresAt
  - setExpiresAt
```
public void setExpiresAt(String expiresAt)
```
  - favourite
```
public InboxDto favourite(Boolean favourite)
```
  - getFavourite
```
@Nonnull
public Boolean getFavourite()
```
    Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
    
    Returns:
    
    favourite
  - setFavourite
```
public void setFavourite(Boolean favourite)
```
  - tags
```
public InboxDto tags(List<String> tags)
```
  - addTagsItem
```
public InboxDto addTagsItem(String tagsItem)
```
  - getTags
```
@Nullable
public List<String> getTags()
```
    Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
    
    Returns:
    
    tags
  - setTags
```
public void setTags(List<String> tags)
```
  - inboxType
```
public InboxDto inboxType(InboxDto.InboxTypeEnum inboxType)
```
  - getInboxType
```
@Nullable
public InboxDto.InboxTypeEnum getInboxType()
```
    Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
    
    Returns:
    
    inboxType
  - setInboxType
```
public void setInboxType(InboxDto.InboxTypeEnum inboxType)
```
  - readOnly
```
public InboxDto readOnly(Boolean readOnly)
```
  - getReadOnly
```
@Nonnull
public Boolean getReadOnly()
```
    Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
    
    Returns:
    
    readOnly
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
  - virtualInbox
```
public InboxDto virtualInbox(Boolean virtualInbox)
```
  - getVirtualInbox
```
@Nonnull
public Boolean getVirtualInbox()
```
    Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.
    
    Returns:
    
    virtualInbox
  - setVirtualInbox
```
public void setVirtualInbox(Boolean virtualInbox)
```
  - 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 InboxDto
  - fromJson
```
public static InboxDto fromJson(String jsonString)
                         throws IOException
```
    Create an instance of InboxDto given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of InboxDto
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to InboxDto
  - toJson
```
public String toJson()
```
    Convert an instance of InboxDto to an JSON string
    
    Returns:
    
    JSON string

Class InboxDto

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_CREATED_AT

SERIALIZED_NAME_NAME

SERIALIZED_NAME_DOMAIN_ID

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_EMAIL_ADDRESS

SERIALIZED_NAME_EXPIRES_AT

SERIALIZED_NAME_FAVOURITE

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_INBOX_TYPE

SERIALIZED_NAME_READ_ONLY

SERIALIZED_NAME_VIRTUAL_INBOX

openapiFields

openapiRequiredFields

Constructor Detail

InboxDto

Method Detail

id

getId

setId

userId

getUserId

setUserId

createdAt

getCreatedAt

setCreatedAt

name

getName

setName

domainId

getDomainId

setDomainId

description

getDescription

setDescription

emailAddress

getEmailAddress

setEmailAddress

expiresAt

getExpiresAt

setExpiresAt

favourite

getFavourite

setFavourite

tags

addTagsItem

getTags

setTags

inboxType

getInboxType

setInboxType

readOnly

getReadOnly

setReadOnly

virtualInbox

getVirtualInbox

setVirtualInbox

equals

hashCode

toString

validateJsonObject

fromJson

toJson