Class MatchOption

Options for matching emails in an inbox. Each match option object contains a field, should and value property. Together they form logical conditions such as SUBJECT should CONTAIN value.

Inheritance

object

MatchOption

Implements

IValidatableObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "MatchOption")]
public class MatchOption : IValidatableObject

Constructors

MatchOption()

Initializes a new instance of the MatchOption class.

Declaration

[JsonConstructor]
protected MatchOption()

MatchOption(FieldEnum, ShouldEnum, string)

Initializes a new instance of the MatchOption class.

Declaration

public MatchOption(MatchOption.FieldEnum field = (MatchOption.FieldEnum)0, MatchOption.ShouldEnum should = (MatchOption.ShouldEnum)0, string value = null)

Parameters

Type	Name	Description
MatchOption.FieldEnum	field	Fields of an email object that can be used to filter results (required).
MatchOption.ShouldEnum	should	How the value of the email field specified should be compared to the value given in the match options. (required).
string	value	The value you wish to compare with the value of the field specified using the should value passed. For example BODY should CONTAIN a value passed. (required).

Properties

Field

Fields of an email object that can be used to filter results

Declaration

[DataMember(Name = "field", IsRequired = true, EmitDefaultValue = true)]
public MatchOption.FieldEnum Field { get; set; }

Property Value

Type	Description
MatchOption.FieldEnum	Fields of an email object that can be used to filter results

Should

How the value of the email field specified should be compared to the value given in the match options.

Declaration

[DataMember(Name = "should", IsRequired = true, EmitDefaultValue = true)]
public MatchOption.ShouldEnum Should { get; set; }

Property Value

Type	Description
MatchOption.ShouldEnum	How the value of the email field specified should be compared to the value given in the match options.

Value

The value you wish to compare with the value of the field specified using the should value passed. For example BODY should CONTAIN a value passed.

Declaration

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

Property Value

Type	Description
string	The value you wish to compare with the value of the field specified using the should value passed. For example BODY should CONTAIN a value passed.

Methods

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()

Implements

IValidatableObject