IMAPClient Component
Properties Methods Events Config Settings Errors
The IMAPClient component provides client-side functionality for IMAP4 (Internet Message Access Protocol).
Syntax
nsoftware.SecureBlackbox.Imapclient
Remarks
Use this component to manage E-mail and retrieve E-mail messages from the remote IMAP servers.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| BlockedCertificates | The certificates that must be rejected as trust anchors. |
| ClientChain | The TLS client certificate chain. |
| ConnectionInfo | Returns the details of the underlying network connection. |
| CurrentMailbox | Returns the selected (active) mailbox status. |
| FIPSMode | Reserved. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| Mailboxes | Populates a list of mailboxes available on the server. |
| Message | Contains a pinned e-mail message. |
| Messages | Populates a list of messages returned by the last list call. |
| Password | The authentication password. |
| Proxy | The proxy server settings. |
| ServerChain | The TLS server's certificate chain. |
| ServerInfo | Encapsulates information about the server. |
| SocketSettings | Manages network connection settings. |
| TLSSettings | Manages TLS layer settings. |
| TrustedCertificates | A list of trusted certificates for chain validation. |
| Username | The authentication username. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| CloseMailbox | Closes the current mailbox. |
| Config | Sets or retrieves a configuration setting. |
| Connect | Establishes a connection to the IMAP server. |
| CopyMessage | Copies a message to another mailbox. |
| CreateMailbox | Creates a new mailbox. |
| DeleteMailbox | Deletes an existing mailbox. |
| Disconnect | Closes connection to the IMAP server. |
| DoAction | Performs an additional action. |
| ExamineMailbox | Selects the mailbox in read-only mode. |
| GetMailboxStatus | Requests a mailbox status. |
| ListAllMessages | Queries a list of messages available in CurrentMailbox on the server. |
| ListDeletedMessages | Queries a list of deleted messages in the current mailbox on the server. |
| ListMailboxes | Queries a list of mailboxes available on the server. |
| ListNewMessages | Queries a list of new messages available in the current mailbox on the mail server. |
| ListRecentMessages | Queries a list of recent messages available in the current mailbox on the server. |
| ListUnseenMessages | Queries a list of unseen messages available in the current mailbox on the server. |
| MarkMessageDeleted | Sets a Deleted flag to the message. |
| MarkMessageSeen | Sets a Seen flag to the message. |
| Ping | Sends a NOOP command to the IMAP server. |
| PostBytes | Uploads an e-mail message stored in a byte array. |
| PostFile | Uploads a message stored in a file to the current mailbox on the IMAP server. |
| PostMessage | Uploads a pre-built message to the current mailbox on the IMAP server. |
| PostStream | Uploads a message stored in a stream to the current mailbox on the IMAP server. |
| PurgeMessages | Permanently removes all deleted messages from the current mailbox. |
| ReceiveBytes | Downloads a message to a byte array. |
| ReceiveFile | Downloads a message to a file. |
| ReceiveMessage | Downloads a message. |
| ReceiveStream | Downloads a message to a stream. |
| RefreshMailbox | Refreshes the state info of the current mailbox. |
| RenameMailbox | Renames an existing mailbox. |
| SelectMailbox | Selects the specified mailbox. |
| UpdateMessage | Alters flags assotiated with a message in the current mailbox on the IMAP server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| BeforeAuth | Fires before the authentication starts. |
| Command | Reports a command sent to the server. |
| CommandData | Returns the data that accompanies the command. |
| CommandReply | Reports the receipt of a reply to a command. |
| CommandReplyData | Returns the data that accompanies a reply to a command. |
| Error | Provides information about errors during SMTP operations. |
| MailboxStatus | Reports the mailbox status returned from the server. |
| Notification | This event notifies the application about an underlying control flow event. |
| Progress | Reports the progress of the data transfer operation. |
| TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
| TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
| TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
| TLSPSK | Notifies the application about the PSK key exchange. |
| TLSShutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
| Authentications | Specifies enabled authentication methods and their priorities. |
| IdleAuto | Specifies whether idle mode should be requested automatically. |
| IdleTimeout | Specifies idle timeout in seconds. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| ListCriteria | Specifies an advanced criteria for listing messages on the server. |
| MaxLineLength | Specifies maximum expected line length. |
| MessageHeaderZZZ[i] | A value of ZZZ header field for message i. |
| OtherHeaders | Specifies header fields to request when lists messages on the server. |
| TempPath | Path for storing temporary files. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
BlockedCertificates Property (IMAPClient Component)
The certificates that must be rejected as trust anchors.
Syntax
public CertificateList BlockedCertificates { get; }
Public Property BlockedCertificates As CertificateList
Remarks
Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.
This property is not available at design time.
ClientChain Property (IMAPClient Component)
The TLS client certificate chain.
Syntax
public CertificateList ClientChain { get; }
Public Property ClientChain As CertificateList
Remarks
Assign a certificate chain to this property to enable TLS client authentication in the component. Note that the client's end-entity certificate should have a private key associated with it.
Use CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.
This property is not available at design time.
ConnectionInfo Property (IMAPClient Component)
Returns the details of the underlying network connection.
Syntax
public ConnectionInfo ConnectionInfo { get; }
Public ReadOnly Property ConnectionInfo As ConnectionInfo
Remarks
Use this property to learn about the connection setup, such as the protocol security details and amounts of data transferred each way.
This property is read-only and not available at design time.
CurrentMailbox Property (IMAPClient Component)
Returns the selected (active) mailbox status.
Syntax
public IMAPMailboxStatus CurrentMailbox { get; }
Public ReadOnly Property CurrentMailbox As IMAPMailboxStatus
Remarks
Use this property to access the status of the mailbox that is currently selected (active).
This property is read-only and not available at design time.
FIPSMode Property (IMAPClient Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
KnownCertificates Property (IMAPClient Component)
Additional certificates for chain validation.
Syntax
public CertificateList KnownCertificates { get; }
Public Property KnownCertificates As CertificateList
Remarks
Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of certificates to be added to this collection is roughly equivalent to that of Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
This property is not available at design time.
KnownCRLs Property (IMAPClient Component)
Additional CRLs for chain validation.
Syntax
Remarks
Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.
This property is not available at design time.
KnownOCSPs Property (IMAPClient Component)
Additional OCSP responses for chain validation.
Syntax
public OCSPResponseList KnownOCSPs { get; }
Public Property KnownOCSPs As OCSPResponseList
Remarks
Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.
This property is not available at design time.
Mailboxes Property (IMAPClient Component)
Populates a list of mailboxes available on the server.
Syntax
public IMAPMailboxInfoList Mailboxes { get; }
Public ReadOnly Property Mailboxes As IMAPMailboxInfoList
Remarks
Use this property to access the details of mailboxes after a ListMailboxes call.
This property is read-only and not available at design time.
Message Property (IMAPClient Component)
Contains a pinned e-mail message.
Syntax
public MailMessage Message { get; set; }
Public Property Message As MailMessage
Remarks
Use this property to access an e-mail message that was just downloaded with a ReceiveMessage call, or assign it with a message to be uploaded with PostMessage call.
This property is not available at design time.
Messages Property (IMAPClient Component)
Populates a list of messages returned by the last list call.
Syntax
public IMAPMessageInfoList Messages { get; }
Public ReadOnly Property Messages As IMAPMessageInfoList
Remarks
Use this property to access the details of messages after a call to one of the list methods.
This property is read-only and not available at design time.
Password Property (IMAPClient Component)
The authentication password.
Syntax
Default Value
""
Remarks
Use this property to provide the password for authenticating to the IMAP server.
Proxy Property (IMAPClient Component)
The proxy server settings.
Syntax
public ProxySettings Proxy { get; }
Public ReadOnly Property Proxy As ProxySettings
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
ServerChain Property (IMAPClient Component)
The TLS server's certificate chain.
Syntax
public CertificateList ServerChain { get; }
Public ReadOnly Property ServerChain As CertificateList
Remarks
Use this property to access the certificate chain sent by the TLS server. This property is ready to read when OnCertificateValidate event is fired by the client component.
This property is read-only and not available at design time.
ServerInfo Property (IMAPClient Component)
Encapsulates information about the server.
Syntax
public IMAPServerInfo ServerInfo { get; }
Public ReadOnly Property ServerInfo As IMAPServerInfo
Remarks
Use this property after establishing a connection to the server to learn about the IMAP server's capabilities.
This property is read-only and not available at design time.
SocketSettings Property (IMAPClient Component)
Manages network connection settings.
Syntax
public SocketSettings SocketSettings { get; }
Public ReadOnly Property SocketSettings As SocketSettings
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
TLSSettings Property (IMAPClient Component)
Manages TLS layer settings.
Syntax
public TLSSettings TLSSettings { get; }
Public ReadOnly Property TLSSettings As TLSSettings
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
TrustedCertificates Property (IMAPClient Component)
A list of trusted certificates for chain validation.
Syntax
public CertificateList TrustedCertificates { get; }
Public Property TrustedCertificates As CertificateList
Remarks
Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of this certificate collection is largely the same than that of Windows Trusted Root Certification Authorities system store.
Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.
This property is not available at design time.
Username Property (IMAPClient Component)
The authentication username.
Syntax
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
CloseMailbox Method (IMAPClient Component)
Closes the current mailbox.
Syntax
public void CloseMailbox();
Public Sub CloseMailbox()
Remarks
Use this method to close the CurrentMailbox.
Config Method (IMAPClient Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (IMAPClient Component)
Establishes a connection to the IMAP server.
Syntax
Remarks
Use this method to establish a connection to the IMAP server at Address and Port.
CopyMessage Method (IMAPClient Component)
Copies a message to another mailbox.
Syntax
Remarks
Copies a message specified by its UID to another mailbox.
CreateMailbox Method (IMAPClient Component)
Creates a new mailbox.
Syntax
Remarks
Call this method to create a new mailbox, providing the name via the Name parameter.
DeleteMailbox Method (IMAPClient Component)
Deletes an existing mailbox.
Syntax
Remarks
Call this method to delete a mailbox.
Disconnect Method (IMAPClient Component)
Closes connection to the IMAP server.
Syntax
public void Disconnect();
Public Sub Disconnect()
Remarks
Call this method to gracefully terminate the connection.
DoAction Method (IMAPClient Component)
Performs an additional action.
Syntax
Remarks
DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
ExamineMailbox Method (IMAPClient Component)
Selects the mailbox in read-only mode.
Syntax
Remarks
Use this method to select the specified mailbox on the server in read-only mode. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the CurrentMailbox property.
GetMailboxStatus Method (IMAPClient Component)
Requests a mailbox status.
Syntax
Remarks
Requests the status of the specified mailbox and returns it using MailboxStatus event.
ListAllMessages Method (IMAPClient Component)
Queries a list of messages available in CurrentMailbox on the server.
Syntax
public void ListAllMessages();
Public Sub ListAllMessages()
Remarks
Call this method to request a list of messages available in the current mailbox.
ListDeletedMessages Method (IMAPClient Component)
Queries a list of deleted messages in the current mailbox on the server.
Syntax
public void ListDeletedMessages();
Public Sub ListDeletedMessages()
Remarks
Call this method to enumerate deleted messages (i.e. those having Deleted flag set) in CurrentMailbox.
ListMailboxes Method (IMAPClient Component)
Queries a list of mailboxes available on the server.
Syntax
public void ListMailboxes();
Public Sub ListMailboxes()
Remarks
Use this method to request a list of mailboxes currently available on the server. Use the Mailboxes property to access the mailbox details.
ListNewMessages Method (IMAPClient Component)
Queries a list of new messages available in the current mailbox on the mail server.
Syntax
public void ListNewMessages();
Public Sub ListNewMessages()
Remarks
Retrieves a list of new messages (i.e. those having Recent flag set and not having Seen flag set) present in CurrentMailbox.
ListRecentMessages Method (IMAPClient Component)
Queries a list of recent messages available in the current mailbox on the server.
Syntax
public void ListRecentMessages();
Public Sub ListRecentMessages()
Remarks
Retrieves a list of recent messages (i.e. those having Recent flag set) present in CurrentMailbox.
ListUnseenMessages Method (IMAPClient Component)
Queries a list of unseen messages available in the current mailbox on the server.
Syntax
public void ListUnseenMessages();
Public Sub ListUnseenMessages()
Remarks
Requests a list of unseen messages (i.e. not having Seen flag set) present in CurrentMailbox.
MarkMessageDeleted Method (IMAPClient Component)
Sets a Deleted flag to the message.
Syntax
Remarks
Use this method to mark a message as deleted, then call PurgeMessages to remove all the marked messages from the server.
MarkMessageSeen Method (IMAPClient Component)
Sets a Seen flag to the message.
Syntax
Remarks
Use this method to mark a message as seen.
Ping Method (IMAPClient Component)
Sends a NOOP command to the IMAP server.
Syntax
public void Ping();
Public Sub Ping()
Remarks
This method sends a NOOP command to the server, effectively pinging the server and keeping the connection alive.
PostBytes Method (IMAPClient Component)
Uploads an e-mail message stored in a byte array.
Syntax
Remarks
Use this method to send a message stored in a byte array specified by Bytes.
PostFile Method (IMAPClient Component)
Uploads a message stored in a file to the current mailbox on the IMAP server.
Syntax
Remarks
Use this method to upload an e-mail message stored in a file to CurrentMailbox.
PostMessage Method (IMAPClient Component)
Uploads a pre-built message to the current mailbox on the IMAP server.
Syntax
Remarks
Use this message to upload Message to CurrentMailbox.
PostStream Method (IMAPClient Component)
Uploads a message stored in a stream to the current mailbox on the IMAP server.
Syntax
public void PostStream(System.IO.Stream stream, int flags, string internalDate);
Public Sub PostStream(ByVal Stream As System.IO.Stream, ByVal Flags As Integer, ByVal InternalDate As String)
Remarks
Use this message to upload a message provided in Stream to CurrentMailbox.
PurgeMessages Method (IMAPClient Component)
Permanently removes all deleted messages from the current mailbox.
Syntax
public void PurgeMessages();
Public Sub PurgeMessages()
Remarks
Use this method to permanently remove all messages in CurrentMailbox marked with the Deleted flag.
ReceiveBytes Method (IMAPClient Component)
Downloads a message to a byte array.
Syntax
Remarks
Use this method to download a server-side message to a byte array.
ReceiveFile Method (IMAPClient Component)
Downloads a message to a file.
Syntax
Remarks
Use this method to download a server-side message to a local file.
ReceiveMessage Method (IMAPClient Component)
Downloads a message.
Syntax
Remarks
Use this method to download a server-side message to the Message object.
ReceiveStream Method (IMAPClient Component)
Downloads a message to a stream.
Syntax
public void ReceiveStream(int UID, System.IO.Stream stream);
Public Sub ReceiveStream(ByVal UID As Integer, ByVal Stream As System.IO.Stream)
Remarks
Use this method to download a server-side message to a stream object.
RefreshMailbox Method (IMAPClient Component)
Refreshes the state info of the current mailbox.
Syntax
public void RefreshMailbox();
Public Sub RefreshMailbox()
Remarks
Use this method to refresh the CurrentMailbox info.
RenameMailbox Method (IMAPClient Component)
Renames an existing mailbox.
Syntax
Remarks
Use this method to rename an existing mailbox from Name to NewName.
SelectMailbox Method (IMAPClient Component)
Selects the specified mailbox.
Syntax
Remarks
Use this method to select the specified mailbox on the server. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the CurrentMailbox property.
UpdateMessage Method (IMAPClient Component)
Alters flags assotiated with a message in the current mailbox on the IMAP server.
Syntax
Remarks
Use this method to alter flags associated with a UID message in CurrentMailbox.
BeforeAuth Event (IMAPClient Component)
Fires before the authentication starts.
Syntax
public event OnBeforeAuthHandler OnBeforeAuth; public delegate void OnBeforeAuthHandler(object sender, ImapclientBeforeAuthEventArgs e); public class ImapclientBeforeAuthEventArgs : EventArgs { }
Public Event OnBeforeAuth As OnBeforeAuthHandler Public Delegate Sub OnBeforeAuthHandler(sender As Object, e As ImapclientBeforeAuthEventArgs) Public Class ImapclientBeforeAuthEventArgs Inherits EventArgs End Class
Remarks
The component fires this event when it has established the TCP connection and is ready to proceed to the user authentication step.
Command Event (IMAPClient Component)
Reports a command sent to the server.
Syntax
public event OnCommandHandler OnCommand; public delegate void OnCommandHandler(object sender, ImapclientCommandEventArgs e); public class ImapclientCommandEventArgs : EventArgs { public string Cmd { get; } }
Public Event OnCommand As OnCommandHandler Public Delegate Sub OnCommandHandler(sender As Object, e As ImapclientCommandEventArgs) Public Class ImapclientCommandEventArgs Inherits EventArgs Public ReadOnly Property Cmd As String End Class
Remarks
The component fires this event whenever it sends an IMAP command to the server. Use CommandReply and CommandReplyData to track the server's responses.
CommandData Event (IMAPClient Component)
Returns the data that accompanies the command.
Syntax
public event OnCommandDataHandler OnCommandData; public delegate void OnCommandDataHandler(object sender, ImapclientCommandDataEventArgs e); public class ImapclientCommandDataEventArgs : EventArgs { public string Cmd { get; } public string Data { get; } }
Public Event OnCommandData As OnCommandDataHandler Public Delegate Sub OnCommandDataHandler(sender As Object, e As ImapclientCommandDataEventArgs) Public Class ImapclientCommandDataEventArgs Inherits EventArgs Public ReadOnly Property Cmd As String Public ReadOnly Property Data As String End Class
Remarks
Subscribe to this event to access data accompanying the outgoing commands.
CommandReply Event (IMAPClient Component)
Reports the receipt of a reply to a command.
Syntax
public event OnCommandReplyHandler OnCommandReply; public delegate void OnCommandReplyHandler(object sender, ImapclientCommandReplyEventArgs e); public class ImapclientCommandReplyEventArgs : EventArgs { public string Cmd { get; } public string Reply { get; } }
Public Event OnCommandReply As OnCommandReplyHandler Public Delegate Sub OnCommandReplyHandler(sender As Object, e As ImapclientCommandReplyEventArgs) Public Class ImapclientCommandReplyEventArgs Inherits EventArgs Public ReadOnly Property Cmd As String Public ReadOnly Property Reply As String End Class
Remarks
Use this event to track command replies sent in by the server. Use Command to track the commands sent out by the client, and CommandReplyData to access the reply data for commands that assume it.
CommandReplyData Event (IMAPClient Component)
Returns the data that accompanies a reply to a command.
Syntax
public event OnCommandReplyDataHandler OnCommandReplyData; public delegate void OnCommandReplyDataHandler(object sender, ImapclientCommandReplyDataEventArgs e); public class ImapclientCommandReplyDataEventArgs : EventArgs { public string Cmd { get; } public string Data { get; } }
Public Event OnCommandReplyData As OnCommandReplyDataHandler Public Delegate Sub OnCommandReplyDataHandler(sender As Object, e As ImapclientCommandReplyDataEventArgs) Public Class ImapclientCommandReplyDataEventArgs Inherits EventArgs Public ReadOnly Property Cmd As String Public ReadOnly Property Data As String End Class
Remarks
Subscribe to this event to access data accompanying incoming command replies.
Error Event (IMAPClient Component)
Provides information about errors during SMTP operations.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, ImapclientErrorEventArgs e); public class ImapclientErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As ImapclientErrorEventArgs) Public Class ImapclientErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
This event is fired in case of exceptional conditions occured during SMTP operations.
ErrorCode contains an error code and Description contains a textual description of the error.
MailboxStatus Event (IMAPClient Component)
Reports the mailbox status returned from the server.
Syntax
public event OnMailboxStatusHandler OnMailboxStatus; public delegate void OnMailboxStatusHandler(object sender, ImapclientMailboxStatusEventArgs e); public class ImapclientMailboxStatusEventArgs : EventArgs { public string Name { get; } public int TotalMessages { get; } public int RecentMessages { get; } public int UnseenMessages { get; } public int NextUID { get; } public int UIDValidity { get; } }
Public Event OnMailboxStatus As OnMailboxStatusHandler Public Delegate Sub OnMailboxStatusHandler(sender As Object, e As ImapclientMailboxStatusEventArgs) Public Class ImapclientMailboxStatusEventArgs Inherits EventArgs Public ReadOnly Property Name As String Public ReadOnly Property TotalMessages As Integer Public ReadOnly Property RecentMessages As Integer Public ReadOnly Property UnseenMessages As Integer Public ReadOnly Property NextUID As Integer Public ReadOnly Property UIDValidity As Integer End Class
Remarks
Subscribe to this event to be notified of mailbox status as returned by the IMAP server.
Notification Event (IMAPClient Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, ImapclientNotificationEventArgs e); public class ImapclientNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As ImapclientNotificationEventArgs) Public Class ImapclientNotificationEventArgs Inherits EventArgs Public ReadOnly Property EventID As String Public ReadOnly Property EventParam As String End Class
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
| EventID | EventParam | |
| MessageAdded | Number of messages in the current mailbox. | |
| MessageDeleted | UID of the deleted message if the message is in the current message list. | |
| MessageUpdated | UID of the updated message if the message is in the current message list. |
Progress Event (IMAPClient Component)
Reports the progress of the data transfer operation.
Syntax
public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, ImapclientProgressEventArgs e); public class ImapclientProgressEventArgs : EventArgs { public long Total { get; } public long Current { get; } public bool Cancel { get; set; } }
Public Event OnProgress As OnProgressHandler Public Delegate Sub OnProgressHandler(sender As Object, e As ImapclientProgressEventArgs) Public Class ImapclientProgressEventArgs Inherits EventArgs Public ReadOnly Property Total As Long Public ReadOnly Property Current As Long Public Property Cancel As Boolean End Class
Remarks
The component fires this event repeatedly to report the progress of the data transfer operation.
TLSCertNeeded Event (IMAPClient Component)
Fires when a remote TLS party requests a client certificate.
Syntax
public event OnTLSCertNeededHandler OnTLSCertNeeded; public delegate void OnTLSCertNeededHandler(object sender, ImapclientTLSCertNeededEventArgs e); public class ImapclientTLSCertNeededEventArgs : EventArgs { public string Host { get; } public string CANames { get; } }
Public Event OnTLSCertNeeded As OnTLSCertNeededHandler Public Delegate Sub OnTLSCertNeededHandler(sender As Object, e As ImapclientTLSCertNeededEventArgs) Public Class ImapclientTLSCertNeededEventArgs Inherits EventArgs Public ReadOnly Property Host As String Public ReadOnly Property CANames As String End Class
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.
TLSCertValidate Event (IMAPClient Component)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
public event OnTLSCertValidateHandler OnTLSCertValidate; public delegate void OnTLSCertValidateHandler(object sender, ImapclientTLSCertValidateEventArgs e); public class ImapclientTLSCertValidateEventArgs : EventArgs { public string ServerHost { get; } public string ServerIP { get; } public bool Accept { get; set; } }
Public Event OnTLSCertValidate As OnTLSCertValidateHandler Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As ImapclientTLSCertValidateEventArgs) Public Class ImapclientTLSCertValidateEventArgs Inherits EventArgs Public ReadOnly Property ServerHost As String Public ReadOnly Property ServerIP As String Public Property Accept As Boolean End Class
Remarks
This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.
TLSEstablished Event (IMAPClient Component)
Fires when a TLS handshake with Host successfully completes.
Syntax
public event OnTLSEstablishedHandler OnTLSEstablished; public delegate void OnTLSEstablishedHandler(object sender, ImapclientTLSEstablishedEventArgs e); public class ImapclientTLSEstablishedEventArgs : EventArgs { public string Host { get; } public string Version { get; } public string Ciphersuite { get; } public byte[] ConnectionId { get; } public bool Abort { get; set; } }
Public Event OnTLSEstablished As OnTLSEstablishedHandler Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As ImapclientTLSEstablishedEventArgs) Public Class ImapclientTLSEstablishedEventArgs Inherits EventArgs Public ReadOnly Property Host As String Public ReadOnly Property Version As String Public ReadOnly Property Ciphersuite As String Public ReadOnly Property ConnectionId As Byte() Public Property Abort As Boolean End Class
Remarks
The component uses this event to notify the application about successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
TLSHandshake Event (IMAPClient Component)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
public event OnTLSHandshakeHandler OnTLSHandshake; public delegate void OnTLSHandshakeHandler(object sender, ImapclientTLSHandshakeEventArgs e); public class ImapclientTLSHandshakeEventArgs : EventArgs { public string Host { get; } public bool Abort { get; set; } }
Public Event OnTLSHandshake As OnTLSHandshakeHandler Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As ImapclientTLSHandshakeEventArgs) Public Class ImapclientTLSHandshakeEventArgs Inherits EventArgs Public ReadOnly Property Host As String Public Property Abort As Boolean End Class
Remarks
The component uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.
TLSPSK Event (IMAPClient Component)
Notifies the application about the PSK key exchange.
Syntax
public event OnTLSPSKHandler OnTLSPSK; public delegate void OnTLSPSKHandler(object sender, ImapclientTLSPSKEventArgs e); public class ImapclientTLSPSKEventArgs : EventArgs { public string Host { get; } public string Hint { get; } }
Public Event OnTLSPSK As OnTLSPSKHandler Public Delegate Sub OnTLSPSKHandler(sender As Object, e As ImapclientTLSPSKEventArgs) Public Class ImapclientTLSPSKEventArgs Inherits EventArgs Public ReadOnly Property Host As String Public ReadOnly Property Hint As String End Class
Remarks
The component fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.
TLSShutdown Event (IMAPClient Component)
Reports the graceful closure of a TLS connection.
Syntax
public event OnTLSShutdownHandler OnTLSShutdown; public delegate void OnTLSShutdownHandler(object sender, ImapclientTLSShutdownEventArgs e); public class ImapclientTLSShutdownEventArgs : EventArgs { public string Host { get; } }
Public Event OnTLSShutdown As OnTLSShutdownHandler Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As ImapclientTLSShutdownEventArgs) Public Class ImapclientTLSShutdownEventArgs Inherits EventArgs Public ReadOnly Property Host As String End Class
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
Bytes Byte() |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CA Boolean |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CAKeyID Byte() |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CRLDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Fingerprint Byte() |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
FriendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyBits Integer |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyFingerprint Byte() |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyUsage Integer |
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyValid Boolean |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPNoCheck Boolean |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Origin Integer |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PolicyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyBytes Byte() |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExists Boolean |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExtractable Boolean |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBytes Byte() |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
QualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SelfSigned Boolean |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SerialNumber Byte() |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectKeyID Byte() |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public Certificate(byte[] bytes, int startIndex, int count, string password);
Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
public Certificate(byte[] bytes, int startIndex, int count);
Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.
public Certificate(string path, string password);
Public Certificate(ByVal Path As String, ByVal Password As String)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.
public Certificate(string certPath, string keyPath, string password);
Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)
Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.
public Certificate(string path);
Public Certificate(ByVal Path As String)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.
public Certificate(System.IO.Stream stream);
Public Certificate(ByVal Stream As System.IO.Stream)
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public Certificate(System.IO.Stream stream, string password);
Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.
public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);
Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)
Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.
public Certificate();
Public Certificate()
Creates a new object with default field values.
ConnectionInfo Type
Contains information about a network connection.
Remarks
Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.
Fields
|
AEADCipher Boolean |
Indicates whether the encryption algorithm used is an AEAD cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationDetails Integer |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Ciphersuite String |
The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ClientAuthenticated Boolean |
Specifies whether client authentication was performed during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ClientAuthRequested Boolean |
Specifies whether client authentication was requested during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ConnectionEstablished Boolean |
Indicates whether the connection has been established fully. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ConnectionID Byte() |
The unique identifier assigned to this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
DigestAlgorithm String |
The digest algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
EncryptionAlgorithm String |
The symmetric encryption algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Exportable Boolean |
Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyExchangeAlgorithm String |
The key exchange algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyExchangeKeyBits Integer |
The length of the key exchange key of a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
NamedECCurve String |
The elliptic curve used in this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PFSCipher Boolean |
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PreSharedIdentityHint String |
A hint professed by the server to help the client select the PSK identity to use. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBits Integer |
The length of the public key. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ResumedSession Boolean |
Indicates whether a TLS-enabled connection was spawned from another TLS connection |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SecureConnection Boolean |
Indicates whether TLS or SSL is enabled for this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ServerAuthenticated Boolean |
Indicates whether server authentication was performed during a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SignatureAlgorithm String |
The signature algorithm used in a TLS handshake. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SymmetricBlockSize Integer |
The block size of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SymmetricKeyBits Integer |
The key length of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
TotalBytesReceived Long |
The total number of bytes received over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
TotalBytesSent Long |
The total number of bytes sent over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidationLog String |
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Version String |
Indicates the version of SSL/TLS protocol negotiated during this connection. |
Constructors
public ConnectionInfo();
Public ConnectionInfo()
Creates a new ConnectionInfo object.
CRL Type
Represents a Certificate Revocation List.
Remarks
CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.
Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.
Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.
Fields
|
Bytes Byte() |
Returns raw CRL data in DER format. |
|
CAKeyID Byte() |
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
|
EntryCount Integer |
Returns the number of certificate status entries in the CRL. |
|
Issuer String |
The common name of the CRL issuer (CA), typically a company name. |
|
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
|
Location String |
The URL that the CRL was downloaded from. |
|
NextUpdate String |
The planned time and date of the next version of this CRL to be published. |
|
SigAlgorithm String |
The public key algorithm that was used by the CA to sign this CRL. |
|
TBS Byte() |
The to-be-signed part of the CRL (the CRL without the signature part). |
|
ThisUpdate String |
The date and time at which this version of the CRL was published. |
Constructors
Creates a CRL object from a memory buffer. Bytes is a buffer containing raw (DER) CRL data, StartIndex and Count specify the starting position and the length of the CRL data in the buffer, respectively.
Creates a CRL object by downloading it from a remote location.
public CRL(System.IO.Stream stream);
Public CRL(ByVal Stream As System.IO.Stream)
Creates a CRL object from data contained in a stream.
Creates an empty CRL object.
IMAPMailboxInfo Type
Contains information about an IMAP mailbox.
Remarks
This compound object provides details of an IMAP mailbox.
Fields
|
Delimiter String |
Mailbox hierarchy delimiter. |
|
HasChildren Boolean |
Specifies whether the mailbox has \HasChildren attribute specified. |
|
HasNoChildren Boolean |
Specifies whether the mailbox has \HasNoChildren attribute specified. |
|
Marked Boolean |
Specifies whether the mailbox has \Marked attribute specified. |
|
Name String |
Specifies mailbox name. |
|
NoInferiors Boolean |
Specifies whether the mailbox has \NoInferiors attribute specified. |
|
NoSelect Boolean |
Specifies whether the mailbox has \NoSelect attribute specified. |
|
Unmarked Boolean |
Specifies whether the mailbox has \Unmarked attribute specified. |
IMAPMailboxStatus Type
Contains information about IMAP mailbox state.
Remarks
Provides details of current IMAP mailbox status.
Fields
|
MessageFlags Integer |
Contains message flags defined in the mailbox.
|
||||||||||||||||||
|
Name String |
Specifies mailbox name. |
||||||||||||||||||
|
NextUID Integer |
Returns the next unique identifier value. Use this property to get or set the next unique identifier (corresponds to UIDNEXT status code). |
||||||||||||||||||
|
PermanentFlags Integer |
Contains a list of message flags that can be changed permanently.
|
||||||||||||||||||
|
ReadOnly Boolean |
Specifies whether the mailbox is write-protected. |
||||||||||||||||||
|
RecentMessages Integer |
The number of recent messages in the mailbox. |
||||||||||||||||||
|
TotalMessages Integer |
Total number of messages in the mailbox. |
||||||||||||||||||
|
UIDValidity Integer |
Specifies UID validity value. |
||||||||||||||||||
|
UnseenMessages Integer |
The number of unseen messages in the mailbox. |
IMAPMessageInfo Type
This type is a container for the server-side message details.
Remarks
Use this type to get the details of server-side messages after the list call.
Fields
|
Date String |
Contains the value of the Date header field. |
||||||||||
|
Flags Integer |
Returns the flags currently set to the mail message. |
||||||||||
|
From String |
Contains the value of the From header field. |
||||||||||
|
InternalDate String |
Returns the internal date of the mail message. |
||||||||||
|
Priority MailPriorities |
Specifies the message priority. Available options:
|
||||||||||
|
SentTo String |
Contains the value of the To header field. |
||||||||||
|
Size Long |
Returns the size of the message in bytes. |
||||||||||
|
Subject String |
Contains the value of the Subject header field. |
||||||||||
|
UID Integer |
Returns the unique ID of the mail message. |
IMAPServerInfo Type
Describes the IMAP server's capabilities.
Remarks
Check this object to learn about the IMAP server's technical capabilities.
Fields
|
Capabilities String |
Returns the list of server capabilities. Use this property to get the list of IMAP capabilities (i.e., optional functionality of the server as defined in [RFC 3501]) obtained from the server. |
|
IdleSupported Boolean |
Indicates whether the IMAP server supports the IDLE command. |
|
LoginDisabled Boolean |
Specifies whether the server forbids login. |
MailMessage Type
Represents an e-mail message.
Remarks
This object is a container for an e-mail message.
A message consists of a header and a body. The header, in turn, consists of several header fields. The names, syntax, and expected contents of the header fields are standardized.
The message body can contain anything you like (a message may not even have a body at all).
Fields
|
AttachmentCount Integer |
Returns the number of attachments in this message. |
||||||||||
|
Bcc String |
The contents of the BCC header field. The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message. Mail servers remove the BCC header when processing the message and use its value for dispatching the message only. |
||||||||||
|
Cc String |
The value of the CC header field. The CC field contains the addresses of secondary recipients of the message. |
||||||||||
|
Comments String |
Contains additional information about the message body. |
||||||||||
|
Date String |
The date and time when the message entered the mail delivery system. This field contains the date and time at which the creator of the message posted the message to the mail delivery system. The date is returned and accepted in UTC time zone. |
||||||||||
|
DeliveryReceipt Boolean |
Enables delivery notification. |
||||||||||
|
From String |
Contains the value of the From header field. This field contains the address(es) of the message author(s). If the actual sender is not the author of the message, use Sender to specify the sender separately. |
||||||||||
|
HtmlText String |
The HTML version of the message. |
||||||||||
|
ID String |
The contents of the Message-ID header field. This field contains a unique identifier that refers to a particular version of this message. |
||||||||||
|
InReplyTo String |
The value of the In-Reply-To header field. A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply. |
||||||||||
|
Keywords String |
The value of the Keywords header field. This field can be used to add some important words and phrases that might be useful for the recipient. |
||||||||||
|
Mailer String |
The name of the software that was used to send the message. |
||||||||||
|
PlainText String |
The plain text version of the message. |
||||||||||
|
Priority MailPriorities |
Specifies the message priority. Available options:
|
||||||||||
|
ReadReceipt Boolean |
Enables a read notification. |
||||||||||
|
References String |
The value of the References header field. A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message. |
||||||||||
|
ReplyTo String |
The value of the Reply-To header field. This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the From field. |
||||||||||
|
ReturnPath String |
The value of the Return-Path header field. This field contains the address to which this message shall be returned in case of unsuccessful delivery. |
||||||||||
|
Sender String |
The value of the Sender header field. This field specifies the mailbox of the agent responsible for the actual transmission of this message. If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are identical, the "Sender:" field is deemed excessive and should not be used. |
||||||||||
|
SendTo String |
The value of the To header field. This field specifies the address(es) of the primary recipient(s) of the message. |
||||||||||
|
Subject String |
Contains the subject field of this message. |
Constructors
public MailMessage();
Public MailMessage()
Creates a new empty mail message object.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Remarks
OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRL).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
|
Bytes Byte() |
Buffer containing raw OCSP response data. |
|
EntryCount Integer |
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. |
|
Issuer String |
Indicates the issuer of this response (a CA or its authorized representative). |
|
IssuerRDN String |
Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
|
Location String |
Location of the OCSP responder. |
|
ProducedAt String |
Specifies the time when the response was produced, in UTC. |
Constructors
public OCSPResponse(byte[] bytes, int startIndex, int count);
Public OCSPResponse(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)
Initializes the response from a memory buffer. Bytes is a buffer containing raw OCSP response data, StartIndex and Count specify the starting position and the number of bytes to be read from this buffer.
public OCSPResponse(string location);
Public OCSPResponse(ByVal Location As String)
Downloads an OCSP response from a remote location.
public OCSPResponse(System.IO.Stream stream);
Public OCSPResponse(ByVal Stream As System.IO.Stream)
Initializes the response with the data from a stream.
public OCSPResponse();
Public OCSPResponse()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
|
Address String |
The IP address of the proxy server. |
||||||||||
|
Authentication ProxyAuthTypes |
The authentication type used by the proxy server.
|
||||||||||
|
Password String |
The password to authenticate to the proxy server. |
||||||||||
|
Port Integer |
The port on the proxy server to connect to. |
||||||||||
|
ProxyType ProxyTypes |
The type of the proxy server. The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
|
||||||||||
|
RequestHeaders String |
Contains HTTP request headers for WebTunnel and HTTP proxy. |
||||||||||
|
ResponseBody String |
Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
||||||||||
|
ResponseHeaders String |
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
||||||||||
|
UseIPv6 Boolean |
Specifies whether IPv6 should be used when connecting through the proxy. |
||||||||||
|
UseProxy Boolean |
Enables or disables proxy-driven connection. |
||||||||||
|
Username String |
Specifies the username credential for proxy authentication. |
Constructors
public ProxySettings();
Public ProxySettings()
Creates a new ProxySettings object.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
|
DNSMode DNSResolveModes |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
DNSPort Integer |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
DNSQueryTimeout Integer |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
DNSServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
DNSTotalTimeout Integer |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
IncomingSpeedLimit Integer |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
LocalAddress String |
The local network interface to bind the socket to. |
||||||||
|
LocalPort Integer |
The local port number to bind the socket to. |
||||||||
|
OutgoingSpeedLimit Integer |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
Timeout Integer |
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). |
||||||||
|
UseIPv6 Boolean |
Enables or disables IP protocol version 6. |
Constructors
public SocketSettings();
Public SocketSettings()
Creates a new SocketSettings object.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
|
AutoValidateCertificates Boolean |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
BaseConfiguration SecureTransportPredefinedConfigurations |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
Ciphersuites String |
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
|
|||||||||||||||||||||||||||||||||
|
ECCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
Extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
ForceResumeIfDestinationChanges Boolean |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
PreSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
PreSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
PreSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
RenegotiationAttackPreventionMode RenegotiationAttackPreventionModes |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
RevocationCheck RevocationCheckKinds |
Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
SSLOptions Integer |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
TLSMode SSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
UseExtendedMasterSecret Boolean |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
UseSessionResumption Boolean |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
Versions Integer |
Th SSL/TLS versions to enable by default.
|
Constructors
public TLSSettings();
Public TLSSettings()
Creates a new TLSSettings object.
Config Settings (IMAPClient Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.IMAPClient Config Settings
| Authentications:
Specifies enabled authentication methods and their priorities.Use this setting to enable or disable authentication methods and specify their priorities. The setting contains
a comma-separated list of authentication methods. The first method in the list has the highest priority, and so on.
The component will use the first method from the list which is supported by the server.
Supported methods: PLAIN, LOGIN, CRAM-MD5, DIGEST-MD5, NTLM, GSSAPI, XOAUTH2 Default value: PLAIN,DIGEST-MD5,CRAM-MD5,NTLM |
|
| IdleAuto: Specifies whether idle mode should be requested automatically.Set this property to true to force this client to automatically send IDLE request to the server. Default value is false. | |
| IdleTimeout: Specifies idle timeout in seconds.If IDLE command is running on a server, and a client has been inactive for some time, the server may log the client off. Set this property to a maximum period of time after which this client should resend the IDLE command. The default value is 1740 seconds (29 minutes). | |
| IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
|
| ListCriteria: Specifies an advanced criteria for listing messages on the server.Use this setting to list messages based on additional criteria like message date, size, etc. For more details, see SEARCH command in RFC 3501 | |
| MaxLineLength: Specifies maximum expected line length.Use this setting to specify how long the expected mail line can be. Setting the very long value leads to memory increase. Default value is 10000. | |
| MessageHeaderZZZ[i]:
A value of ZZZ header field for message i.Returns the value of the header field named ZZZ for the message with index i. If the message doesn't contain such
header field, the returned value is an empty line.
For example, to get a value of the Content-Type header field, use MessageHeaderContentType[i] config name. |
|
| OtherHeaders: Specifies header fields to request when lists messages on the server.Use this setting to request additional header fields for each message on the server. The setting contains a comma-separated list of header field names that should be requested when the component lists messages. To request all the fields, use "OtherHeaders=*". To not request additional header fields, use "OtherHeaders=". | |
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | |
TolerateMinorChainIssues:
Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:
|
|
| UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | |
| UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. |
Base Config Settings
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
|||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the component.
Supported values are:
|
|||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions. | |||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | |||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
|||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global". | |||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components. | |||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
|||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
|||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | |||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
|||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
|||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
|||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
|||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
|||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | |||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | |||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | |||||||||||||||||||||||||||||||
| StaticDNS:
Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the component. Works only if UseOwnDNSResolver is set to true.
Supported values are:
|
|||||||||||||||||||||||||||||||
| StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character. | |||||||||||||||||||||||||||||||
| StaticIPAddresses: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. | |||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | |||||||||||||||||||||||||||||||
| UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | |||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | |||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
|||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (IMAPClient Component)
IMAPClient Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Component is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |