CreateInboxDto (mailslurp-client-java 11.5.20 API)

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

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-04-02T22:56:45.878Z[GMT]")
public class CreateInboxDto
extends Object
```
Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. They can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or if `useDomainPool` is enabled then ending in a similar domains such as `mailslurp.xyz` (selected at random).

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ALLOW_TEAM_ACCESS`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_EMAIL_ADDRESS`
`static String`	`SERIALIZED_NAME_EXPIRES_AT`
`static String`	`SERIALIZED_NAME_EXPIRES_IN`
`static String`	`SERIALIZED_NAME_FAVOURITE`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_TAGS`
`static String`	`SERIALIZED_NAME_USE_DOMAIN_POOL`

Constructor Summary

Constructors
Constructor and Description

CreateInboxDto()

Constructors
Constructor and Description
`CreateInboxDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateInboxDto`	`addTagsItem(String tagsItem)`
`CreateInboxDto`	`allowTeamAccess(Boolean allowTeamAccess)`
`CreateInboxDto`	`description(String description)`
`CreateInboxDto`	`emailAddress(String emailAddress)`
`boolean`	`equals(Object o)`
`CreateInboxDto`	`expiresAt(OffsetDateTime expiresAt)`
`CreateInboxDto`	`expiresIn(Long expiresIn)`
`CreateInboxDto`	`favourite(Boolean favourite)`
`Boolean`	`getAllowTeamAccess()` Grant team access to this inbox and the emails that belong to it for team members of your organization.
`String`	`getDescription()` Optional description of the inbox for labelling purposes.
`String`	`getEmailAddress()` A custom email address to use with the inbox.
`OffsetDateTime`	`getExpiresAt()` Optional inbox expiration date.
`Long`	`getExpiresIn()` Number of milliseconds that inbox should exist for
`Boolean`	`getFavourite()` Is the inbox favorited.
`String`	`getName()` Optional name of the inbox.
`List<String>`	`getTags()` Tags that inbox has been tagged with.
`Boolean`	`getUseDomainPool()` Use the MailSlurp domain name pool with this inbox when creating the email address.
`int`	`hashCode()`
`CreateInboxDto`	`name(String name)`
`void`	`setAllowTeamAccess(Boolean allowTeamAccess)`
`void`	`setDescription(String description)`
`void`	`setEmailAddress(String emailAddress)`
`void`	`setExpiresAt(OffsetDateTime expiresAt)`
`void`	`setExpiresIn(Long expiresIn)`
`void`	`setFavourite(Boolean favourite)`
`void`	`setName(String name)`
`void`	`setTags(List<String> tags)`
`void`	`setUseDomainPool(Boolean useDomainPool)`
`CreateInboxDto`	`tags(List<String> tags)`
`String`	`toString()`
`CreateInboxDto`	`useDomainPool(Boolean useDomainPool)`

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

- Field Detail
  - SERIALIZED_NAME_ALLOW_TEAM_ACCESS
```
public static final String SERIALIZED_NAME_ALLOW_TEAM_ACCESS
```
    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_EXPIRES_IN
```
public static final String SERIALIZED_NAME_EXPIRES_IN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FAVOURITE
```
public static final String SERIALIZED_NAME_FAVOURITE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TAGS
```
public static final String SERIALIZED_NAME_TAGS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USE_DOMAIN_POOL
```
public static final String SERIALIZED_NAME_USE_DOMAIN_POOL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CreateInboxDto
```
public CreateInboxDto()
```
- Method Detail
  - allowTeamAccess
```
public CreateInboxDto allowTeamAccess(Boolean allowTeamAccess)
```
  - getAllowTeamAccess
```
@Nullable
public Boolean getAllowTeamAccess()
```
    Grant team access to this inbox and the emails that belong to it for team members of your organization.
    
    Returns:
    
    allowTeamAccess
  - setAllowTeamAccess
```
public void setAllowTeamAccess(Boolean allowTeamAccess)
```
  - description
```
public CreateInboxDto description(String description)
```
  - getDescription
```
@Nullable
public String getDescription()
```
    Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - emailAddress
```
public CreateInboxDto emailAddress(String emailAddress)
```
  - getEmailAddress
```
@Nullable
public String getEmailAddress()
```
    A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. 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 CreateInboxDto expiresAt(OffsetDateTime expiresAt)
```
  - getExpiresAt
```
@Nullable
public OffsetDateTime getExpiresAt()
```
    Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
    
    Returns:
    
    expiresAt
  - setExpiresAt
```
public void setExpiresAt(OffsetDateTime expiresAt)
```
  - expiresIn
```
public CreateInboxDto expiresIn(Long expiresIn)
```
  - getExpiresIn
```
@Nullable
public Long getExpiresIn()
```
    Number of milliseconds that inbox should exist for
    
    Returns:
    
    expiresIn
  - setExpiresIn
```
public void setExpiresIn(Long expiresIn)
```
  - favourite
```
public CreateInboxDto favourite(Boolean favourite)
```
  - getFavourite
```
@Nullable
public Boolean getFavourite()
```
    Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
    
    Returns:
    
    favourite
  - setFavourite
```
public void setFavourite(Boolean favourite)
```
  - name
```
public CreateInboxDto name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    Optional name of the inbox. Displayed in the dashboard for easier search
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - tags
```
public CreateInboxDto tags(List<String> tags)
```
  - addTagsItem
```
public CreateInboxDto 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)
```
  - useDomainPool
```
public CreateInboxDto useDomainPool(Boolean useDomainPool)
```
  - getUseDomainPool
```
@Nullable
public Boolean getUseDomainPool()
```
    Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field.
    
    Returns:
    
    useDomainPool
  - setUseDomainPool
```
public void setUseDomainPool(Boolean useDomainPool)
```
  - 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 CreateInboxDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ALLOW_TEAM_ACCESS

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_EMAIL_ADDRESS

SERIALIZED_NAME_EXPIRES_AT

SERIALIZED_NAME_EXPIRES_IN

SERIALIZED_NAME_FAVOURITE

SERIALIZED_NAME_NAME

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_USE_DOMAIN_POOL

Constructor Detail

CreateInboxDto

Method Detail

allowTeamAccess

getAllowTeamAccess

setAllowTeamAccess

description

getDescription

setDescription

emailAddress

getEmailAddress

setEmailAddress

expiresAt

getExpiresAt

setExpiresAt

expiresIn

getExpiresIn

setExpiresIn

favourite

getFavourite

setFavourite

name

getName

setName

tags

addTagsItem

getTags

setTags

useDomainPool

getUseDomainPool

setUseDomainPool

equals

hashCode

toString