Class ForwardEmailOptions
Options for forwarding an email
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "ForwardEmailOptions")]
public class ForwardEmailOptions : IEquatable<ForwardEmailOptions>, IValidatableObject
Constructors
View SourceForwardEmailOptions()
Initializes a new instance of the ForwardEmailOptions class.
Declaration
[JsonConstructor]
protected ForwardEmailOptions()
ForwardEmailOptions(List<string>, string, List<string>, List<string>, string, bool?, bool?)
Initializes a new instance of the ForwardEmailOptions class.
Declaration
public ForwardEmailOptions(List<string> to = null, string subject = null, List<string> cc = null, List<string> bcc = null, string from = null, bool? useInboxName = null, bool? filterBouncedRecipients = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<T><string> | to | To recipients for forwarded email (required). |
string | subject | Subject for forwarded email. |
System.Collections.Generic.List<T><string> | cc | Optional cc recipients. |
System.Collections.Generic.List<T><string> | bcc | Optional bcc recipients. |
string | from | Optional from override. |
bool? | useInboxName | Optionally use inbox name as display name for sender email address. |
bool? | filterBouncedRecipients | Filter recipients to remove any bounced recipients from to, bcc, and cc before sending. |
Properties
View SourceBcc
Optional bcc recipients
Declaration
[DataMember(Name = "bcc", EmitDefaultValue = true)]
public List<string> Bcc { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T><string> | Optional bcc recipients |
Cc
Optional cc recipients
Declaration
[DataMember(Name = "cc", EmitDefaultValue = true)]
public List<string> Cc { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T><string> | Optional cc recipients |
FilterBouncedRecipients
Filter recipients to remove any bounced recipients from to, bcc, and cc before sending
Declaration
[DataMember(Name = "filterBouncedRecipients", EmitDefaultValue = true)]
public bool? FilterBouncedRecipients { get; set; }
Property Value
Type | Description |
---|---|
bool? | Filter recipients to remove any bounced recipients from to, bcc, and cc before sending |
From
Optional from override
Declaration
[DataMember(Name = "from", EmitDefaultValue = true)]
public string From { get; set; }
Property Value
Type | Description |
---|---|
string | Optional from override |
Subject
Subject for forwarded email
Declaration
[DataMember(Name = "subject", EmitDefaultValue = true)]
public string Subject { get; set; }
Property Value
Type | Description |
---|---|
string | Subject for forwarded email |
To
To recipients for forwarded email
Declaration
[DataMember(Name = "to", IsRequired = true, EmitDefaultValue = true)]
public List<string> To { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T><string> | To recipients for forwarded email |
UseInboxName
Optionally use inbox name as display name for sender email address
Declaration
[DataMember(Name = "useInboxName", EmitDefaultValue = true)]
public bool? UseInboxName { get; set; }
Property Value
Type | Description |
---|---|
bool? | Optionally use inbox name as display name for sender email address |
Methods
View SourceEquals(ForwardEmailOptions)
Returns true if ForwardEmailOptions instances are equal
Declaration
public bool Equals(ForwardEmailOptions input)
Parameters
Type | Name | Description |
---|---|---|
ForwardEmailOptions | input | Instance of ForwardEmailOptions 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
View SourceGetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | Hash code |
Overrides
View SourceToJson()
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
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 |