UpdateInboxOptions (mailslurp-client-java 15.17.17 API)

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

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

Options for updating inbox properties

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UpdateInboxOptions.CustomTypeAdapterFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`UpdateInboxOptions.CustomTypeAdapterFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_EXPIRES_AT`
`static String`	`SERIALIZED_NAME_FAVOURITE`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_TAGS`

Constructor Summary

Constructors
Constructor and Description

UpdateInboxOptions()

Constructors
Constructor and Description
`UpdateInboxOptions()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateInboxOptions`	`addTagsItem(String tagsItem)`
`UpdateInboxOptions`	`description(String description)`
`boolean`	`equals(Object o)`
`UpdateInboxOptions`	`expiresAt(OffsetDateTime expiresAt)`
`UpdateInboxOptions`	`favourite(Boolean favourite)`
`static UpdateInboxOptions`	`fromJson(String jsonString)` Create an instance of UpdateInboxOptions given an JSON string
`String`	`getDescription()` Description of an inbox for labelling and searching purposes
`OffsetDateTime`	`getExpiresAt()` Inbox expiration time.
`Boolean`	`getFavourite()` Is the inbox a favorite inbox.
`String`	`getName()` Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
`List<String>`	`getTags()` Tags that inbox has been tagged with.
`int`	`hashCode()`
`UpdateInboxOptions`	`name(String name)`
`void`	`setDescription(String description)`
`void`	`setExpiresAt(OffsetDateTime expiresAt)`
`void`	`setFavourite(Boolean favourite)`
`void`	`setName(String name)`
`void`	`setTags(List<String> tags)`
`UpdateInboxOptions`	`tags(List<String> tags)`
`String`	`toJson()` Convert an instance of UpdateInboxOptions 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

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

- Field Detail
  - 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_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
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - UpdateInboxOptions
```
public UpdateInboxOptions()
```
- Method Detail
  - name
```
public UpdateInboxOptions 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)
```
  - description
```
public UpdateInboxOptions 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)
```
  - tags
```
public UpdateInboxOptions tags(List<String> tags)
```
  - addTagsItem
```
public UpdateInboxOptions 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 UpdateInboxOptions expiresAt(OffsetDateTime expiresAt)
```
  - getExpiresAt
```
@Nullable
public OffsetDateTime 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(OffsetDateTime expiresAt)
```
  - favourite
```
public UpdateInboxOptions favourite(Boolean favourite)
```
  - getFavourite
```
@Nullable
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)
```
  - 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 UpdateInboxOptions
  - fromJson
```
public static UpdateInboxOptions fromJson(String jsonString)
                                   throws IOException
```
    Create an instance of UpdateInboxOptions given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of UpdateInboxOptions
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to UpdateInboxOptions
  - toJson
```
public String toJson()
```
    Convert an instance of UpdateInboxOptions to an JSON string
    
    Returns:
    
    JSON string

Class UpdateInboxOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_NAME

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_EXPIRES_AT

SERIALIZED_NAME_FAVOURITE

openapiFields

openapiRequiredFields

Constructor Detail

UpdateInboxOptions

Method Detail

name

getName

setName

description

getDescription

setDescription

tags

addTagsItem

getTags

setTags

expiresAt

getExpiresAt

setExpiresAt

favourite

getFavourite

setFavourite

equals

hashCode

toString

validateJsonObject

fromJson

toJson