com.mailslurp.models

Class UpdateInboxOptions

java.lang.Object

com.mailslurp.models.UpdateInboxOptions

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

Options for updating inbox properties

Field Summary

Fields

Modifier and Type	Field and Description
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()

Method Summary

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)
String	getDescription() Description of an inbox for labelling and searching purposes
OffsetDateTime	getExpiresAt() Inbox expiration time.
Boolean	getFavourite() Is the inbox favorited.
String	getName() Name of the inbox.
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	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

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_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

Constructor Detail

UpdateInboxOptions

public UpdateInboxOptions()

Method Detail

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)

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 favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering

Returns:

favourite

setFavourite

public void setFavourite(Boolean favourite)

name

public UpdateInboxOptions 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)

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)

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