OrganizationInboxProjection (mailslurp-client-java 15.17.17 API)

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class OrganizationInboxProjection
extends Object

Organization team inbox

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`OrganizationInboxProjection.CustomTypeAdapterFactory`
`static class`	`OrganizationInboxProjection.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_CREATED_AT`
`static String`	`SERIALIZED_NAME_DOMAIN_ID`
`static String`	`SERIALIZED_NAME_EMAIL_ADDRESS`
`static String`	`SERIALIZED_NAME_FAVOURITE`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_INBOX_TYPE`
`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_VIRTUAL_INBOX`

Constructor Summary

Constructors
Constructor and Description

OrganizationInboxProjection()

Constructors
Constructor and Description
`OrganizationInboxProjection()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OrganizationInboxProjection`	`addTagsItem(String tagsItem)`
`OrganizationInboxProjection`	`createdAt(OffsetDateTime createdAt)`
`OrganizationInboxProjection`	`domainId(UUID domainId)`
`OrganizationInboxProjection`	`emailAddress(String emailAddress)`
`boolean`	`equals(Object o)`
`OrganizationInboxProjection`	`favourite(Boolean favourite)`
`static OrganizationInboxProjection`	`fromJson(String jsonString)` Create an instance of OrganizationInboxProjection given an JSON string
`OffsetDateTime`	`getCreatedAt()` When the inbox was created.
`UUID`	`getDomainId()` ID of custom domain used by the inbox if any
`String`	`getEmailAddress()` The inbox's email address.
`Boolean`	`getFavourite()` Is the inbox a favorite inbox.
`UUID`	`getId()` ID of the inbox.
`OrganizationInboxProjection.InboxTypeEnum`	`getInboxType()` Type of inbox.
`String`	`getName()` Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
`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.
`Boolean`	`getVirtualInbox()` Virtual inbox can receive email but will not send emails to real recipients.
`int`	`hashCode()`
`OrganizationInboxProjection`	`id(UUID id)`
`OrganizationInboxProjection`	`inboxType(OrganizationInboxProjection.InboxTypeEnum inboxType)`
`OrganizationInboxProjection`	`name(String name)`
`OrganizationInboxProjection`	`readOnly(Boolean readOnly)`
`void`	`setCreatedAt(OffsetDateTime createdAt)`
`void`	`setDomainId(UUID domainId)`
`void`	`setEmailAddress(String emailAddress)`
`void`	`setFavourite(Boolean favourite)`
`void`	`setId(UUID id)`
`void`	`setInboxType(OrganizationInboxProjection.InboxTypeEnum inboxType)`
`void`	`setName(String name)`
`void`	`setReadOnly(Boolean readOnly)`
`void`	`setTags(List<String> tags)`
`void`	`setTeamAccess(Boolean teamAccess)`
`void`	`setVirtualInbox(Boolean virtualInbox)`
`OrganizationInboxProjection`	`tags(List<String> tags)`
`OrganizationInboxProjection`	`teamAccess(Boolean teamAccess)`
`String`	`toJson()` Convert an instance of OrganizationInboxProjection to an JSON string
`String`	`toString()`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)` Validates the JSON Object and throws an exception if issues found
`OrganizationInboxProjection`	`virtualInbox(Boolean virtualInbox)`

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

- Field Detail
  - SERIALIZED_NAME_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DOMAIN_ID
```
public static final String SERIALIZED_NAME_DOMAIN_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATED_AT
```
public static final String SERIALIZED_NAME_CREATED_AT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EMAIL_ADDRESS
```
public static final String SERIALIZED_NAME_EMAIL_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FAVOURITE
```
public static final String SERIALIZED_NAME_FAVOURITE
```
    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_INBOX_TYPE
