Class CreateInboxReplierOptions

Options for creating an inbox replier. Repliers can be attached to inboxes and send automated responses when an inbound email matches given criteria.

Inheritance

object

CreateInboxReplierOptions

Implements

IEquatable<CreateInboxReplierOptions>

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

Constructors

View Source

CreateInboxReplierOptions()

Initializes a new instance of the CreateInboxReplierOptions class.

Declaration

[JsonConstructor]
protected CreateInboxReplierOptions()

View Source

CreateInboxReplierOptions(Guid, string, FieldEnum, string, string, string, string, string, bool?, bool?, string, Guid?, Dictionary<string, object>)

Initializes a new instance of the CreateInboxReplierOptions class.

Declaration

public CreateInboxReplierOptions(Guid inboxId = default, string name = null, CreateInboxReplierOptions.FieldEnum field = (CreateInboxReplierOptions.FieldEnum)0, string match = null, string replyTo = null, string subject = null, string from = null, string charset = null, bool? ignoreReplyTo = null, bool? isHTML = null, string body = null, Guid? templateId = null, Dictionary<string, object> templateVariables = null)

Parameters

Type	Name	Description
System.Guid	inboxId	Inbox ID to attach replier to (required).
string	name	Name for replier.
CreateInboxReplierOptions.FieldEnum	field	Field to match against to trigger inbox replier for inbound email (required).
string	match	String or wildcard style match for field specified when evaluating reply rules. Use `*` to match anything. (required).
string	replyTo	Reply-to email address when sending replying.
string	subject	Subject override when replying to email.
string	from	Send email from address.
string	charset	Email reply charset.
bool?	ignoreReplyTo	Ignore sender replyTo when responding. Send directly to the sender if enabled..
bool?	isHTML	Send HTML email.
string	body	Email body for reply.
System.Guid?	templateId	ID of template to use when sending a reply.
Dictionary<string, object>	templateVariables	Template variable values.

Properties

View Source

Body

Email body for reply

Declaration

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

Property Value

Type	Description
string	Email body for reply

View Source

Charset

Email reply charset

Declaration

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

Property Value

Type	Description
string	Email reply charset

View Source

Field

Field to match against to trigger inbox replier for inbound email

Declaration

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

Property Value

Type	Description
CreateInboxReplierOptions.FieldEnum	Field to match against to trigger inbox replier for inbound email

View Source

From

Send email from address

Declaration

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

Property Value

Type	Description
string	Send email from address

View Source

IgnoreReplyTo

Ignore sender replyTo when responding. Send directly to the sender if enabled.

Declaration

[DataMember(Name = "ignoreReplyTo", EmitDefaultValue = true)]
public bool? IgnoreReplyTo { get; set; }

Property Value

Type	Description
bool?	Ignore sender replyTo when responding. Send directly to the sender if enabled.

View Source

InboxId

Inbox ID to attach replier to

Declaration

[DataMember(Name = "inboxId", IsRequired = true, EmitDefaultValue = true)]
public Guid InboxId { get; set; }

Property Value

Type	Description
System.Guid	Inbox ID to attach replier to

View Source

IsHTML

Send HTML email

Declaration

[DataMember(Name = "isHTML", EmitDefaultValue = true)]
public bool? IsHTML { get; set; }

Property Value

Type	Description
bool?	Send HTML email

View Source

Match

String or wildcard style match for field specified when evaluating reply rules. Use * to match anything.

Declaration

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

Property Value

Type	Description
string	String or wildcard style match for field specified when evaluating reply rules. Use `*` to match anything.

View Source

Name

Name for replier

Declaration

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

Property Value

Type	Description
string	Name for replier

View Source

ReplyTo

Reply-to email address when sending replying

Declaration

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

Property Value

Type	Description
string	Reply-to email address when sending replying

View Source

Subject

Subject override when replying to email

Declaration

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

Property Value

Type	Description
string	Subject override when replying to email

View Source

TemplateId

ID of template to use when sending a reply

Declaration

[DataMember(Name = "templateId", EmitDefaultValue = true)]
public Guid? TemplateId { get; set; }

Property Value

Type	Description
System.Guid?	ID of template to use when sending a reply

View Source

TemplateVariables

Template variable values

Declaration

[DataMember(Name = "templateVariables", EmitDefaultValue = true)]
public Dictionary<string, object> TemplateVariables { get; set; }

Property Value

Type	Description
Dictionary<string, object>	Template variable values

Methods

View Source

Equals(CreateInboxReplierOptions)

Returns true if CreateInboxReplierOptions instances are equal

Declaration

public bool Equals(CreateInboxReplierOptions input)

Parameters

Type	Name	Description
CreateInboxReplierOptions	input	Instance of CreateInboxReplierOptions to be compared

Returns

Type	Description
bool	Boolean

View Source

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)

View Source

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hash code

Overrides

Object.GetHashCode()

View Source

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

View Source

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

View Source

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