```
public final class Inbox

                    
```
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. SMTP inboxes use a custom mail server at mx.mailslurp.com and are best used for public facing email addresses. 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. Inboxes can be private or allow team access. Team access enabled inboxes can be seen by other members of an organization.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`Inbox.InboxType`	Type of inbox - either HTTP (default) or SMTP. HTTP inboxes are great for testing. SMTP inboxes are processed by a custom SMTP mail server and are better for public facing inboxes that receive emails from Gmail and other large providers. If using a custom domain the domain type must match the inbox type. Use an SMTP domain for SMTP inboxes that includes an MX record pointing to `10 mx.mailslurp.com` for inbound messages. Values: hTTPINBOX,sMTPINBOX

Field Summary

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

Constructor Summary

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

Method Summary

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

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

- Constructor Detail
  - Inbox
```
Inbox(OffsetDateTime createdAt, String description, String emailAddress, String expiresAt, Boolean favourite, UUID id, Inbox.InboxType inboxType, String name, Boolean readOnly, List<String> tags, Boolean teamAccess, UUID userId)
```
    Parameters:
    
    createdAt - When the inbox was created.
    
    description - Description of an inbox for labelling and searching purposes
    
    emailAddress - The inbox's email address.
    
    expiresAt - Inbox expiration time.
    
    favourite - Is the inbox a favorite inbox.
    
    id - ID of the inbox.
    
    inboxType - Type of inbox - either HTTP (default) or SMTP.
    
    name - Name of the inbox and used as the sender name when sending emails .
    
    readOnly - Is the inbox readOnly for the caller.
    
    tags - Tags that inbox has been tagged with.
    
    teamAccess - Does inbox permit team access for organization team members.
    
    userId - ID of user that inbox belongs to
- Method Detail
  - getCreatedAt
```
 final OffsetDateTime getCreatedAt()
```
  - getDescription
```
 final String getDescription()
```
  - getEmailAddress
```
 final String getEmailAddress()
```
  - getExpiresAt
```
 final String getExpiresAt()
```
  - getFavourite
```
 final Boolean getFavourite()
```
  - getId
```
 final UUID getId()
```
  - getInboxType
```
 final Inbox.InboxType getInboxType()
```
  - getName
```
 final String getName()
```
  - getReadOnly
```
 final Boolean getReadOnly()
```
  - getTags
```
 final List<String> getTags()
```
  - getTeamAccess
```
 final Boolean getTeamAccess()
```
  - getUserId
```
 final UUID getUserId()
```

Class Inbox

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Inbox

Method Detail

getCreatedAt

getDescription

getEmailAddress

getExpiresAt

getFavourite

getId

getInboxType

getName

getReadOnly

getTags

getTeamAccess

getUserId