CreateInboxDto (mailslurp-client-java 15.17.17 API)

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

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
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. Inboxes are either `SMTP` or `HTTP` mailboxes. `SMTP` inboxes are processed by a mail server running at `mailslurp.mx` while `HTTP` inboxes are processed by AWS SES backed mailservers. An inbox email address is randomly assigned by default ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random). To specify an address use a custom domain: either pass the `emailAddress` options with `<your-recipient>@<your-domain>`. To create a randomized address for your domain set the `domainName` to the domain you have verified or pass the `domainId`. Virtual inboxes prevent outbound sending and instead trap mail.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CreateInboxDto.CustomTypeAdapterFactory

static class CreateInboxDto.InboxTypeEnum
Type of inbox.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CreateInboxDto.CustomTypeAdapterFactory`
`static class`	`CreateInboxDto.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_ALLOW_TEAM_ACCESS`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_DOMAIN_ID`
`static String`	`SERIALIZED_NAME_DOMAIN_NAME`
`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_INBOX_TYPE`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_TAGS`
`static String`	`SERIALIZED_NAME_USE_DOMAIN_POOL`
`static String`	`SERIALIZED_NAME_USE_SHORT_ADDRESS`
`static String`	`SERIALIZED_NAME_VIRTUAL_INBOX`

Constructor Summary

Constructors
Constructor and Description

CreateInboxDto()

Constructors
Constructor and Description
`CreateInboxDto()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateInboxDto`	`addTagsItem(String tagsItem)`
`CreateInboxDto`	`allowTeamAccess(Boolean allowTeamAccess)`
`CreateInboxDto`	`description(String description)`
`CreateInboxDto`	`domainId(UUID domainId)`
`CreateInboxDto`	`domainName(String domainName)`
`CreateInboxDto`	`emailAddress(String emailAddress)`
`boolean`	`equals(Object o)`
`CreateInboxDto`	`expiresAt(OffsetDateTime expiresAt)`
`CreateInboxDto`	`expiresIn(Long expiresIn)`
`CreateInboxDto`	`favourite(Boolean favourite)`
`static CreateInboxDto`	`fromJson(String jsonString)` Create an instance of CreateInboxDto given an JSON string
`Boolean`	`getAllowTeamAccess()` DEPRECATED (team access is always true).
`String`	`getDescription()` Optional description of the inbox for labelling purposes.
`UUID`	`getDomainId()` ID of custom domain to use for email address.
`String`	`getDomainName()` FQDN domain name for the domain you have verified.
`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 a favorite.
`CreateInboxDto.InboxTypeEnum`	`getInboxType()` Type of inbox.
`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.
`Boolean`	`getUseShortAddress()` Use a shorter email address under 31 characters
`Boolean`	`getVirtualInbox()` Virtual inbox prevents any outbound emails from being sent.
`int`	`hashCode()`
`CreateInboxDto`	`inboxType(CreateInboxDto.InboxTypeEnum inboxType)`
`CreateInboxDto`	`name(String name)`
`void`	`setAllowTeamAccess(Boolean allowTeamAccess)`
`void`	`setDescription(String description)`
`void`	`setDomainId(UUID domainId)`
`void`	`setDomainName(String domainName)`
`void`	`setEmailAddress(String emailAddress)`
`void`	`setExpiresAt(OffsetDateTime expiresAt)`
`void`	`setExpiresIn(Long expiresIn)`
`void`	`setFavourite(Boolean favourite)`
`void`	`setInboxType(CreateInboxDto.InboxTypeEnum inboxType)`
`void`	`setName(String name)`
`void`	`setTags(List<String> tags)`
`void`	`setUseDomainPool(Boolean useDomainPool)`
`void`	`setUseShortAddress(Boolean useShortAddress)`
`void`	`setVirtualInbox(Boolean virtualInbox)`
`CreateInboxDto`	`tags(List<String> tags)`
`String`	`toJson()` Convert an instance of CreateInboxDto to an JSON string
`String`	`toString()`
`CreateInboxDto`	`useDomainPool(Boolean useDomainPool)`
`CreateInboxDto`	`useShortAddress(Boolean useShortAddress)`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)` Validates the JSON Object and throws an exception if issues found
`CreateInboxDto`	`virtualInbox(Boolean virtualInbox)`

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

- Field Detail
  - SERIALIZED_NAME_EMAIL_ADDRESS
```
public static final String SERIALIZED_NAME_EMAIL_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DOMAIN_NAME
```
public static final String SERIALIZED_NAME_DOMAIN_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_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DESCRIPTION
```
public static final String SERIALIZED_NAME_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USE_DOMAIN_POOL
```
public static final String SERIALIZED_NAME_USE_DOMAIN_POOL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TAGS
```
public static final String SERIALIZED_NAME_TAGS
```
    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_EXPIRES_IN
