ImapClient Properties

The ImapClient type exposes the following members.

Properties
  NameDescription
Public propertyAccessToken
Gets or sets the access token.
(Inherited from EmailClient.)
Public propertyAllowedAuthentication
Gets or sets enumeration of allowed by user authentication types
Public propertyAnnotateSupported
Gets information whether ANNOTATE extension is supported See more: https://tools.ietf.org/html/rfc5257
Public propertyAutoCommit
Indicates, whether commit operation are executed automatically when folder is changed or before connection is closed.
Public propertyChildrenSupported
Gets information whether CHILDREN extension is supported See more: https://tools.ietf.org/html/rfc3348
Public propertyClientCertificates
Contains collection of clients certificates
(Inherited from EmailClient.)
Public propertyClientIdentificationInfo
Gets or sets client identification information See more: https://tools.ietf.org/html/rfc2971
Public propertyCompressSupported
Gets information whether COMPRESS extension is supported See more: https://tools.ietf.org/html/rfc4978
Public propertyCondstoreSupported
Gets information whether CONDSTORE extension is supported See more: https://tools.ietf.org/html/rfc7162
Public propertyConnectionAsgmtMode
Gets or sets value which defines mode of connection allocation in multiple threads environment There are folowing connection types: - Main connection is connection created and disposed together with mail client.It can't be created or disposed manually. - Default connection is connection default for some thread. If default connection exists and ConnectionAsgmtMode allow, all methods of email client executed in this thread will be implicitly use this connection. Only one default connection can be exist per thread. It can be created manually or automatically. It depends on EmailClient.ConnectionAsgmtMode property. These connections can be created manually with EmailClient.CreateConnection(createAsDefaultConnection = true) method. If default connection does not used(depends on connection allocation mode), main connection used implicitly instead of it. - Independent connections are connections that are not linked to threads.They can be created manually and has to be used explicitly as method parameter. These connections can be created manually with EmailClient.CreateConnection() method or EmailClient.CreateConnection(createAsDefaultConnection = false) method. There are folowing connection allocation types: - ConnectionAsgmtType.UseMainOrDefault This mode uses by default in email clients. Email client uses main connection for all operations from multiple threads if default connection hasn't been created, or connection hasnt been passed as method parameter explicitly. Main connection is connection which is created in the same time like email client. User can create default connections for threads with CreateConnection method. If default connection for thread is created, it's used implicitly for all methods of email client which are invoked in this thread. If default connection for thread is not created, main connection is used for all methods of email client which are invoked in this thread. User also can create connections not linked with threads (not default connections) with CreateConnection method. If user wants to use other connections (not main and not default) he has to pass this connection explicitly as parameter of a method which he wants to use. User can additionally create any number of connections. Default connection can be only one per thread. Please note default connections works correctly if user uses Thread objects for multitasking programming. If user uses ConnectionPool or uses Task objects for multitasking programming this mode may lead to wrong behaviour of a programm. To avoid this problem user has to manually dispose default conection (if he uses it) in the end of the code which executes in the thread. - ConnectionAsgmtType.UseMain Email client uses main connection for all operations from multiple threads. Main connection is connection which is created in the same time like email client. User cann't create default connections. User can create connections not linked with threads (not default connections) with CreateConnection method. If user wants to use other connections (not main and not default) he has to pass this connection explicitly as parameter of a method which he wants to use. User can additionally create any number of connections. - ConnectionAsgmtType.UseDefault Email client uses implicitly only default connections for all operations from multiple threads. Main connection is not used in this mode. If default connection hasn't been created for some thread (first invocation of email client method), email client creates default connection implicitly for thread before first operation is executed. User can't create default connections for threads with CreateConnection method because they are created automatically. When default connection for thread is created, it's used implicitly for all methods of email client which are invoked in this thread.read. User also can create connections not linked with threads (not default connections) with CreateConnection method. If user wants to use other connections (not main and not default) he has to pass this connection explicitly as parameter of a method which he wants to use. User can additionally create any number of connections. Default connection can be only one per thread. Please note default connections works correctly if user uses Thread objects for multitasking programming. If user uses ConnectionPool or uses Task objects for multitasking programming this mode may lead to wrong behaviour of a programm. To avoid this problem user has to manually dispose default conection in the end of the code which executes in the thread.
(Inherited from EmailClient.)
Public propertyConnectionCheckupPeriod
Period of connection checking up in milliseconds. Default value is 5 min.
(Inherited from EmailClient.)
Public propertyConnectionsQuantity
Gets or sets quantity of connections in multy-connection mode
(Inherited from EmailClient.)
Public propertyConnectionState
Gets the current state of the connection.
(Inherited from EmailClient.)
Public propertyCurrentConnection
Gets current connection according to ConnectionAsgmtMode option
(Inherited from EmailClient.)
Public propertyCurrentFolder
Gets the current folder
Public propertyStatic memberDefaultFolder
Default folder for ImapClients
Public propertyDefaultPort
Gets default port for client
(Overrides EmailClientDefaultPort.)
Public propertyDelimiter
Gets or sets delimiter of folders hierarhy.
Public propertyEnableLogger
Gets or sets value which allows enable/disable logger
(Inherited from EmailClient.)
Public propertyEnableSupported
Gets information whether ENABLE extension is supported See more: https://tools.ietf.org/html/rfc5161
Public propertyESearchSupported
Gets information whether ESEARCH extension is supported See more: https://tools.ietf.org/html/rfc4731
Public propertyExchangeIdAutomatically
Gets or sets value which indicates whether client should to introduce information about itself to a server automatically. See more: https://tools.ietf.org/html/rfc2971
Public propertyExtendedListSupported
Gets information whether LIST Command Extension is supported See more https://tools.ietf.org/html/rfc5258
Public propertyGmExt1Supported
Defines if Google X-GM-EXT-1 extension is supported
Public propertyGreetingTimeout
Gets or sets the greeting timeout that is used when establishing a connection. Please note, greeting timeout can't be infinite. Email clients may execute enough long operations. To limit the time of operations users have to use Timeout property. Values for this property have to have long intervals to not prevent long-time operations. But in some cases, if EmailClient will use only Timeout property connection establishing may take a long time. For instance, the mail client may use the automatic mode to connection establishing. In this mode, the email client goes through all possible connection parameters until the connection is established. SMTP, IMAP, and POP3 servers in case of correct connection establishing send greeting string to the client. Servers may use implicit or explicit (START TLS) SSL/TLS connection initiation. If connection mode is mismatched (for instance, the server waits for an implicit SSL connection but the client tries to establish a non-secured or explicit SSL connection), the server won't send a greeting string. In this case, the user will wait a long time until the timeout reaches a greeting string, and the client goes to the next connection option. To avoid this problem, the GreetingTimeout property has been introduced. This property allows you to set the timeout for greeting string, and reduce the time of automatic connection establishment.
(Inherited from EmailClient.)
Public propertyHost
Gets or sets the host name.
(Inherited from EmailClient.)
Public propertyIdSupported
Gets information whether ID extension is supported See more: https://tools.ietf.org/html/rfc2971
Public propertyLogFileName
Gets or sets log file name
(Inherited from EmailClient.)
Public propertyMailboxInfo
Gets set of special-use mailboxes See more: http://tools.ietf.org/html/rfc6154 and https://tools.ietf.org/html/rfc8457
Public propertyMoveSupported
Gets information whether MOVE extension is supported See more: https://tools.ietf.org/html/rfc6851
Public propertyNamespaceSupported
Gets information whether NAMESPACE extension is supported See more: https://tools.ietf.org/html/rfc2342
Public propertyPassword
Gets or sets the password. Password limitations are defined by server implementation, which client connects.
(Inherited from EmailClient.)
Public propertyPort
Gets or sets the port.
(Inherited from EmailClient.)
Public propertyProxy
Gets or sets proxy for the client
(Inherited from EmailClient.)
Public propertyQresyncSupported
Gets information whether QRESYNC extension is supported See more: https://tools.ietf.org/html/rfc7162
Public propertyQuotaSupported
Gets information whether quota is supported
Public propertyReadOnly
Gets or sets value which indicates if changes to the permanent state of the mailbox, including per-user state, are permitted.
Public propertySaslIrSupported
Gets information whether SASL Initial Client Response extension is supported See more: https://tools.ietf.org/html/rfc4959
Public propertySecurityOptions
Security mode for a mail client
(Inherited from EmailClient.)
Public propertyServerIdentificationInfo
Gets server identification information See more: https://tools.ietf.org/html/rfc2971
Public propertyServerSupportedCompression
Gets information which compression types are supported by a server. See more: https://tools.ietf.org/html/rfc4978
Public propertySortSupported
Gets information whether Sort command are supported
Public propertySpecialUseSupported
Gets information whether Special-Use Mailboxes is supported See more: https://tools.ietf.org/html/rfc6154
Public propertySupportedAuthentication
Gets enumeration of supported by server authentication types
Public propertySupportedEncryption
Defines the versions of SSL/TLS encryption protocols to be used. PLEASE PAY YOUR ATTENTION, you may set only those versions of protocol, which are supported by .net framework. IF SOME VERSIONS OF PROTOCOL ARE NOT SUPPORTED BY YOUR CURRENT VERSION OF .NET FRAMEWORK, THEY WILL BE IGNORED AND SKIPPED. IT MAY LEAD TO DOWNGRADE TLS SECURITY LEVEL. IN THIS CASE EXCEPTION WON'T BE GENERATED!!! Please, see EncryptionProtocols documentation for more details. Please use SetSupportedEncryptionUnsafe(EncryptionProtocols) method if you want to set the encryption protocols without any compatibility checks. Default value is: Tls | Tls11 | Tls12 | Tls13 (in case if your current version of .net framework supports these versions of TLS)
(Inherited from EmailClient.)
Public propertyThreadAlgorithms
Gets supported thread algorithms
Public propertyThreadSupported
Gets information whether Thread command are supported
Public propertyTimeout
Gets or sets the timeout for mail operations
(Inherited from EmailClient.)
Public propertyTokenProvider
Gets or sets TokenProvider allowing to retrieve access token.
(Inherited from EmailClient.)
Public propertyUidPlusSupported
Gets information whether UIDPLUS extension is supported See more: https://tools.ietf.org/html/rfc4315
Public propertyUnselectSupported
Gets information whether UNSELECT extension is supported See more: https://tools.ietf.org/html/rfc2342
Public propertyUseAuthentication
Indicates whether authentication is used.
(Inherited from EmailClient.)
Public propertyUseDateInLogFileName
Gets or sets value which indicates if date has to be used in log file name.
(Inherited from EmailClient.)
Public propertyUseDefaultCredentials
Gets or sets a Boolean value that controls whether the DefaultCredentials are sent with requests. This option is used with NTLM authentication ONLY!
(Inherited from EmailClient.)
Public propertyUseMultiConnection
Gets or sets value which indicates if client has to use multiple connections for heavy loaded operations. Please note, using of this mode not necessary has to lead to performance increasing.
(Inherited from EmailClient.)
Public propertyUsePipelining
Gets or sets object which indicates whether the pipelining mode is enabled.
(Inherited from EmailClient.)
Public propertyUsername
Gets or sets the username.
(Inherited from EmailClient.)
See Also