Class DeliverabilitySelectorOptions

How entities are selected for a deliverability test

Inheritance

object

DeliverabilitySelectorOptions

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 = "DeliverabilitySelectorOptions")]
public class DeliverabilitySelectorOptions : IValidatableObject

Constructors

DeliverabilitySelectorOptions()

Initializes a new instance of the DeliverabilitySelectorOptions class.

Declaration

[JsonConstructor]
protected DeliverabilitySelectorOptions()

DeliverabilitySelectorOptions(TypeEnum, string, PhoneCountryEnum?, List<Guid?>, List<Guid?>)

Initializes a new instance of the DeliverabilitySelectorOptions class.

Declaration

public DeliverabilitySelectorOptions(DeliverabilitySelectorOptions.TypeEnum type = (DeliverabilitySelectorOptions.TypeEnum)0, string pattern = null, DeliverabilitySelectorOptions.PhoneCountryEnum? phoneCountry = null, List<Guid?> entityIds = null, List<Guid?> excludeEntityIds = null)

Parameters

Type	Name	Description
DeliverabilitySelectorOptions.TypeEnum	type	Selection mode (required).
string	pattern	Wildcard pattern for PATTERN selection. Supports '*' and '?' wildcards. If no wildcard is present the value is treated as a case-insensitive contains match..
DeliverabilitySelectorOptions.PhoneCountryEnum?	phoneCountry	Optional phone-country filter for PHONE scope selection (e.g. ALL phones in US). Must be null for INBOX scope..
List<Guid?>	entityIds	Explicit entity IDs for EXPLICIT selection.
List<Guid?>	excludeEntityIds	Optional entity IDs to exclude from the resolved selection (applies after ALL/PATTERN/EXPLICIT selection)..

Properties

EntityIds

Explicit entity IDs for EXPLICIT selection

Declaration

[DataMember(Name = "entityIds", EmitDefaultValue = true)]
public List<Guid?> EntityIds { get; set; }

Property Value

Type	Description
List<Guid?>	Explicit entity IDs for EXPLICIT selection

ExcludeEntityIds

Optional entity IDs to exclude from the resolved selection (applies after ALL/PATTERN/EXPLICIT selection).

Declaration

[DataMember(Name = "excludeEntityIds", EmitDefaultValue = true)]
public List<Guid?> ExcludeEntityIds { get; set; }

Property Value

Type	Description
List<Guid?>	Optional entity IDs to exclude from the resolved selection (applies after ALL/PATTERN/EXPLICIT selection).

Pattern

Wildcard pattern for PATTERN selection. Supports '*' and '?' wildcards. If no wildcard is present the value is treated as a case-insensitive contains match.

Declaration

[DataMember(Name = "pattern", EmitDefaultValue = true)]
public string Pattern { get; set; }

Property Value

Type	Description
string	Wildcard pattern for PATTERN selection. Supports '*' and '?' wildcards. If no wildcard is present the value is treated as a case-insensitive contains match.

PhoneCountry

Optional phone-country filter for PHONE scope selection (e.g. ALL phones in US). Must be null for INBOX scope.

Declaration

[DataMember(Name = "phoneCountry", EmitDefaultValue = true)]
public DeliverabilitySelectorOptions.PhoneCountryEnum? PhoneCountry { get; set; }

Property Value

Type	Description
DeliverabilitySelectorOptions.PhoneCountryEnum?	Optional phone-country filter for PHONE scope selection (e.g. ALL phones in US). Must be null for INBOX scope.

Type

Selection mode

Declaration

[DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)]
public DeliverabilitySelectorOptions.TypeEnum Type { get; set; }

Property Value

Type	Description
DeliverabilitySelectorOptions.TypeEnum	Selection mode

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