```
public static final String SERIALIZED_NAME_INBOX_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_READ_ONLY
```
public static final String SERIALIZED_NAME_READ_ONLY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VIRTUAL_INBOX
```
public static final String SERIALIZED_NAME_VIRTUAL_INBOX
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - OrganizationInboxProjection
```
public OrganizationInboxProjection()
```
- Method Detail
  - id
```
public OrganizationInboxProjection id(UUID id)
```
  - getId
```
@Nonnull
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)
```
  - domainId
```
public OrganizationInboxProjection domainId(UUID domainId)
```
  - getDomainId
```
@Nullable
public UUID getDomainId()
```
    ID of custom domain used by the inbox if any
    
    Returns:
    
    domainId
  - setDomainId
```
public void setDomainId(UUID domainId)
```
  - createdAt
```
public OrganizationInboxProjection createdAt(OffsetDateTime createdAt)
```
  - getCreatedAt
```
@Nonnull
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)
```
  - name
```
public OrganizationInboxProjection name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - emailAddress
```
public OrganizationInboxProjection 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)
```
  - favourite
```
public OrganizationInboxProjection favourite(Boolean favourite)
```
  - getFavourite
```
@Nonnull
public Boolean getFavourite()
```
    Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
    
    Returns:
    
    favourite
  - setFavourite
```
public void setFavourite(Boolean favourite)
```
  - tags
```
public OrganizationInboxProjection tags(List<String> tags)
```
  - addTagsItem
```
public OrganizationInboxProjection 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 OrganizationInboxProjection teamAccess(Boolean teamAccess)
```
  - getTeamAccess
```
@Nonnull
public Boolean getTeamAccess()
```
    Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/
    
    Returns:
    
    teamAccess
  - setTeamAccess
```
public void setTeamAccess(Boolean teamAccess)
```
  - inboxType
```
public OrganizationInboxProjection inboxType(OrganizationInboxProjection.InboxTypeEnum inboxType)
```
  - getInboxType
```
@Nullable
public OrganizationInboxProjection.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(OrganizationInboxProjection.InboxTypeEnum inboxType)
```
  - readOnly
```
public OrganizationInboxProjection readOnly(Boolean readOnly)
```
  - getReadOnly
```
@Nonnull
public Boolean getReadOnly()
```
    Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
    
    Returns:
    
    readOnly
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
  - virtualInbox
```
public OrganizationInboxProjection virtualInbox(Boolean virtualInbox)
```
  - getVirtualInbox
```
@Nonnull
public Boolean getVirtualInbox()
```
    Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.
    
    Returns:
    
    virtualInbox
  - setVirtualInbox
```
public void setVirtualInbox(Boolean virtualInbox)
```
  - 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 OrganizationInboxProjection
  - fromJson
```
public static OrganizationInboxProjection fromJson(String jsonString)
                                            throws IOException
```
    Create an instance of OrganizationInboxProjection given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of OrganizationInboxProjection
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to OrganizationInboxProjection
  - toJson
```
public String toJson()
```
    Convert an instance of OrganizationInboxProjection to an JSON string
    
    Returns:
    
    JSON string

Class OrganizationInboxProjection

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_DOMAIN_ID

SERIALIZED_NAME_CREATED_AT

SERIALIZED_NAME_NAME

SERIALIZED_NAME_EMAIL_ADDRESS

SERIALIZED_NAME_FAVOURITE

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_TEAM_ACCESS

SERIALIZED_NAME_INBOX_TYPE

SERIALIZED_NAME_READ_ONLY

SERIALIZED_NAME_VIRTUAL_INBOX

openapiFields

openapiRequiredFields

Constructor Detail

OrganizationInboxProjection

Method Detail

id

getId

setId

domainId

getDomainId

setDomainId

createdAt

getCreatedAt

setCreatedAt

name

getName

setName

emailAddress

getEmailAddress

setEmailAddress

favourite

getFavourite

setFavourite

tags

addTagsItem

getTags

setTags

teamAccess

getTeamAccess

setTeamAccess

inboxType

getInboxType

setInboxType

readOnly

getReadOnly

setReadOnly

virtualInbox

getVirtualInbox

setVirtualInbox

equals

hashCode

toString

validateJsonObject

fromJson

toJson