Class CreateContactOptions
Options for creating an email contact in address book
Implements
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "CreateContactOptions")]
public class CreateContactOptions : IEquatable<CreateContactOptions>, IValidatableObject
Constructors
View SourceCreateContactOptions(string, string, string, List<string>, List<string>, object, bool?, Guid?, bool?)
Initializes a new instance of the CreateContactOptions class.
Declaration
public CreateContactOptions(string firstName = null, string lastName = null, string company = null, List<string> emailAddresses = null, List<string> tags = null, object metaData = null, bool? optOut = null, Guid? groupId = null, bool? verifyEmailAddresses = null)
Parameters
Type | Name | Description |
---|---|---|
string | firstName | firstName. |
string | lastName | lastName. |
string | company | company. |
System.Collections.Generic.List<T><string> | emailAddresses | Set of email addresses belonging to the contact. |
System.Collections.Generic.List<T><string> | tags | Tags that can be used to search and group contacts. |
object | metaData | metaData. |
bool? | optOut | Has the user explicitly or implicitly opted out of being contacted? If so MailSlurp will ignore them in all actions.. |
System.Guid? | groupId | Group IDs that contact belongs to. |
bool? | verifyEmailAddresses | Whether to validate contact email address exists. |
Properties
View SourceCompany
Gets or Sets Company
Declaration
[DataMember(Name = "company", EmitDefaultValue = true)]
public string Company { get; set; }
Property Value
Type | Description |
---|---|
string |
EmailAddresses
Set of email addresses belonging to the contact
Declaration
[DataMember(Name = "emailAddresses", EmitDefaultValue = true)]
public List<string> EmailAddresses { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T><string> | Set of email addresses belonging to the contact |
FirstName
Gets or Sets FirstName
Declaration
[DataMember(Name = "firstName", EmitDefaultValue = true)]
public string FirstName { get; set; }
Property Value
Type | Description |
---|---|
string |
GroupId
Group IDs that contact belongs to
Declaration
[DataMember(Name = "groupId", EmitDefaultValue = true)]
public Guid? GroupId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid? | Group IDs that contact belongs to |
LastName
Gets or Sets LastName
Declaration
[DataMember(Name = "lastName", EmitDefaultValue = true)]
public string LastName { get; set; }
Property Value
Type | Description |
---|---|
string |
MetaData
Gets or Sets MetaData
Declaration
[DataMember(Name = "metaData", EmitDefaultValue = true)]
public object MetaData { get; set; }
Property Value
Type | Description |
---|---|
object |
OptOut
Has the user explicitly or implicitly opted out of being contacted? If so MailSlurp will ignore them in all actions.
Declaration
[DataMember(Name = "optOut", EmitDefaultValue = true)]
public bool? OptOut { get; set; }
Property Value
Type | Description |
---|---|
bool? | Has the user explicitly or implicitly opted out of being contacted? If so MailSlurp will ignore them in all actions. |
Tags
Tags that can be used to search and group contacts
Declaration
[DataMember(Name = "tags", EmitDefaultValue = true)]
public List<string> Tags { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T><string> | Tags that can be used to search and group contacts |
VerifyEmailAddresses
Whether to validate contact email address exists
Declaration
[DataMember(Name = "verifyEmailAddresses", EmitDefaultValue = true)]
public bool? VerifyEmailAddresses { get; set; }
Property Value
Type | Description |
---|---|
bool? | Whether to validate contact email address exists |
Methods
View SourceEquals(CreateContactOptions)
Returns true if CreateContactOptions instances are equal
Declaration
public bool Equals(CreateContactOptions input)
Parameters
Type | Name | Description |
---|---|---|
CreateContactOptions | input | Instance of CreateContactOptions 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 |