Class CreateConnectorImapConnectionOptions
Options for IMAP connection to external email inbox. Allows syncing emails iva IMAP.
Implements
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "CreateConnectorImapConnectionOptions")]
public class CreateConnectorImapConnectionOptions : IEquatable<CreateConnectorImapConnectionOptions>, IValidatableObject
Constructors
View SourceCreateConnectorImapConnectionOptions()
Initializes a new instance of the CreateConnectorImapConnectionOptions class.
Declaration
[JsonConstructor]
protected CreateConnectorImapConnectionOptions()
CreateConnectorImapConnectionOptions(bool?, string, string, string, string, int?, string, bool?)
Initializes a new instance of the CreateConnectorImapConnectionOptions class.
Declaration
public CreateConnectorImapConnectionOptions(bool? imapSsl = null, string imapUsername = null, string imapPassword = null, string selectFolder = null, string searchTerms = null, int? imapPort = null, string imapHost = null, bool? enabled = null)
Parameters
Type | Name | Description |
---|---|---|
bool? | imapSsl | imapSsl. |
string | imapUsername | imapUsername. |
string | imapPassword | imapPassword. |
string | selectFolder | Optional folder to select during IMAP connection. |
string | searchTerms | searchTerms. |
int? | imapPort | IMAP server port. |
string | imapHost | IMAP server host (required). |
bool? | enabled | IMAP server enabled. |
Properties
View SourceEnabled
IMAP server enabled
Declaration
[DataMember(Name = "enabled", EmitDefaultValue = true)]
public bool? Enabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | IMAP server enabled |
ImapHost
IMAP server host
Declaration
[DataMember(Name = "imapHost", IsRequired = true, EmitDefaultValue = true)]
public string ImapHost { get; set; }
Property Value
Type | Description |
---|---|
string | IMAP server host |
ImapPassword
Gets or Sets ImapPassword
Declaration
[DataMember(Name = "imapPassword", EmitDefaultValue = true)]
public string ImapPassword { get; set; }
Property Value
Type | Description |
---|---|
string |
ImapPort
IMAP server port
Declaration
[DataMember(Name = "imapPort", EmitDefaultValue = true)]
public int? ImapPort { get; set; }
Property Value
Type | Description |
---|---|
int? | IMAP server port |
ImapSsl
Gets or Sets ImapSsl
Declaration
[DataMember(Name = "imapSsl", EmitDefaultValue = true)]
public bool? ImapSsl { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ImapUsername
Gets or Sets ImapUsername
Declaration
[DataMember(Name = "imapUsername", EmitDefaultValue = true)]
public string ImapUsername { get; set; }
Property Value
Type | Description |
---|---|
string |
SearchTerms
Gets or Sets SearchTerms
Declaration
[DataMember(Name = "searchTerms", EmitDefaultValue = true)]
public string SearchTerms { get; set; }
Property Value
Type | Description |
---|---|
string |
SelectFolder
Optional folder to select during IMAP connection
Declaration
[DataMember(Name = "selectFolder", EmitDefaultValue = true)]
public string SelectFolder { get; set; }
Property Value
Type | Description |
---|---|
string | Optional folder to select during IMAP connection |
Methods
View SourceEquals(CreateConnectorImapConnectionOptions)
Returns true if CreateConnectorImapConnectionOptions instances are equal
Declaration
public bool Equals(CreateConnectorImapConnectionOptions input)
Parameters
Type | Name | Description |
---|---|---|
CreateConnectorImapConnectionOptions | input | Instance of CreateConnectorImapConnectionOptions 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 |