com.mailslurp.models

Class CreateInboxRulesetOptions

java.lang.Object

com.mailslurp.models.CreateInboxRulesetOptions

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

Options for creating inbox rulesets. Inbox rulesets can be used to block, allow, filter, or forward emails when sending or receiving using the inbox.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateInboxRulesetOptions.ActionEnum Action to be taken when the ruleset matches an email for the given scope.
static class	CreateInboxRulesetOptions.CustomTypeAdapterFactory
static class	CreateInboxRulesetOptions.ScopeEnum What type of emails actions to apply ruleset to.

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ACTION
static String	SERIALIZED_NAME_SCOPE
static String	SERIALIZED_NAME_TARGET

Constructor Summary

Constructors

Constructor and Description
CreateInboxRulesetOptions()

Method Summary

Modifier and Type	Method and Description
CreateInboxRulesetOptions	action(CreateInboxRulesetOptions.ActionEnum action)
boolean	equals(Object o)
static CreateInboxRulesetOptions	fromJson(String jsonString) Create an instance of CreateInboxRulesetOptions given an JSON string
CreateInboxRulesetOptions.ActionEnum	getAction() Action to be taken when the ruleset matches an email for the given scope.
CreateInboxRulesetOptions.ScopeEnum	getScope() What type of emails actions to apply ruleset to.
String	getTarget() Target to match emails with.
int	hashCode()
CreateInboxRulesetOptions	scope(CreateInboxRulesetOptions.ScopeEnum scope)
void	setAction(CreateInboxRulesetOptions.ActionEnum action)
void	setScope(CreateInboxRulesetOptions.ScopeEnum scope)
void	setTarget(String target)
CreateInboxRulesetOptions	target(String target)
String	toJson() Convert an instance of CreateInboxRulesetOptions 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_SCOPE

public static final String SERIALIZED_NAME_SCOPE

See Also:

Constant Field Values

SERIALIZED_NAME_ACTION

public static final String SERIALIZED_NAME_ACTION

See Also:

Constant Field Values

SERIALIZED_NAME_TARGET

public static final String SERIALIZED_NAME_TARGET

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

CreateInboxRulesetOptions

public CreateInboxRulesetOptions()

Method Detail

scope

public CreateInboxRulesetOptions scope(CreateInboxRulesetOptions.ScopeEnum scope)

getScope

@Nonnull
public CreateInboxRulesetOptions.ScopeEnum getScope()

What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively.

Returns:

scope

setScope

public void setScope(CreateInboxRulesetOptions.ScopeEnum scope)

action

public CreateInboxRulesetOptions action(CreateInboxRulesetOptions.ActionEnum action)

getAction

@Nonnull
public CreateInboxRulesetOptions.ActionEnum getAction()

Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action.

Returns:

action

setAction

public void setAction(CreateInboxRulesetOptions.ActionEnum action)

target

public CreateInboxRulesetOptions target(String target)

getTarget

@Nonnull
public String getTarget()

Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`.

Returns:

target

setTarget

public void setTarget(String target)

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 CreateInboxRulesetOptions

fromJson

public static CreateInboxRulesetOptions fromJson(String jsonString)
                                          throws IOException

Create an instance of CreateInboxRulesetOptions given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateInboxRulesetOptions

Throws:

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

toJson

public String toJson()

Convert an instance of CreateInboxRulesetOptions to an JSON string

Returns:

JSON string