Inbox (mailslurp-client-java 11.5.20 API)

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-04-02T22:56:45.878Z[GMT]")
public class Inbox
extends Object

Representation of an inbox with an email address. Emails can be sent to or from this email address.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CREATED_AT`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`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_NAME`
`static String`	`SERIALIZED_NAME_READ_ONLY`
`static String`	`SERIALIZED_NAME_TAGS`
`static String`	`SERIALIZED_NAME_TEAM_ACCESS`
`static String`	`SERIALIZED_NAME_USER_ID`

Constructor Summary

Constructors
Constructor and Description

Inbox()

Constructors
Constructor and Description
`Inbox()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Inbox`	`addTagsItem(String tagsItem)`
`Inbox`	`createdAt(OffsetDateTime createdAt)`
`Inbox`	`description(String description)`
`Inbox`	`emailAddress(String emailAddress)`
`boolean`	`equals(Object o)`
`Inbox`	`expiresAt(String expiresAt)`
`Inbox`	`favourite(Boolean favourite)`
`OffsetDateTime`	`getCreatedAt()` When the inbox was created.
`String`	`getDescription()` Description of an inbox for labelling and searching purposes
`String`	`getEmailAddress()` The inbox's email address.
`String`	`getExpiresAt()` Inbox expiration time.
`Boolean`	`getFavourite()` Is the inbox favorited.
`UUID`	`getId()` ID of the inbox.
`String`	`getName()` Name of the inbox.
`Boolean`	`getReadOnly()` Is the inbox readOnly for the caller.
`List<String>`	`getTags()` Tags that inbox has been tagged with.
`Boolean`	`getTeamAccess()` Does inbox permit team access for organization team members.
`UUID`	`getUserId()` ID of user that inbox belongs to
`int`	`hashCode()`
`Inbox`	`id(UUID id)`
`Inbox`	`name(String name)`
`Inbox`	`readOnly(Boolean readOnly)`
`void`	`setCreatedAt(OffsetDateTime createdAt)`
`void`	`setDescription(String description)`
`void`	`setEmailAddress(String emailAddress)`
`void`	`setExpiresAt(String expiresAt)`
`void`	`setFavourite(Boolean favourite)`
`void`	`setId(UUID id)`
`void`	`setName(String name)`
`void`	`setReadOnly(Boolean readOnly)`
`void`	`setTags(List<String> tags)`
`void`	`setTeamAccess(Boolean teamAccess)`
`void`	`setUserId(UUID userId)`
`Inbox`	`tags(List<String> tags)`
`Inbox`	`teamAccess(Boolean teamAccess)`
`String`	`toString()`
`Inbox`	`userId(UUID userId)`

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

- Field Detail
  - SERIALIZED_NAME_CREATED_AT
```
public static final String SERIALIZED_NAME_CREATED_AT
```
    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_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_READ_ONLY
```
public static final String SERIALIZED_NAME_READ_ONLY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TAGS
```
public static final String SERIALIZED_NAME_TAGS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEAM_ACCESS
```
public static final String SERIALIZED_NAME_TEAM_ACCESS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER_ID
```
public static final String SERIALIZED_NAME_USER_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Inbox
```
public Inbox()
```
- Method Detail
  - createdAt
```
public Inbox createdAt(OffsetDateTime createdAt)
```
  - getCreatedAt
```
@Nullable
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)
```
  - description
```
public Inbox 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 Inbox emailAddress(String emailAddress)
```
  - getEmailAddress
```
@Nullable
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 Inbox 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 Inbox 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)
```
  - id
```
public Inbox id(UUID id)
```
  - getId
```
@Nullable
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)
```
  - name
```
public Inbox name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    Name of the inbox. Displayed in the dashboard for easier search
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - readOnly
```
public Inbox readOnly(Boolean readOnly)
```
  - getReadOnly
```
@Nullable
public Boolean getReadOnly()
```
    Is the inbox readOnly for the caller. Read only means can not be deleted or modified.
    
    Returns:
    
    readOnly
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
  - tags
```
public Inbox tags(List<String> tags)
```
  - addTagsItem
```
public Inbox 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)
```
  - teamAccess
```
public Inbox teamAccess(Boolean teamAccess)
```
  - getTeamAccess
```
@Nullable
public Boolean getTeamAccess()
```
    Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it.
    
    Returns:
    
    teamAccess
  - setTeamAccess
```
public void setTeamAccess(Boolean teamAccess)
```
  - userId
```
public Inbox userId(UUID userId)
```
  - getUserId
```
@Nullable
public UUID getUserId()
```
    ID of user that inbox belongs to
    
    Returns:
    
    userId
  - setUserId
```
public void setUserId(UUID userId)
```
  - 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 Inbox

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CREATED_AT

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_EMAIL_ADDRESS

SERIALIZED_NAME_EXPIRES_AT

SERIALIZED_NAME_FAVOURITE

SERIALIZED_NAME_ID

SERIALIZED_NAME_NAME

SERIALIZED_NAME_READ_ONLY

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_TEAM_ACCESS

SERIALIZED_NAME_USER_ID

Constructor Detail

Inbox

Method Detail

createdAt

getCreatedAt

setCreatedAt

description

getDescription

setDescription

emailAddress

getEmailAddress

setEmailAddress

expiresAt

getExpiresAt

setExpiresAt

favourite

getFavourite

setFavourite

id

getId

setId

name

getName

setName

readOnly

getReadOnly

setReadOnly

tags

addTagsItem

getTags

setTags

teamAccess

getTeamAccess

setTeamAccess

userId

getUserId

setUserId

equals

hashCode

toString