Class CreateInboxRulesetOptions

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

Inheritance

object

CreateInboxRulesetOptions

Implements

IEquatable<CreateInboxRulesetOptions>

System.ComponentModel.DataAnnotations.IValidatableObject

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "CreateInboxRulesetOptions")]
public class CreateInboxRulesetOptions : IEquatable<CreateInboxRulesetOptions>, IValidatableObject

Constructors

CreateInboxRulesetOptions()

Initializes a new instance of the CreateInboxRulesetOptions class.

Declaration

[JsonConstructor]
protected CreateInboxRulesetOptions()

CreateInboxRulesetOptions(ScopeEnum, ActionEnum, string)

Initializes a new instance of the CreateInboxRulesetOptions class.

Declaration

public CreateInboxRulesetOptions(CreateInboxRulesetOptions.ScopeEnum scope = (CreateInboxRulesetOptions.ScopeEnum)0, CreateInboxRulesetOptions.ActionEnum action = (CreateInboxRulesetOptions.ActionEnum)0, string target = null)

Parameters

Type	Name	Description
CreateInboxRulesetOptions.ScopeEnum	scope	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. (required).
CreateInboxRulesetOptions.ActionEnum	action	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. (required).
string	target	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. (required).

Properties

Action

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.

Declaration

[DataMember(Name = "action", IsRequired = true, EmitDefaultValue = true)]
public CreateInboxRulesetOptions.ActionEnum Action { get; set; }

Property Value

Type	Description
CreateInboxRulesetOptions.ActionEnum	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.

Scope

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.

Declaration

[DataMember(Name = "scope", IsRequired = true, EmitDefaultValue = true)]
public CreateInboxRulesetOptions.ScopeEnum Scope { get; set; }

Property Value

Type	Description
CreateInboxRulesetOptions.ScopeEnum	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.

Target

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.

Declaration

[DataMember(Name = "target", IsRequired = true, EmitDefaultValue = true)]
public string Target { get; set; }

Property Value

Type	Description
string	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.

Methods

Equals(CreateInboxRulesetOptions)

Returns true if CreateInboxRulesetOptions instances are equal

Declaration

public bool Equals(CreateInboxRulesetOptions input)

Parameters

Type	Name	Description
CreateInboxRulesetOptions	input	Instance of CreateInboxRulesetOptions to be compared

Returns

Type	Description
bool	Boolean

Equals(object)

Returns true if objects are equal

Declaration

public override bool Equals(object input)

Parameters

Type	Name	Description
object	input	Object to be compared

Returns

Type	Description
bool	Boolean

Overrides

Object.Equals(Object)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hash code

Overrides

Object.GetHashCode()

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Validate(ValidationContext)

To validate all properties of the instance

Declaration

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)

Parameters

Type	Name	Description
ValidationContext	validationContext	Validation context

Returns

Type	Description
IEnumerable<ValidationResult>	Validation Result

Implements

System.IEquatable<T>

System.ComponentModel.DataAnnotations.IValidatableObject