com.mailslurp.models

Class ForwardEmailOptions

java.lang.Object

com.mailslurp.models.ForwardEmailOptions

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

Options for forwarding an email

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ForwardEmailOptions.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_BCC
static String	SERIALIZED_NAME_CC
static String	SERIALIZED_NAME_FILTER_BOUNCED_RECIPIENTS
static String	SERIALIZED_NAME_FROM
static String	SERIALIZED_NAME_SUBJECT
static String	SERIALIZED_NAME_TO
static String	SERIALIZED_NAME_USE_INBOX_NAME

Constructor Summary

Constructors

Constructor and Description
ForwardEmailOptions()

Method Summary

Modifier and Type	Method and Description
ForwardEmailOptions	addBccItem(String bccItem)
ForwardEmailOptions	addCcItem(String ccItem)
ForwardEmailOptions	addToItem(String toItem)
ForwardEmailOptions	bcc(List<String> bcc)
ForwardEmailOptions	cc(List<String> cc)
boolean	equals(Object o)
ForwardEmailOptions	filterBouncedRecipients(Boolean filterBouncedRecipients)
ForwardEmailOptions	from(String from)
static ForwardEmailOptions	fromJson(String jsonString) Create an instance of ForwardEmailOptions given an JSON string
List<String>	getBcc() Optional bcc recipients
List<String>	getCc() Optional cc recipients
Boolean	getFilterBouncedRecipients() Filter recipients to remove any bounced recipients from to, bcc, and cc before sending
String	getFrom() Optional from override
String	getSubject() Subject for forwarded email
List<String>	getTo() To recipients for forwarded email
Boolean	getUseInboxName() Optionally use inbox name as display name for sender email address
int	hashCode()
void	setBcc(List<String> bcc)
void	setCc(List<String> cc)
void	setFilterBouncedRecipients(Boolean filterBouncedRecipients)
void	setFrom(String from)
void	setSubject(String subject)
void	setTo(List<String> to)
void	setUseInboxName(Boolean useInboxName)
ForwardEmailOptions	subject(String subject)
ForwardEmailOptions	to(List<String> to)
String	toJson() Convert an instance of ForwardEmailOptions to an JSON string
String	toString()
ForwardEmailOptions	useInboxName(Boolean useInboxName)
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_TO

public static final String SERIALIZED_NAME_TO

See Also:

Constant Field Values

SERIALIZED_NAME_SUBJECT

public static final String SERIALIZED_NAME_SUBJECT

See Also:

Constant Field Values

SERIALIZED_NAME_CC

public static final String SERIALIZED_NAME_CC

See Also:

Constant Field Values

SERIALIZED_NAME_BCC

public static final String SERIALIZED_NAME_BCC

See Also:

Constant Field Values

SERIALIZED_NAME_FROM

public static final String SERIALIZED_NAME_FROM

See Also:

Constant Field Values

SERIALIZED_NAME_USE_INBOX_NAME

public static final String SERIALIZED_NAME_USE_INBOX_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_FILTER_BOUNCED_RECIPIENTS

public static final String SERIALIZED_NAME_FILTER_BOUNCED_RECIPIENTS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

ForwardEmailOptions

public ForwardEmailOptions()

Method Detail

to

public ForwardEmailOptions to(List<String> to)

addToItem

public ForwardEmailOptions addToItem(String toItem)

getTo

@Nonnull
public List<String> getTo()

To recipients for forwarded email

Returns:

to

setTo

public void setTo(List<String> to)

subject

public ForwardEmailOptions subject(String subject)

getSubject

@Nullable
public String getSubject()

Subject for forwarded email

Returns:

subject

setSubject

public void setSubject(String subject)

cc

public ForwardEmailOptions cc(List<String> cc)

addCcItem

public ForwardEmailOptions addCcItem(String ccItem)

getCc

@Nullable
public List<String> getCc()

Optional cc recipients

Returns:

cc

setCc

public void setCc(List<String> cc)

bcc

public ForwardEmailOptions bcc(List<String> bcc)

addBccItem

public ForwardEmailOptions addBccItem(String bccItem)

getBcc

@Nullable
public List<String> getBcc()

Optional bcc recipients

Returns:

bcc

setBcc

public void setBcc(List<String> bcc)

from

public ForwardEmailOptions from(String from)

getFrom

@Nullable
public String getFrom()

Optional from override

Returns:

from

setFrom

public void setFrom(String from)

useInboxName

public ForwardEmailOptions useInboxName(Boolean useInboxName)

getUseInboxName

@Nullable
public Boolean getUseInboxName()

Optionally use inbox name as display name for sender email address

Returns:

useInboxName

setUseInboxName

public void setUseInboxName(Boolean useInboxName)

filterBouncedRecipients

public ForwardEmailOptions filterBouncedRecipients(Boolean filterBouncedRecipients)

getFilterBouncedRecipients

@Nullable
public Boolean getFilterBouncedRecipients()

Filter recipients to remove any bounced recipients from to, bcc, and cc before sending

Returns:

filterBouncedRecipients

setFilterBouncedRecipients

public void setFilterBouncedRecipients(Boolean filterBouncedRecipients)

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 ForwardEmailOptions

fromJson

public static ForwardEmailOptions fromJson(String jsonString)
                                    throws IOException

Create an instance of ForwardEmailOptions given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ForwardEmailOptions

Throws:

IOException - if the JSON string is invalid with respect to ForwardEmailOptions

toJson

public String toJson()

Convert an instance of ForwardEmailOptions to an JSON string

Returns:

JSON string