```
public final class InboxDto

                    
```
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	Description
`public enum`	`InboxDto.InboxType`	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). Values: hTTPINBOX,sMTPINBOX

Field Summary

Fields
Modifier and Type	Field	Description
`private final UUID`	`id`
`private final OffsetDateTime`	`createdAt`
`private final String`	`emailAddress`
`private final Boolean`	`favourite`
`private final Boolean`	`readOnly`
`private final Boolean`	`virtualInbox`
`private final UUID`	`userId`
`private final String`	`name`
`private final UUID`	`domainId`
`private final String`	`description`
`private final String`	`expiresAt`
`private final List<String>`	`tags`
`private final InboxDto.InboxType`	`inboxType`

Constructor Summary

Constructors
Constructor	Description
`InboxDto(UUID id, OffsetDateTime createdAt, String emailAddress, Boolean favourite, Boolean readOnly, Boolean virtualInbox, UUID userId, String name, UUID domainId, String description, String expiresAt, List<String> tags, InboxDto.InboxType inboxType)`

Method Summary

Modifier and Type	Method	Description
`final UUID`	`getId()`
`final OffsetDateTime`	`getCreatedAt()`
`final String`	`getEmailAddress()`
`final Boolean`	`getFavourite()`
`final Boolean`	`getReadOnly()`
`final Boolean`	`getVirtualInbox()`
`final UUID`	`getUserId()`
`final String`	`getName()`
`final UUID`	`getDomainId()`
`final String`	`getDescription()`
`final String`	`getExpiresAt()`
`final List<String>`	`getTags()`
`final InboxDto.InboxType`	`getInboxType()`

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

- Constructor Detail
  - InboxDto
```
InboxDto(UUID id, OffsetDateTime createdAt, String emailAddress, Boolean favourite, Boolean readOnly, Boolean virtualInbox, UUID userId, String name, UUID domainId, String description, String expiresAt, List<String> tags, InboxDto.InboxType inboxType)
```
    Parameters:
    
    id - ID of the inbox.
    
    createdAt - When the inbox was created.
    
    emailAddress - The inbox's email address.
    
    favourite - Is the inbox a favorite inbox.
    
    readOnly - Is the inbox readOnly for the caller.
    
    virtualInbox - Virtual inbox can receive email but will not send emails to real recipients.
    
    userId - ID of user that inbox belongs to
    
    name - Name of the inbox and used as the sender name when sending emails .
    
    domainId - ID of custom domain used by the inbox if any
    
    description - Description of an inbox for labelling and searching purposes
    
    expiresAt - Inbox expiration time.
    
    tags - Tags that inbox has been tagged with.
    
    inboxType - Type of inbox.
- Method Detail
  - getId
```
 final UUID getId()
```
  - getCreatedAt
```
 final OffsetDateTime getCreatedAt()
```
  - getEmailAddress
```
 final String getEmailAddress()
```
  - getFavourite
```
 final Boolean getFavourite()
```
  - getReadOnly
```
 final Boolean getReadOnly()
```
  - getVirtualInbox
```
 final Boolean getVirtualInbox()
```
  - getUserId
```
 final UUID getUserId()
```
  - getName
```
 final String getName()
```
  - getDomainId
```
 final UUID getDomainId()
```
  - getDescription
```
 final String getDescription()
```
  - getExpiresAt
```
 final String getExpiresAt()
```
  - getTags
```
 final List<String> getTags()
```
  - getInboxType
```
 final InboxDto.InboxType getInboxType()
```

Class InboxDto

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InboxDto

Method Detail

getId

getCreatedAt

getEmailAddress

getFavourite

getReadOnly

getVirtualInbox

getUserId

getName

getDomainId

getDescription

getExpiresAt

getTags

getInboxType