```
public static final String SERIALIZED_NAME_EXPIRES_IN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ALLOW_TEAM_ACCESS
```
public static final String SERIALIZED_NAME_ALLOW_TEAM_ACCESS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INBOX_TYPE
```
public static final String SERIALIZED_NAME_INBOX_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VIRTUAL_INBOX
```
public static final String SERIALIZED_NAME_VIRTUAL_INBOX
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USE_SHORT_ADDRESS
```
public static final String SERIALIZED_NAME_USE_SHORT_ADDRESS
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - CreateInboxDto
```
public CreateInboxDto()
```
- Method Detail
  - 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. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. 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)
```
  - domainName
```
public CreateInboxDto domainName(String domainName)
```
  - getDomainName
```
@Nullable
public String getDomainName()
```
    FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox.
    
    Returns:
    
    domainName
  - setDomainName
```
public void setDomainName(String domainName)
```
  - domainId
```
public CreateInboxDto domainId(UUID domainId)
```
  - getDomainId
```
@Nullable
public UUID getDomainId()
```
    ID of custom domain to use for email address.
    
    Returns:
    
    domainId
  - setDomainId
```
public void setDomainId(UUID domainId)
```
  - name
```
public CreateInboxDto name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - 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)
```
  - 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. Note this feature is only available for `HTTP` inbox types.
    
    Returns:
    
    useDomainPool
  - setUseDomainPool
```
public void setUseDomainPool(Boolean useDomainPool)
```
  - 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)
```
  - 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)
```
  - favourite
```
public CreateInboxDto favourite(Boolean favourite)
```
  - getFavourite
```
@Nullable
public Boolean getFavourite()
```
    Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
    
    Returns:
    
    favourite
  - setFavourite
```
public void setFavourite(Boolean favourite)
```
  - 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)
```
  - allowTeamAccess
```
public CreateInboxDto allowTeamAccess(Boolean allowTeamAccess)
```
  - getAllowTeamAccess
```
@Nullable
public Boolean getAllowTeamAccess()
```
    DEPRECATED (team access is always true). 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)
```
  - inboxType
```
public CreateInboxDto inboxType(CreateInboxDto.InboxTypeEnum inboxType)
```
  - getInboxType
```
@Nullable
public CreateInboxDto.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(CreateInboxDto.InboxTypeEnum inboxType)
```
  - virtualInbox
```
public CreateInboxDto virtualInbox(Boolean virtualInbox)
```
  - getVirtualInbox
```
@Nullable
public Boolean getVirtualInbox()
```
    Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.
    
    Returns:
    
    virtualInbox
  - setVirtualInbox
```
public void setVirtualInbox(Boolean virtualInbox)
```
  - useShortAddress
```
public CreateInboxDto useShortAddress(Boolean useShortAddress)
```
  - getUseShortAddress
```
@Nullable
public Boolean getUseShortAddress()
```
    Use a shorter email address under 31 characters
    
    Returns:
    
    useShortAddress
  - setUseShortAddress
```
public void setUseShortAddress(Boolean useShortAddress)
```
  - 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 CreateInboxDto
  - fromJson
```
public static CreateInboxDto fromJson(String jsonString)
                               throws IOException
```
    Create an instance of CreateInboxDto given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CreateInboxDto
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to CreateInboxDto
  - toJson
```
public String toJson()
```
    Convert an instance of CreateInboxDto to an JSON string
    
    Returns:
    
    JSON string

Class CreateInboxDto

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_EMAIL_ADDRESS

SERIALIZED_NAME_DOMAIN_NAME

SERIALIZED_NAME_DOMAIN_ID

SERIALIZED_NAME_NAME

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_USE_DOMAIN_POOL

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_EXPIRES_AT

SERIALIZED_NAME_FAVOURITE

SERIALIZED_NAME_EXPIRES_IN

SERIALIZED_NAME_ALLOW_TEAM_ACCESS

SERIALIZED_NAME_INBOX_TYPE

SERIALIZED_NAME_VIRTUAL_INBOX

SERIALIZED_NAME_USE_SHORT_ADDRESS

openapiFields

openapiRequiredFields

Constructor Detail

CreateInboxDto

Method Detail

emailAddress

getEmailAddress

setEmailAddress

domainName

getDomainName

setDomainName

domainId

getDomainId

setDomainId

name

getName

setName

description

getDescription

setDescription

useDomainPool

getUseDomainPool

setUseDomainPool

tags

addTagsItem

getTags

setTags

expiresAt

getExpiresAt

setExpiresAt

favourite

getFavourite

setFavourite

expiresIn

getExpiresIn

setExpiresIn

allowTeamAccess

getAllowTeamAccess

setAllowTeamAccess

inboxType

getInboxType

setInboxType

virtualInbox

getVirtualInbox

setVirtualInbox

useShortAddress

getUseShortAddress

setUseShortAddress

equals

hashCode

toString

validateJsonObject

fromJson

toJson