# IMAP Component The IMAP Class is used to communicate with IMAP servers using the Internet Message Access Protocol (IMAP). ## Syntax ```text ipworksedi.IMAP ``` ## Remarks The IMAP Struct supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2595). When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the [SSLServerAuthentication](#sslserverauthentication-event-imap-component) event allows you to check the server identity and other security attributes. The [SSLStatus](#sslstatus-event-imap-component) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [Config](#config-method-imap-component) method. The IMAP Struct implements a standard IMAP client as specified in RFC 1730 and RFC 2060. The first step in using the struct is specifying a [MailServer](#mailserver-property-imap-component), a [User](#user-property-imap-component) to connect as, and a [Password](#password-property-imap-component) to authenticate with. After that, one or more requests may be sent to the server via the struct's methods. Results are retrieved through events and a number of key properties. Normally, after connecting to the server, a [Mailbox](#mailbox-property-imap-component) is selected (or examined) using the [ExamineMailbox](#examinemailbox-method-imap-component) method. After the [Mailbox](#mailbox-property-imap-component) is selected, [MessageCount](#messagecount-property-imap-component) and [RecentMessageCount](#recentmessagecount-property-imap-component) show the number of messages in the mailbox, and [MailboxFlags](#mailboxflags-property-imap-component) show the flags pertaining to the mailbox. A number of operations may be performed by the server in response to commands sent using the struct's methods. The primary arguments for most commands are the [Mailbox](#mailbox-property-imap-component) property and the [MessageSet](#messageset-property-imap-component) property. The [MessageSet](#messageset-property-imap-component) property denotes either a single message, or a range of messages. Other arguments are specified through other properties, such as [SortCriteria](#sortcriteria-property-imap-component) and [MessageFlags](#messageflags-property-imap-component). Responses are received through events, such as [MessageInfo](#messageinfo-event-imap-component) and [MailboxList](#mailboxlist-event-imap-component), and also are reflected to properties, such as [MessageText](#messagetext-property-imap-component) and [MessageSubject](#messagesubject-property-imap-component). The [MessagePart](#messagepart-event-imap-component) event describes the MIME structure of the retrieved messages. One [MessagePart](#messagepart-event-imap-component) event is fired for every message part, giving information about the particular part. Later on, message parts may be retrieved separately through the [RetrieveMessagePart](#retrievemessagepart-method-imap-component) method. This speeds up processing by avoiding the need to retrieve full messages from the server. The [PITrail](#pitrail-event-imap-component) event traces the interaction between the client and the server. It includes all exchanges except for transfers of messages, message parts, and message headers. ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthMechanism](#authmechanism-property-imap-component) | This property includes the authentication mechanism to be used when connecting to the mail server. | | [AutoDecodeParts](#autodecodeparts-property-imap-component) | This property determines whether or not to automatically decode message parts. | | [Connected](#connected-property-imap-component) | Whether the class is connected. | | [EndByte](#endbyte-property-imap-component) | This property includes the byte index of the position where the transfer should end. | | [FirewallAutoDetect](#firewallautodetect-property-imap-component) | Whether to automatically detect and use firewall system settings, if available. | | [FirewallType](#firewalltype-property-imap-component) | The type of firewall to connect through. | | [FirewallHost](#firewallhost-property-imap-component) | The name or IP address of the firewall (optional). | | [FirewallPassword](#firewallpassword-property-imap-component) | A password if authentication is to be used when connecting through the firewall. | | [FirewallPort](#firewallport-property-imap-component) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [FirewallUser](#firewalluser-property-imap-component) | A username if authentication is to be used when connecting through a firewall. | | [Idle](#idle-property-imap-component) | The current status of the class. | | [LastReply](#lastreply-property-imap-component) | This property indicates the last reply received from the server. | | [LocalFile](#localfile-property-imap-component) | This property includes the path to a local file for downloading the message body. | | [LocalHost](#localhost-property-imap-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [Mailbox](#mailbox-property-imap-component) | This property includes the name of the mailbox selected on the server. | | [MailboxFlags](#mailboxflags-property-imap-component) | This property defines flags in the selected mailbox. | | [MailboxListCount](#mailboxlistcount-property-imap-component) | The number of records in the MailboxList arrays. | | [MailboxListFlags](#mailboxlistflags-property-imap-component) | This property contains the mailbox flags in a mailbox listing. | | [MailboxListName](#mailboxlistname-property-imap-component) | This property contains the mailbox name in a mailbox listing. | | [MailboxListSeparator](#mailboxlistseparator-property-imap-component) | The Separator property contains the character that separates the different parts in the mailbox path hierarchy. | | [MailPort](#mailport-property-imap-component) | This property includes the port of the IMAP server (default is 143). | | [MailServer](#mailserver-property-imap-component) | This property includes the name or address of the mail server (IMAP server). | | [Message](#message-property-imap-component) | This property provides the raw message content. | | [MessageContentEncoding](#messagecontentencoding-property-imap-component) | This property includes the ContentEncoding of the selected message. | | [MessageContentType](#messagecontenttype-property-imap-component) | This property includes the ContentType of the message. | | [MessageCount](#messagecount-property-imap-component) | This property includes the total number of messages on the Mailbox . | | [MessageDate](#messagedate-property-imap-component) | The property includes the time the message was created. | | [MessageDeliveryTime](#messagedeliverytime-property-imap-component) | This property includes the time the message was delivered to the mail server. | | [MessageFlags](#messageflags-property-imap-component) | This property contains the flags of the current message. | | [MessageFrom](#messagefrom-property-imap-component) | This property includes the address of the author of the message. | | [MessageHeaderCount](#messageheadercount-property-imap-component) | The number of records in the MessageHeader arrays. | | [MessageHeaderField](#messageheaderfield-property-imap-component) | This property contains the name of the HTTP header (this is the same case as it is delivered). | | [MessageHeaderValue](#messageheadervalue-property-imap-component) | This property contains the header contents. | | [MessageHeadersString](#messageheadersstring-property-imap-component) | This property includes the string version of the RFC 822-encoded headers in the message. | | [MessageId](#messageid-property-imap-component) | This property includes the message identifier of the current message. | | [MessageInfoCount](#messageinfocount-property-imap-component) | The number of records in the MessageInfo arrays. | | [MessageInfoDate](#messageinfodate-property-imap-component) | This property contains the date of a message in a message information listing. | | [MessageInfoFlags](#messageinfoflags-property-imap-component) | This property contains a message flag in a message information listing. | | [MessageInfoFrom](#messageinfofrom-property-imap-component) | This property contains the sender of a message in a message information listing. | | [MessageInfoMessageId](#messageinfomessageid-property-imap-component) | The unique identifier of a message in a message information listing. | | [MessageInfoSize](#messageinfosize-property-imap-component) | This property contains the size of a message in a message information listing. | | [MessageInfoSubject](#messageinfosubject-property-imap-component) | This property contains the subject of a message in a message information listing. | | [MessageInReplyTo](#messageinreplyto-property-imap-component) | This property includes the unique message identifier of the message being replied to. | | [MessageNetId](#messagenetid-property-imap-component) | This property includes the globally unique identifier of the message. | | [MessagePartCount](#messagepartcount-property-imap-component) | The number of records in the MessagePart arrays. | | [MessagePartContentDisposition](#messagepartcontentdisposition-property-imap-component) | This property shows the value of the Content-Disposition header of the message part. | | [MessagePartContentEncoding](#messagepartcontentencoding-property-imap-component) | This property shows how the data are encoded. | | [MessagePartContentId](#messagepartcontentid-property-imap-component) | This property shows the value of the Content-Id header of the message part. | | [MessagePartContentType](#messagepartcontenttype-property-imap-component) | This property shows the type of data contained in the message part. | | [MessagePartFileName](#messagepartfilename-property-imap-component) | This property shows the filename corresponding to the part (if the part was included in the message as an attached file). | | [MessagePartId](#messagepartid-property-imap-component) | This property contains the identifier of a part listing that may be identified in other parts or messages. | | [MessagePartMultipartMode](#messagepartmultipartmode-property-imap-component) | This property shows how this part relates to the message's whole multipart structure (e. | | [MessagePartParameters](#messagepartparameters-property-imap-component) | This property contains the additional parameters passed to the ContentType header, such as the part charset. | | [MessagePartSize](#messagepartsize-property-imap-component) | This property contains the size of a part in a message part listing. | | [MessageRecipientCount](#messagerecipientcount-property-imap-component) | The number of records in the MessageRecipient arrays. | | [MessageRecipientAddress](#messagerecipientaddress-property-imap-component) | This property contains the email address of the recipient. | | [MessageRecipientName](#messagerecipientname-property-imap-component) | This property contains the name of the recipient. | | [MessageRecipientOptions](#messagerecipientoptions-property-imap-component) | This property contains the recipient sending options (used only by SMTP). | | [MessageRecipientType](#messagerecipienttype-property-imap-component) | This property contains the recipient type: To, Cc, or Bcc. | | [MessageReplyTo](#messagereplyto-property-imap-component) | This property includes the email addresses to which replies to the message should be sent. | | [MessageSender](#messagesender-property-imap-component) | This property includes the address of the sender of the message. | | [MessageSet](#messageset-property-imap-component) | This property includes the set of messages to operate on. | | [MessageSize](#messagesize-property-imap-component) | This property includes the size of the selected message. | | [MessageSubject](#messagesubject-property-imap-component) | This property includes the subject of the message. | | [MessageText](#messagetext-property-imap-component) | This property includes the body of the retrieved message. | | [OAuthAccessToken](#oauthaccesstoken-property-imap-component) | The access token returned by the authorization server. | | [OAuthAuthorizationScope](#oauthauthorizationscope-property-imap-component) | The scope request or response parameter used during authorization. | | [OAuthClientId](#oauthclientid-property-imap-component) | The id of the client assigned when registering the application. | | [OAuthClientSecret](#oauthclientsecret-property-imap-component) | The secret value for the client assigned when registering the application. | | [OAuthRefreshToken](#oauthrefreshtoken-property-imap-component) | Specifies the refresh token received from or sent to the authorization server. | | [OAuthReturnURL](#oauthreturnurl-property-imap-component) | The URL where the user (browser) returns after authenticating. | | [OAuthServerAuthURL](#oauthserverauthurl-property-imap-component) | The URL of the authorization server. | | [OAuthServerTokenURL](#oauthservertokenurl-property-imap-component) | The URL of the token server used to obtain the access token. | | [Overwrite](#overwrite-property-imap-component) | This property indicates whether or not the class should overwrite files during transfer. | | [Password](#password-property-imap-component) | This property includes the password to be used to authenticate to the MailServer . | | [PeekMode](#peekmode-property-imap-component) | When set to True, the message Seen flag is not changed during reading. | | [RecentMessageCount](#recentmessagecount-property-imap-component) | This property includes the number of new messages in the Mailbox . | | [SortCriteria](#sortcriteria-property-imap-component) | This property sorts criteria to use for message retrieval operations. | | [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-imap-component) | The date on which this certificate becomes valid. | | [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-imap-component) | The date on which the certificate expires. | | [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-imap-component) | A comma-delimited list of extended key usage identifiers. | | [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-imap-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-imap-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-imap-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-imap-component) | The issuer of the certificate. | | [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-imap-component) | The private key of the certificate (if available). | | [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-imap-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-imap-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-imap-component) | The public key of the certificate. | | [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-imap-component) | The textual description of the certificate's public key algorithm. | | [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-imap-component) | The length of the certificate's public key (in bits). | | [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-imap-component) | The serial number of the certificate encoded as a string. | | [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-imap-component) | The text description of the certificate's signature algorithm. | | [SSLAcceptServerCertStore](#sslacceptservercertstore-property-imap-component) | The name of the certificate store for the client certificate. | | [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-imap-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-imap-component) | The type of certificate store for this certificate. | | [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-imap-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-imap-component) | The MD5 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-imap-component) | The SHA-1 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-imap-component) | The SHA-256 hash of the certificate. | | [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-imap-component) | The text description of UsageFlags . | | [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-imap-component) | The flags that show intended use for the certificate. | | [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-imap-component) | The certificate's version number. | | [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-imap-component) | The subject of the certificate used for client authentication. | | [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-imap-component) | The certificate (PEM/Base64 encoded). | | [SSLCertEffectiveDate](#sslcerteffectivedate-property-imap-component) | The date on which this certificate becomes valid. | | [SSLCertExpirationDate](#sslcertexpirationdate-property-imap-component) | The date on which the certificate expires. | | [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-imap-component) | A comma-delimited list of extended key usage identifiers. | | [SSLCertFingerprint](#sslcertfingerprint-property-imap-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-imap-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-imap-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLCertIssuer](#sslcertissuer-property-imap-component) | The issuer of the certificate. | | [SSLCertPrivateKey](#sslcertprivatekey-property-imap-component) | The private key of the certificate (if available). | | [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-imap-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-imap-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLCertPublicKey](#sslcertpublickey-property-imap-component) | The public key of the certificate. | | [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-imap-component) | The textual description of the certificate's public key algorithm. | | [SSLCertPublicKeyLength](#sslcertpublickeylength-property-imap-component) | The length of the certificate's public key (in bits). | | [SSLCertSerialNumber](#sslcertserialnumber-property-imap-component) | The serial number of the certificate encoded as a string. | | [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-imap-component) | The text description of the certificate's signature algorithm. | | [SSLCertStore](#sslcertstore-property-imap-component) | The name of the certificate store for the client certificate. | | [SSLCertStorePassword](#sslcertstorepassword-property-imap-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLCertStoreType](#sslcertstoretype-property-imap-component) | The type of certificate store for this certificate. | | [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-imap-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-imap-component) | The MD5 hash of the certificate. | | [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-imap-component) | The SHA-1 hash of the certificate. | | [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-imap-component) | The SHA-256 hash of the certificate. | | [SSLCertUsage](#sslcertusage-property-imap-component) | The text description of UsageFlags . | | [SSLCertUsageFlags](#sslcertusageflags-property-imap-component) | The flags that show intended use for the certificate. | | [SSLCertVersion](#sslcertversion-property-imap-component) | The certificate's version number. | | [SSLCertSubject](#sslcertsubject-property-imap-component) | The subject of the certificate used for client authentication. | | [SSLCertEncoded](#sslcertencoded-property-imap-component) | The certificate (PEM/Base64 encoded). | | [SSLEnabled](#sslenabled-property-imap-component) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. | | [SSLProvider](#sslprovider-property-imap-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-imap-component) | The date on which this certificate becomes valid. | | [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-imap-component) | The date on which the certificate expires. | | [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-imap-component) | A comma-delimited list of extended key usage identifiers. | | [SSLServerCertFingerprint](#sslservercertfingerprint-property-imap-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-imap-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-imap-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLServerCertIssuer](#sslservercertissuer-property-imap-component) | The issuer of the certificate. | | [SSLServerCertPrivateKey](#sslservercertprivatekey-property-imap-component) | The private key of the certificate (if available). | | [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-imap-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-imap-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLServerCertPublicKey](#sslservercertpublickey-property-imap-component) | The public key of the certificate. | | [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-imap-component) | The textual description of the certificate's public key algorithm. | | [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-imap-component) | The length of the certificate's public key (in bits). | | [SSLServerCertSerialNumber](#sslservercertserialnumber-property-imap-component) | The serial number of the certificate encoded as a string. | | [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-imap-component) | The text description of the certificate's signature algorithm. | | [SSLServerCertStore](#sslservercertstore-property-imap-component) | The name of the certificate store for the client certificate. | | [SSLServerCertStorePassword](#sslservercertstorepassword-property-imap-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLServerCertStoreType](#sslservercertstoretype-property-imap-component) | The type of certificate store for this certificate. | | [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-imap-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-imap-component) | The MD5 hash of the certificate. | | [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-imap-component) | The SHA-1 hash of the certificate. | | [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-imap-component) | The SHA-256 hash of the certificate. | | [SSLServerCertUsage](#sslservercertusage-property-imap-component) | The text description of UsageFlags . | | [SSLServerCertUsageFlags](#sslservercertusageflags-property-imap-component) | The flags that show intended use for the certificate. | | [SSLServerCertVersion](#sslservercertversion-property-imap-component) | The certificate's version number. | | [SSLServerCertSubject](#sslservercertsubject-property-imap-component) | The subject of the certificate used for client authentication. | | [SSLServerCertEncoded](#sslservercertencoded-property-imap-component) | The certificate (PEM/Base64 encoded). | | [SSLStartMode](#sslstartmode-property-imap-component) | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. | | [StartByte](#startbyte-property-imap-component) | This property includes the byte index of the position where the transfer should start. | | [Timeout](#timeout-property-imap-component) | The timeout for the class. | | [UIDMode](#uidmode-property-imap-component) | If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers. | | [UIDValidity](#uidvalidity-property-imap-component) | This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command. | | [User](#user-property-imap-component) | This property includes the username used to authenticate to the MailServer . | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddMessageFlags](#addmessageflags-method-imap-component) | This method adds the specified flags to the messages specified by MessageSet . | | [AppendToMailbox](#appendtomailbox-method-imap-component) | This method appends the message in MessageText to the mailbox specified by Mailbox . | | [CheckMailbox](#checkmailbox-method-imap-component) | This method sends a CHECK command to the server. | | [CloseMailbox](#closemailbox-method-imap-component) | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox. | | [Config](#config-method-imap-component) | Sets or retrieves a configuration setting. | | [Connect](#connect-method-imap-component) | This method connects to an IMAP server. | | [CopyToMailbox](#copytomailbox-method-imap-component) | Copies the specified messages to another mailbox. | | [CreateMailbox](#createmailbox-method-imap-component) | This method creates a new mailbox specified by Mailbox . | | [DeleteFromMailbox](#deletefrommailbox-method-imap-component) | The method marks the messages specified by MessageSet as deleted. | | [DeleteMailbox](#deletemailbox-method-imap-component) | This method deletes a mailbox specified by Mailbox . | | [DeleteMailboxACL](#deletemailboxacl-method-imap-component) | This method deletes mailbox access control rights for a specific user. | | [Disconnect](#disconnect-method-imap-component) | This method disconnects from an IMAP server. | | [DoEvents](#doevents-method-imap-component) | This method processes events from the internal message queue. | | [ExamineMailbox](#examinemailbox-method-imap-component) | This method selects a mailbox in read-only mode. | | [ExpungeMailbox](#expungemailbox-method-imap-component) | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox. | | [GetMailboxACL](#getmailboxacl-method-imap-component) | This method retrieves mailbox access control rights. | | [Interrupt](#interrupt-method-imap-component) | This method interrupts the current method. | | [ListMailboxes](#listmailboxes-method-imap-component) | This method lists all of the mailboxes matching all criteria in the Mailbox property. | | [ListSubscribedMailboxes](#listsubscribedmailboxes-method-imap-component) | This method lists all subscribed mailboxes matching all criteria in the Mailbox property. | | [LocalizeDate](#localizedate-method-imap-component) | This method converts a valid RFC 822 message date to a local date and time. | | [MoveToMailbox](#movetomailbox-method-imap-component) | Copies the specified messages to another mailbox and marks the original messages as deleted. | | [Noop](#noop-method-imap-component) | This method sends a NOOP command to the server. | | [RenameMailbox](#renamemailbox-method-imap-component) | This method changes the name of Mailbox to NewName . | | [Reset](#reset-method-imap-component) | This method will reset the class. | | [ResetMessageFlags](#resetmessageflags-method-imap-component) | This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags . | | [RetrieveMessageHeaders](#retrievemessageheaders-method-imap-component) | This method retrieves the message headers of the messages specified by the MessageSet property. | | [RetrieveMessageInfo](#retrievemessageinfo-method-imap-component) | This method retrieves information about messages specified by the MessageSet property. | | [RetrieveMessagePart](#retrievemessagepart-method-imap-component) | This method retrieves the message part specified by PartID. | | [RetrieveMessagePartHeaders](#retrievemessagepartheaders-method-imap-component) | This method retrieves the headers of message part specified by PartID. | | [RetrieveMessageText](#retrievemessagetext-method-imap-component) | This method retrieves the message text of the messages specified by the MessageSet property. | | [SearchMailbox](#searchmailbox-method-imap-component) | This method searches the selected mailbox for specified text. | | [SelectMailbox](#selectmailbox-method-imap-component) | This method selects a mailbox. | | [SendCommand](#sendcommand-method-imap-component) | This method sends the exact command directly to the server. | | [SetMailboxACL](#setmailboxacl-method-imap-component) | This method sets mailbox access control rights for a specific user. | | [StartIdle](#startidle-method-imap-component) | This method begins idling. | | [StopIdle](#stopidle-method-imap-component) | This method stops idling. | | [SubscribeMailbox](#subscribemailbox-method-imap-component) | This method subscribes to the mailbox specified by Mailbox . | | [UnsetMessageFlags](#unsetmessageflags-method-imap-component) | This method removes the flags specified by MessageFlags from the messages specified by MessageSet . | | [UnsubscribeMailbox](#unsubscribemailbox-method-imap-component) | This method unsubscribes from the mailbox specified by Mailbox . | ## 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.* | | | | --- | --- | | [ConnectionStatus](#connectionstatus-event-imap-component) | Fired to indicate changes in the connection state. | | [EndTransfer](#endtransfer-event-imap-component) | This event is fired when the message or the part data finishes transferring. | | [Error](#error-event-imap-component) | Fired when information is available about errors during data delivery. | | [Header](#header-event-imap-component) | This event is fired every time a header line comes in. | | [IdleInfo](#idleinfo-event-imap-component) | This event fires whenever responses from the server are received while idling. | | [LaunchBrowser](#launchbrowser-event-imap-component) | Fires before launching a browser with the authorization URL. | | [Log](#log-event-imap-component) | Fired once for each log message. | | [MailboxACL](#mailboxacl-event-imap-component) | This event fires for each set of access control rights returned by the server. | | [MailboxList](#mailboxlist-event-imap-component) | This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. | | [MessageInfo](#messageinfo-event-imap-component) | This event is fired with information for the messages retrieved by the server. | | [MessagePart](#messagepart-event-imap-component) | This event is fired for each message part when RetrieveMessageInfo is called. | | [PITrail](#pitrail-event-imap-component) | This event traces the commands sent to the mail server, and the respective replies. | | [SSLServerAuthentication](#sslserverauthentication-event-imap-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-imap-component) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-imap-component) | This event is fired when the message body or the part data start transferring. | | [Transfer](#transfer-event-imap-component) | This event is fired while the message is transferred from the MailServer . | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AlwaysReturnUIDs](#AlwaysReturnUIDs) | Instructs the server to return UIDs even if not in UIDMode. | | [AppendToMailboxDateTime](#AppendToMailboxDateTime) | Specifies the date-time parameter used in the initial APPEND request. | | [AuthorizationIdentity](#AuthorizationIdentity) | The value to use as the authorization identity when SASL authentication is used. | | [AutoDecodeSubject](#AutoDecodeSubject) | Instructs the class to automatically decode message subjects. | | [AutoDecodeText](#AutoDecodeText) | Whether to decode MessageText when AutoDecodeParts is True. | | [IncludeHeaders](#IncludeHeaders) | Instructs the class to include the headers in the LocalFile. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive properties should be masked when logging. | | [RetrieveAfterSearch](#RetrieveAfterSearch) | Determines if messages matching the SearchCriteria are retrieved after calling SearchMailbox. | | [RetrieveTextAndHeaders](#RetrieveTextAndHeaders) | Specifies whether the message body and headers are retrieved in a single request. | | [SendIDCommand](#SendIDCommand) | Instructs class to send the ID command if the server advertises support for it. | | [UTF7MailboxNames](#UTF7MailboxNames) | Specifies whether or not to automatically encode and decode UTF-7 mailbox names. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AuthMechanism Property ([IMAP](#imap-component) Component) This property includes the authentication mechanism to be used when connecting to the mail server. ## Syntax *Go Syntax* ```text func (obj *IMAP) AuthMechanism() (int32, error)func (obj *IMAP) SetAuthMechanism(value int32) error ``` ## Possible Values ```text 0 // UserPassword1 // CRAMMD52 // NTLM3 // APOP4 // SASLPlain5 // SASLDigestMD56 // Kerberos7 // XOAUTH2 ``` ## Default Value 0 ## Remarks | Auth Mechanism | Description | | --- | --- | | 0 (amUserPassword - Default) | A user/password pair is sent in plaintext to login (default). | | 1 (amCRAMMD5) | CRAM-MD5 authentication. | | 2 (amNTLM) | NTLM authentication. | | 4 (amSASLPlain) | SASLPlain. NOTE: Servers often require the Secure Sockets Layer (SSL) to be used when this authentication mechanism is requested. See [AuthorizationIdentity](#AuthorizationIdentity). | | 5 (amSASLDigestMD5) | SASLDigestMD5. See [AuthorizationIdentity](#AuthorizationIdentity). | | 6 (amKerberos) | Kerberos authentication. This option is available in Windows or other platforms when using the Java edition. | | 7 (mXOAUTH) | XOAUTH2 authentication. See [AuthorizationIdentity](#AuthorizationIdentity). | ## Data Type **int32** # AutoDecodeParts Property ([IMAP](#imap-component) Component) This property determines whether or not to automatically decode message parts. ## Syntax *Go Syntax* ```text func (obj *IMAP) AutoDecodeParts() (bool, error)func (obj *IMAP) SetAutoDecodeParts(value bool) error ``` ## Default Value false ## Remarks This property determines whether or not to automatically decode message parts. Message parts, especially binary message parts, are normally sent by the server encoded (Base64 or other format). If this setting is True, the parts are automatically decoded while being received. ## Data Type **bool** # Connected Property ([IMAP](#imap-component) Component) Whether the class is connected. ## Syntax *Go Syntax* ```text func (obj *IMAP) Connected() (bool, error) ``` ## Default Value false ## Remarks This property is used to determine whether or not the struct is connected to the remote host. Use the [Connect](#connect-method-imap-component) and [Disconnect](#disconnect-method-imap-component) methods to manage the connection. This property is read-only. ## Data Type **bool** # EndByte Property ([IMAP](#imap-component) Component) This property includes the byte index of the position where the transfer should end. ## Syntax *Go Syntax* ```text func (obj *IMAP) EndByte() (int64, error)func (obj *IMAP) SetEndByte(value int64) error ``` ## Default Value 0 ## Remarks [StartByte](#startbyte-property-imap-component) and EndByte are used together with the [RetrieveMessagePart](#retrievemessagepart-method-imap-component) method to specify the portion of the message to be retrieved from the server. When [StartByte](#startbyte-property-imap-component) or EndByte contain values other than the default (0), only the corresponding portion of the message is retrieved from the server. Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message. ## Data Type **int64** # FirewallAutoDetect Property ([IMAP](#imap-component) Component) Whether to automatically detect and use firewall system settings, if available. ## Syntax *Go Syntax* ```text func (obj *IMAP) FirewallAutoDetect() (bool, error)func (obj *IMAP) SetFirewallAutoDetect(value bool) error ``` ## Default Value false ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type **bool** # FirewallType Property ([IMAP](#imap-component) Component) The type of firewall to connect through. ## Syntax *Go Syntax* ```text func (obj *IMAP) FirewallType() (int32, error)func (obj *IMAP) SetFirewallType(value int32) error ``` ## Possible Values ```text 0 // None1 // Tunnel2 // SOCKS43 // SOCKS510 // SOCKS4A ``` ## Default Value 0 ## Remarks The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [FirewallPort](#firewallport-property-imap-component) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [FirewallPort](#firewallport-property-imap-component) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [FirewallPort](#firewallport-property-imap-component) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [FirewallPort](#firewallport-property-imap-component) is set to 1080. | ## Data Type **int32** # FirewallHost Property ([IMAP](#imap-component) Component) The name or IP address of the firewall (optional). ## Syntax *Go Syntax* ```text func (obj *IMAP) FirewallHost() (string, error)func (obj *IMAP) SetFirewallHost(value string) error ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [FirewallHost](#firewallhost-property-imap-component) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error. ## Data Type **string** # FirewallPassword Property ([IMAP](#imap-component) Component) A password if authentication is to be used when connecting through the firewall. ## Syntax *Go Syntax* ```text func (obj *IMAP) FirewallPassword() (string, error)func (obj *IMAP) SetFirewallPassword(value string) error ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [FirewallHost](#firewallhost-property-imap-component) is specified, the [FirewallUser](#firewalluser-property-imap-component) and [FirewallPassword](#firewallpassword-property-imap-component) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. ## Data Type **string** # FirewallPort Property ([IMAP](#imap-component) Component) The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax *Go Syntax* ```text func (obj *IMAP) FirewallPort() (int32, error)func (obj *IMAP) SetFirewallPort(value int32) error ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [FirewallHost](#firewallhost-property-imap-component). See the description of the [FirewallHost](#firewallhost-property-imap-component) property for details. NOTE: This property is set automatically when [FirewallType](#firewalltype-property-imap-component) is set to a valid value. See the description of the [FirewallType](#firewalltype-property-imap-component) property for details. ## Data Type **int32** # FirewallUser Property ([IMAP](#imap-component) Component) A username if authentication is to be used when connecting through a firewall. ## Syntax *Go Syntax* ```text func (obj *IMAP) FirewallUser() (string, error)func (obj *IMAP) SetFirewallUser(value string) error ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [FirewallHost](#firewallhost-property-imap-component) is specified, this property and the [FirewallPassword](#firewallpassword-property-imap-component) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error. ## Data Type **string** # Idle Property ([IMAP](#imap-component) Component) The current status of the class. ## Syntax *Go Syntax* ```text func (obj *IMAP) Idle() (bool, error) ``` ## Default Value true ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. ## Data Type **bool** # LastReply Property ([IMAP](#imap-component) Component) This property indicates the last reply received from the server. ## Syntax *Go Syntax* ```text func (obj *IMAP) LastReply() (string, error) ``` ## Default Value "" ## Remarks This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the [PITrail](#pitrail-event-imap-component) event. This property is read-only. ## Data Type **string** # LocalFile Property ([IMAP](#imap-component) Component) This property includes the path to a local file for downloading the message body. ## Syntax *Go Syntax* ```text func (obj *IMAP) LocalFile() (string, error)func (obj *IMAP) SetLocalFile(value string) error ``` ## Default Value "" ## Remarks This property is used when retrieving a message. If the file exists, and the [Overwrite](#overwrite-property-imap-component) property is set to true, then the component will overwrite the file. If this property is empty, then the received data is provided through the [MessageText](#messagetext-property-imap-component) property and the parameters for the [Transfer](#transfer-event-imap-component) event. ## Data Type **string** # LocalHost Property ([IMAP](#imap-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Go Syntax* ```text func (obj *IMAP) LocalHost() (string, error)func (obj *IMAP) SetLocalHost(value string) error ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the struct is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. ## Data Type **string** # Mailbox Property ([IMAP](#imap-component) Component) This property includes the name of the mailbox selected on the server. ## Syntax *Go Syntax* ```text func (obj *IMAP) Mailbox() (string, error)func (obj *IMAP) SetMailbox(value string) error ``` ## Default Value "Inbox" ## Remarks This method contains the name of the mailbox selected on the server and also is used as argument to most methods. Please refer to the struct methods for more information. **Example 1. Open a Mailbox in Read/Write Mode:** ```text IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox ``` **Example 2. Open a Mailbox in Read-Only Mode:** ```text IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox ``` ## Data Type **string** # MailboxFlags Property ([IMAP](#imap-component) Component) This property defines flags in the selected mailbox. ## Syntax *Go Syntax* ```text func (obj *IMAP) MailboxFlags() (string, error) ``` ## Default Value "" ## Remarks This property defines flags in the selected mailbox. The struct fills out [MessageCount](#messagecount-property-imap-component), [RecentMessageCount](#recentmessagecount-property-imap-component), and MailboxFlags after connecting to the [MailServer](#mailserver-property-imap-component) and selecting or examining a [Mailbox](#mailbox-property-imap-component). This property is read-only. ## Data Type **string** # MailboxListCount Property ([IMAP](#imap-component) Component) The number of records in the MailboxList arrays. ## Syntax *Go Syntax* ```text func (obj *IMAP) MailboxListCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [MailboxListFlags](#mailboxlistflags-property-imap-component) - [MailboxListName](#mailboxlistname-property-imap-component) - [MailboxListSeparator](#mailboxlistseparator-property-imap-component) The array indices start at *0* and end at *MailboxListCount - 1*. This property is read-only. ## Data Type **int32** # MailboxListFlags Property ([IMAP](#imap-component) Component) This property contains the mailbox flags in a mailbox listing. ## Syntax *Go Syntax* ```text func (obj *IMAP) MailboxListFlags(MailboxListIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the mailbox flags in a mailbox listing. Examples of possible flag values are server dependent, but they can include the following: | | | | --- | --- | | \Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). | | \Seen | Mark a message as read. | | \Answered | Mark a message as answered. | | \Flagged | Mark a message as flagged. | | \Draft | Mark a message as being incomplete (under composition). | The *MailboxListIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MailboxListCount](#mailboxlistcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MailboxListName Property ([IMAP](#imap-component) Component) This property contains the mailbox name in a mailbox listing. ## Syntax *Go Syntax* ```text func (obj *IMAP) MailboxListName(MailboxListIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the mailbox name in a mailbox listing. The *MailboxListIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MailboxListCount](#mailboxlistcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MailboxListSeparator Property ([IMAP](#imap-component) Component) The Separator property contains the character that separates the different parts in the mailbox path hierarchy. ## Syntax *Go Syntax* ```text func (obj *IMAP) MailboxListSeparator(MailboxListIndex int32) (string, error) ``` ## Default Value "" ## Remarks The [MailboxListSeparator](#mailboxlistseparator-property-imap-component) property contains the character that separates the different parts in the mailbox path hierarchy. The *MailboxListIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MailboxListCount](#mailboxlistcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MailPort Property ([IMAP](#imap-component) Component) This property includes the port of the IMAP server (default is 143). ## Syntax *Go Syntax* ```text func (obj *IMAP) MailPort() (int32, error)func (obj *IMAP) SetMailPort(value int32) error ``` ## Default Value 143 ## Remarks A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error. For the implicit Secure Sockets Layer (SSL), use port 993 (please refer to the [SSLStartMode](#sslstartmode-property-imap-component) property for more information). ## Data Type **int32** # MailServer Property ([IMAP](#imap-component) Component) This property includes the name or address of the mail server (IMAP server). ## Syntax *Go Syntax* ```text func (obj *IMAP) MailServer() (string, error)func (obj *IMAP) SetMailServer(value string) error ``` ## Default Value "" ## Remarks This property specifies the IP address (IP number in dotted internet format) or domain name of the mail server. It must be set before a connection is attempted and cannot be changed once a connection is in progress. If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the MailServer property is set to the corresponding address. If the search is not successful, an error is returned. If the struct is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. ## Data Type **string** # Message Property ([IMAP](#imap-component) Component) This property provides the raw message content. ## Syntax *Go Syntax* ```text func (obj *IMAP) Message() ([]byte, error)func (obj *IMAP) SetMessage(value []byte) error ``` ## Default Value "" ## Remarks This property is populated after calling [RetrieveMessagePart](#retrievemessagepart-method-imap-component) and holds the raw message content. This can be used to access the data before any processing is done by the struct. ## Data Type **[]byte** # MessageContentEncoding Property ([IMAP](#imap-component) Component) This property includes the ContentEncoding of the selected message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageContentEncoding() (string, error) ``` ## Default Value "" ## Remarks The property is automatically set by the struct when message information is retrieved through the [RetrieveMessageInfo](#retrievemessageinfo-method-imap-component) method. This property is read-only. ## Data Type **string** # MessageContentType Property ([IMAP](#imap-component) Component) This property includes the ContentType of the message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageContentType() (string, error) ``` ## Default Value "" ## Remarks This property denotes the type of content contained in the message, such as plain, multipart, or multipart/alternative. You also may need to check the [MessageContentEncoding](#messagecontentencoding-property-imap-component) property or read the individual message parts. This property is read-only. ## Data Type **string** # MessageCount Property ([IMAP](#imap-component) Component) This property includes the total number of messages on the Mailbox . ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageCount() (int32, error) ``` ## Default Value 0 ## Remarks This property contains the total number of messages on the [Mailbox](#mailbox-property-imap-component). The struct fills out MessageCount, [RecentMessageCount](#recentmessagecount-property-imap-component), and [MailboxFlags](#mailboxflags-property-imap-component) after connecting to the [MailServer](#mailserver-property-imap-component) and selecting or examining a [Mailbox](#mailbox-property-imap-component). This property is read-only. ## Data Type **int32** # MessageDate Property ([IMAP](#imap-component) Component) The property includes the time the message was created. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageDate() (string, error) ``` ## Default Value "" ## Remarks This property contains the date and time when the message was created. This value is taken from the *ENVELOPE* structure of the message corresponding to the date. RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST". This property is read-only. ## Data Type **string** # MessageDeliveryTime Property ([IMAP](#imap-component) Component) This property includes the time the message was delivered to the mail server. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageDeliveryTime() (string, error) ``` ## Default Value "" ## Remarks This property contains the time the message was delivered to the mail server. This value is taken from the *INTERNALDATE* property of the message. The time format is defined in RFC 821. This property is read-only. ## Data Type **string** # MessageFlags Property ([IMAP](#imap-component) Component) This property contains the flags of the current message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageFlags() (string, error)func (obj *IMAP) SetMessageFlags(value string) error ``` ## Default Value "" ## Remarks This property contains the flags of the current message. It also is used to specify flags when [AppendToMailbox](#appendtomailbox-method-imap-component) is called. Examples of possible flag values are server dependent, but they can include the following: | | | | --- | --- | | \Deleted | Mark a message as deleted (for removal later by [ExpungeMailbox](#expungemailbox-method-imap-component)). | | \Seen | Mark a message as read. | | \Answered | Mark a message as answered. | | \Flagged | Mark a message as flagged. | | \Draft | Mark a message as being incomplete (under composition). | **Example. Setting MessageFlags:** ```text IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted") ``` ## Data Type **string** # MessageFrom Property ([IMAP](#imap-component) Component) This property includes the address of the author of the message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageFrom() (string, error) ``` ## Default Value "" ## Remarks This property normally has the same value as [MessageSender](#messagesender-property-imap-component). In some cases, a message may have more than one *From* address. If this is the case, the addresses are provided in the MessageFrom property and are separated by commas. This property is read-only. ## Data Type **string** # MessageHeaderCount Property ([IMAP](#imap-component) Component) The number of records in the MessageHeader arrays. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageHeaderCount() (int32, error)func (obj *IMAP) SetMessageHeaderCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [MessageHeaderField](#messageheaderfield-property-imap-component) - [MessageHeaderValue](#messageheadervalue-property-imap-component) The array indices start at *0* and end at *MessageHeaderCount - 1*. ## Data Type **int32** # MessageHeaderField Property ([IMAP](#imap-component) Component) This property contains the name of the HTTP header (this is the same case as it is delivered). ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageHeaderField(MessageHeaderIndex int32) (string, error)func (obj *IMAP) SetMessageHeaderField(MessageHeaderIndex int32, value string) error ``` ## Default Value "" ## Remarks This property contains the name of the HTTP [Header](#Type_Header) (this is the same case as it is delivered). The *MessageHeaderIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageHeaderCount](#messageheadercount-property-imap-component) property. ## Data Type **string** # MessageHeaderValue Property ([IMAP](#imap-component) Component) This property contains the header contents. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageHeaderValue(MessageHeaderIndex int32) (string, error)func (obj *IMAP) SetMessageHeaderValue(MessageHeaderIndex int32, value string) error ``` ## Default Value "" ## Remarks This property contains the [Header](#Type_Header) contents. The *MessageHeaderIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageHeaderCount](#messageheadercount-property-imap-component) property. ## Data Type **string** # MessageHeadersString Property ([IMAP](#imap-component) Component) This property includes the string version of the RFC 822-encoded headers in the message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageHeadersString() (string, error)func (obj *IMAP) SetMessageHeadersString(value string) error ``` ## Default Value "" ## Remarks This property contains the full headers of the message in RFC 822 format. The headers are retrieved by calling the [RetrieveMessageHeaders](#retrievemessageheaders-method-imap-component) or the [RetrieveMessagePartHeaders](#retrievemessagepartheaders-method-imap-component) method. ## Data Type **string** # MessageId Property ([IMAP](#imap-component) Component) This property includes the message identifier of the current message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageId() (string, error) ``` ## Default Value "" ## Remarks The struct fills out this property when message information is retrieved from the [MailServer](#mailserver-property-imap-component). This Id is permanent if [UIDMode](#uidmode-property-imap-component) is set, and otherwise is temporary. This property is read-only. ## Data Type **string** # MessageInfoCount Property ([IMAP](#imap-component) Component) The number of records in the MessageInfo arrays. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageInfoCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [MessageInfoDate](#messageinfodate-property-imap-component) - [MessageInfoFlags](#messageinfoflags-property-imap-component) - [MessageInfoFrom](#messageinfofrom-property-imap-component) - [MessageInfoMessageId](#messageinfomessageid-property-imap-component) - [MessageInfoSize](#messageinfosize-property-imap-component) - [MessageInfoSubject](#messageinfosubject-property-imap-component) The array indices start at *0* and end at *MessageInfoCount - 1*. This property is read-only. ## Data Type **int32** # MessageInfoDate Property ([IMAP](#imap-component) Component) This property contains the date of a message in a message information listing. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageInfoDate(MessageInfoIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the date of a message in a message information listing. This date is taken from the *ENVELOPE* structure of the message. The *MessageInfoIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageInfoCount](#messageinfocount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessageInfoFlags Property ([IMAP](#imap-component) Component) This property contains a message flag in a message information listing. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageInfoFlags(MessageInfoIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains a message flag in a message information listing. Examples of possible flag values are server dependent, but they can include the following: | | | | --- | --- | | \Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). | | \Seen | Mark a message as read. | | \Answered | Mark a message as answered. | | \Flagged | Mark a message as flagged. | | \Draft | Mark a message as being incomplete (under composition). | The *MessageInfoIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageInfoCount](#messageinfocount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessageInfoFrom Property ([IMAP](#imap-component) Component) This property contains the sender of a message in a message information listing. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageInfoFrom(MessageInfoIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the sender of a message in a message information listing. The *MessageInfoIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageInfoCount](#messageinfocount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessageInfoMessageId Property ([IMAP](#imap-component) Component) The unique identifier of a message in a message information listing. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageInfoMessageId(MessageInfoIndex int32) (string, error) ``` ## Default Value "" ## Remarks The unique identifier of a message in a message information listing. The *MessageInfoIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageInfoCount](#messageinfocount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessageInfoSize Property ([IMAP](#imap-component) Component) This property contains the size of a message in a message information listing. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageInfoSize(MessageInfoIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks This property contains the size of a message in a message information listing. The *MessageInfoIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageInfoCount](#messageinfocount-property-imap-component) property. This property is read-only. ## Data Type **int64** # MessageInfoSubject Property ([IMAP](#imap-component) Component) This property contains the subject of a message in a message information listing. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageInfoSubject(MessageInfoIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the subject of a message in a message information listing. The *MessageInfoIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageInfoCount](#messageinfocount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessageInReplyTo Property ([IMAP](#imap-component) Component) This property includes the unique message identifier of the message being replied to. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageInReplyTo() (string, error) ``` ## Default Value "" ## Remarks The struct fills out this property with the value of the *In-Reply-To:* message header. This value can be useful when threading messages by referring to the message being replied to. The unique message identifier of the message itself is given by the [MessageNetId](#messagenetid-property-imap-component) property. This property is read-only. ## Data Type **string** # MessageNetId Property ([IMAP](#imap-component) Component) This property includes the globally unique identifier of the message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageNetId() (string, error) ``` ## Default Value "" ## Remarks This property contains the globally unique identifier of the message. The struct fills the MessageNetId with the value of the *Message-Id:* header. This is a globally unique value normally created by the first mail server the message is sent to. This property is read-only. ## Data Type **string** # MessagePartCount Property ([IMAP](#imap-component) Component) The number of records in the MessagePart arrays. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [MessagePartContentDisposition](#messagepartcontentdisposition-property-imap-component) - [MessagePartContentEncoding](#messagepartcontentencoding-property-imap-component) - [MessagePartContentId](#messagepartcontentid-property-imap-component) - [MessagePartContentType](#messagepartcontenttype-property-imap-component) - [MessagePartFileName](#messagepartfilename-property-imap-component) - [MessagePartId](#messagepartid-property-imap-component) - [MessagePartMultipartMode](#messagepartmultipartmode-property-imap-component) - [MessagePartParameters](#messagepartparameters-property-imap-component) - [MessagePartSize](#messagepartsize-property-imap-component) The array indices start at *0* and end at *MessagePartCount - 1*. This property is read-only. ## Data Type **int32** # MessagePartContentDisposition Property ([IMAP](#imap-component) Component) This property shows the value of the Content-Disposition header of the message part. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartContentDisposition(MessagePartIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property shows the value of the Content-Disposition header of the message part. The *MessagePartIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePartCount](#messagepartcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessagePartContentEncoding Property ([IMAP](#imap-component) Component) This property shows how the data are encoded. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartContentEncoding(MessagePartIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property shows how the data are encoded. The *MessagePartIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePartCount](#messagepartcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessagePartContentId Property ([IMAP](#imap-component) Component) This property shows the value of the Content-Id header of the message part. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartContentId(MessagePartIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property shows the value of the Content-Id header of the message part. The *MessagePartIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePartCount](#messagepartcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessagePartContentType Property ([IMAP](#imap-component) Component) This property shows the type of data contained in the message part. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartContentType(MessagePartIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property shows the type of data contained in the message part. The *MessagePartIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePartCount](#messagepartcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessagePartFileName Property ([IMAP](#imap-component) Component) This property shows the filename corresponding to the part (if the part was included in the message as an attached file). ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartFileName(MessagePartIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property shows the filename corresponding to the part (if the part was included in the message as an attached file). The *MessagePartIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePartCount](#messagepartcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessagePartId Property ([IMAP](#imap-component) Component) This property contains the identifier of a part listing that may be identified in other parts or messages. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartId(MessagePartIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the identifier of a part listing that may be identified in other parts or messages. The format of part identifiers is specified by the IMAP RFCs. The *MessagePartIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePartCount](#messagepartcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessagePartMultipartMode Property ([IMAP](#imap-component) Component) This property shows how this part relates to the message's whole multipart structure (e. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartMultipartMode(MessagePartIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property shows how this part relates to the message's whole multipart structure (e.g., 'mixed' or 'alternative'). The *MessagePartIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePartCount](#messagepartcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessagePartParameters Property ([IMAP](#imap-component) Component) This property contains the additional parameters passed to the ContentType header, such as the part charset. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartParameters(MessagePartIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the additional parameters passed to the ContentType header, such as the part charset. The *MessagePartIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePartCount](#messagepartcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessagePartSize Property ([IMAP](#imap-component) Component) This property contains the size of a part in a message part listing. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessagePartSize(MessagePartIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks This property contains the size of a part in a message part listing. The *MessagePartIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePartCount](#messagepartcount-property-imap-component) property. This property is read-only. ## Data Type **int64** # MessageRecipientCount Property ([IMAP](#imap-component) Component) The number of records in the MessageRecipient arrays. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageRecipientCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [MessageRecipientAddress](#messagerecipientaddress-property-imap-component) - [MessageRecipientName](#messagerecipientname-property-imap-component) - [MessageRecipientOptions](#messagerecipientoptions-property-imap-component) - [MessageRecipientType](#messagerecipienttype-property-imap-component) The array indices start at *0* and end at *MessageRecipientCount - 1*. This property is read-only. ## Data Type **int32** # MessageRecipientAddress Property ([IMAP](#imap-component) Component) This property contains the email address of the recipient. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageRecipientAddress(RecipientIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the email address of the recipient. The *RecipientIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageRecipientCount](#messagerecipientcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessageRecipientName Property ([IMAP](#imap-component) Component) This property contains the name of the recipient. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageRecipientName(RecipientIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the name of the recipient. The *RecipientIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageRecipientCount](#messagerecipientcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessageRecipientOptions Property ([IMAP](#imap-component) Component) This property contains the recipient sending options (used only by SMTP). ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageRecipientOptions(RecipientIndex int32) (string, error) ``` ## Default Value "" ## Remarks This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by [SMTP](#SMTP)). One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891. ```text component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY"; ``` The *RecipientIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageRecipientCount](#messagerecipientcount-property-imap-component) property. This property is read-only. ## Data Type **string** # MessageRecipientType Property ([IMAP](#imap-component) Component) This property contains the recipient type: To, Cc, or Bcc. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageRecipientType(RecipientIndex int32) (int32, error) ``` ## Possible Values ```text 0 // To1 // Cc2 // BCc ``` ## Default Value 0 ## Remarks This property contains the recipient type: To, Cc, or Bcc. The *RecipientIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageRecipientCount](#messagerecipientcount-property-imap-component) property. This property is read-only. ## Data Type **int32** # MessageReplyTo Property ([IMAP](#imap-component) Component) This property includes the email addresses to which replies to the message should be sent. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageReplyTo() (string, error) ``` ## Default Value "" ## Remarks This property contains the email addresses to which replies to the message should be sent. In some cases, a message may have more than one *Reply-To* address. If this is the case, the addresses are provided in this property and are separated by commas. This property is read-only. ## Data Type **string** # MessageSender Property ([IMAP](#imap-component) Component) This property includes the address of the sender of the message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageSender() (string, error) ``` ## Default Value "" ## Remarks This property contains the address of the sender of the message. This normally is the same value as [MessageFrom](#messagefrom-property-imap-component). In some cases, a message may have more than one sender. If this is the case, the addresses are provided in the MessageSender property and are separated by commas. This property is read-only. ## Data Type **string** # MessageSet Property ([IMAP](#imap-component) Component) This property includes the set of messages to operate on. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageSet() (string, error)func (obj *IMAP) SetMessageSet(value string) error ``` ## Default Value "" ## Remarks This property indicates the set of messages to operate on. This is used as an argument to most method calls. It may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10"). **Example 1. Setting MessageSet:** ```text IMAPControl.MessageSet = "1" IMAPControl.RetrieveMessageInfo() IMAPControl.MessageSet = "1:5" IMAPControl.RetrieveMessageInfo() IMAPControl.MessageSet = "1,5,7" IMAPControl.RetrieveMessageInfo() ``` ## Data Type **string** # MessageSize Property ([IMAP](#imap-component) Component) This property includes the size of the selected message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageSize() (int64, error) ``` ## Default Value 0 ## Remarks The struct fills out this property with the size of the selected message when message information is retrieved from the [MailServer](#mailserver-property-imap-component). This property is read-only. ## Data Type **int64** # MessageSubject Property ([IMAP](#imap-component) Component) This property includes the subject of the message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageSubject() (string, error) ``` ## Default Value "" ## Remarks The struct fills out this property with the subject of the message when message information is retrieved from the [MailServer](#mailserver-property-imap-component). This property is read-only. ## Data Type **string** # MessageText Property ([IMAP](#imap-component) Component) This property includes the body of the retrieved message. ## Syntax *Go Syntax* ```text func (obj *IMAP) MessageText() (string, error)func (obj *IMAP) SetMessageText(value string) error ``` ## Default Value "" ## Remarks The struct fills out this property with the contents of the message body (in RFC 822 format) when a call to [RetrieveMessageText](#retrievemessagetext-method-imap-component) completes successfully and the [LocalFile](#localfile-property-imap-component) property is not set. ## Data Type **string** # OAuthAccessToken Property ([IMAP](#imap-component) Component) The access token returned by the authorization server. ## Syntax *Go Syntax* ```text func (obj *IMAP) OAuthAccessToken() (string, error)func (obj *IMAP) SetOAuthAccessToken(value string) error ``` ## Default Value "" ## Remarks The access token returned by the authorization server. This is set when the struct makes a request to the token server. ## Data Type **string** # OAuthAuthorizationScope Property ([IMAP](#imap-component) Component) The scope request or response parameter used during authorization. ## Syntax *Go Syntax* ```text func (obj *IMAP) OAuthAuthorizationScope() (string, error)func (obj *IMAP) SetOAuthAuthorizationScope(value string) error ``` ## Default Value "" ## Remarks The scope request or response parameter used during authorization. ## Data Type **string** # OAuthClientId Property ([IMAP](#imap-component) Component) The id of the client assigned when registering the application. ## Syntax *Go Syntax* ```text func (obj *IMAP) OAuthClientId() (string, error)func (obj *IMAP) SetOAuthClientId(value string) error ``` ## Default Value "" ## Remarks The id of the client assigned when registering the application. ## Data Type **string** # OAuthClientSecret Property ([IMAP](#imap-component) Component) The secret value for the client assigned when registering the application. ## Syntax *Go Syntax* ```text func (obj *IMAP) OAuthClientSecret() (string, error)func (obj *IMAP) SetOAuthClientSecret(value string) error ``` ## Default Value "" ## Remarks The secret value for the client assigned when registering the application. ## Data Type **string** # OAuthRefreshToken Property ([IMAP](#imap-component) Component) Specifies the refresh token received from or sent to the authorization server. ## Syntax *Go Syntax* ```text func (obj *IMAP) OAuthRefreshToken() (string, error)func (obj *IMAP) SetOAuthRefreshToken(value string) error ``` ## Default Value "" ## Remarks Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens. ## Data Type **string** # OAuthReturnURL Property ([IMAP](#imap-component) Component) The URL where the user (browser) returns after authenticating. ## Syntax *Go Syntax* ```text func (obj *IMAP) OAuthReturnURL() (string, error)func (obj *IMAP) SetOAuthReturnURL(value string) error ``` ## Default Value "" ## Remarks The URL where the user (browser) returns after authenticating. This property is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the struct when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing. ## Data Type **string** # OAuthServerAuthURL Property ([IMAP](#imap-component) Component) The URL of the authorization server. ## Syntax *Go Syntax* ```text func (obj *IMAP) OAuthServerAuthURL() (string, error)func (obj *IMAP) SetOAuthServerAuthURL(value string) error ``` ## Default Value "" ## Remarks The URL of the authorization server. ## Data Type **string** # OAuthServerTokenURL Property ([IMAP](#imap-component) Component) The URL of the token server used to obtain the access token. ## Syntax *Go Syntax* ```text func (obj *IMAP) OAuthServerTokenURL() (string, error)func (obj *IMAP) SetOAuthServerTokenURL(value string) error ``` ## Default Value "" ## Remarks The URL of the token server used to obtain the access token. ## Data Type **string** # Overwrite Property ([IMAP](#imap-component) Component) This property indicates whether or not the class should overwrite files during transfer. ## Syntax *Go Syntax* ```text func (obj *IMAP) Overwrite() (bool, error)func (obj *IMAP) SetOverwrite(value bool) error ``` ## Default Value false ## Remarks This property is a value indicating whether or not the struct should overwrite files when downloading the message text or a message part and [LocalFile](#localfile-property-imap-component) is set. If Overwrite is False, an error will be thrown whenever [LocalFile](#localfile-property-imap-component) exists. ## Data Type **bool** # Password Property ([IMAP](#imap-component) Component) This property includes the password to be used to authenticate to the MailServer . ## Syntax *Go Syntax* ```text func (obj *IMAP) Password() (string, error)func (obj *IMAP) SetPassword(value string) error ``` ## Default Value "" ## Remarks This property contains the password used to authenticate to the [MailServer](#mailserver-property-imap-component). Both the [User](#user-property-imap-component) and Password properties must be set before connecting to the [MailServer](#mailserver-property-imap-component). ## Data Type **string** # PeekMode Property ([IMAP](#imap-component) Component) When set to True, the message Seen flag is not changed during reading. ## Syntax *Go Syntax* ```text func (obj *IMAP) PeekMode() (bool, error)func (obj *IMAP) SetPeekMode(value bool) error ``` ## Default Value false ## Remarks This property contains a True or False to determine whether or not this message should be seen. When this property is set to True, a *PEEK* option is added to all IMAP *FETCH* commands sent to the server. In this case, an RFC-compliant IMAP server should not set the *Seen* flag on the message. ## Data Type **bool** # RecentMessageCount Property ([IMAP](#imap-component) Component) This property includes the number of new messages in the Mailbox . ## Syntax *Go Syntax* ```text func (obj *IMAP) RecentMessageCount() (int32, error) ``` ## Default Value 0 ## Remarks This property contains the number of new messages that are in the [Mailbox](#mailbox-property-imap-component). The struct fills out [MessageCount](#messagecount-property-imap-component), RecentMessageCount, and [MailboxFlags](#mailboxflags-property-imap-component) after connecting to the [MailServer](#mailserver-property-imap-component) and selecting or examining a [Mailbox](#mailbox-property-imap-component). This property is read-only. ## Data Type **int32** # SortCriteria Property ([IMAP](#imap-component) Component) This property sorts criteria to use for message retrieval operations. ## Syntax *Go Syntax* ```text func (obj *IMAP) SortCriteria() (string, error)func (obj *IMAP) SetSortCriteria(value string) error ``` ## Default Value "" ## Remarks This property sorts criteria to use for message retrieval operations. When set, the struct will send the *SORT* command to the server before any retrieval. If the server supports the *SORT* command, the results from the retrieve operation will be sorted according to SortCriteria. The format of the SortCriteria property consists of a parenthesized list of one or more sort keys. **Example. Setting SortCriteria:** ```text IMAPControl.SortCriteria = "DATE" IMAPControl.SortCriteria = "SUBJECT FROM" IMAPControl.SortCriteria = "REVERSE SUBJECT" ``` Possible sort keys include the following: | | | | --- | --- | | ARRIVAL | Internal date and time of the message. | | DATE | The value of the message's DATE header, adjusted by time zone. | | CC | The value of the message's CC header. | | FROM | The value of the message's FROM header. | | SUBJECT | The value of the message's SUBJECT header. | | TO | The value of the message's TO header. | | SIZE | The size of the message | | REVERSE | Followed by another sort criterion, this sort key has the effect of that criterion but in reverse (descending) order. | NOTE: IMAP SORT functionality is relatively new and not all servers may implement it. ## Data Type **string** # SSLAcceptServerCertEffectiveDate Property ([IMAP](#imap-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLAcceptServerCertExpirationDate Property ([IMAP](#imap-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLAcceptServerCertExtendedKeyUsage Property ([IMAP](#imap-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLAcceptServerCertFingerprint Property ([IMAP](#imap-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLAcceptServerCertFingerprintSHA1 Property ([IMAP](#imap-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLAcceptServerCertFingerprintSHA256 Property ([IMAP](#imap-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLAcceptServerCertIssuer Property ([IMAP](#imap-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPrivateKey Property ([IMAP](#imap-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-imap-component) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-imap-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPrivateKeyAvailable Property ([IMAP](#imap-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-imap-component) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-imap-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLAcceptServerCertPrivateKeyContainer Property ([IMAP](#imap-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-imap-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKey Property ([IMAP](#imap-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKeyAlgorithm Property ([IMAP](#imap-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKeyLength Property ([IMAP](#imap-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLAcceptServerCertSerialNumber Property ([IMAP](#imap-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLAcceptServerCertSignatureAlgorithm Property ([IMAP](#imap-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLAcceptServerCertStore Property ([IMAP](#imap-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertStore() ([]byte, error)func (obj *IMAP) SetSSLAcceptServerCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-imap-component) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-imap-component). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-imap-component). [SSLAcceptServerCertStore](#sslacceptservercertstore-property-imap-component) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-imap-component) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-imap-component) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-imap-component) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-imap-component) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-imap-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type **[]byte** # SSLAcceptServerCertStorePassword Property ([IMAP](#imap-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertStorePassword() (string, error)func (obj *IMAP) SetSSLAcceptServerCertStorePassword(value string) error ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type **string** # SSLAcceptServerCertStoreType Property ([IMAP](#imap-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertStoreType() (int32, error)func (obj *IMAP) SetSSLAcceptServerCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-imap-component), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-imap-component), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-imap-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-imap-component) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-imap-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # SSLAcceptServerCertSubjectAltNames Property ([IMAP](#imap-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintMD5 Property ([IMAP](#imap-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintSHA1 Property ([IMAP](#imap-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintSHA256 Property ([IMAP](#imap-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertUsage Property ([IMAP](#imap-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-imap-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLAcceptServerCertUsageFlags Property ([IMAP](#imap-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-imap-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-imap-component) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-imap-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLAcceptServerCertVersion Property ([IMAP](#imap-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLAcceptServerCertSubject Property ([IMAP](#imap-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertSubject() (string, error)func (obj *IMAP) SetSSLAcceptServerCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # SSLAcceptServerCertEncoded Property ([IMAP](#imap-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLAcceptServerCertEncoded() ([]byte, error)func (obj *IMAP) SetSSLAcceptServerCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-imap-component) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-imap-component) properties also may be used to specify a certificate. When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-imap-component) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-imap-component) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-imap-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-imap-component) is set to an empty string. ## Data Type **[]byte** # SSLCertEffectiveDate Property ([IMAP](#imap-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLCertExpirationDate Property ([IMAP](#imap-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLCertExtendedKeyUsage Property ([IMAP](#imap-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLCertFingerprint Property ([IMAP](#imap-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLCertFingerprintSHA1 Property ([IMAP](#imap-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLCertFingerprintSHA256 Property ([IMAP](#imap-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLCertIssuer Property ([IMAP](#imap-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLCertPrivateKey Property ([IMAP](#imap-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-imap-component) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-imap-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLCertPrivateKeyAvailable Property ([IMAP](#imap-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-imap-component) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-imap-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLCertPrivateKeyContainer Property ([IMAP](#imap-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-imap-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLCertPublicKey Property ([IMAP](#imap-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLCertPublicKeyAlgorithm Property ([IMAP](#imap-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLCertPublicKeyLength Property ([IMAP](#imap-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLCertSerialNumber Property ([IMAP](#imap-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLCertSignatureAlgorithm Property ([IMAP](#imap-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLCertStore Property ([IMAP](#imap-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertStore() ([]byte, error)func (obj *IMAP) SetSSLCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLCertStoreType](#sslcertstoretype-property-imap-component) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-imap-component). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-imap-component). [SSLCertStore](#sslcertstore-property-imap-component) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-imap-component) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-imap-component) has a value, and [SSLCertSubject](#sslcertsubject-property-imap-component) or [SSLCertEncoded](#sslcertencoded-property-imap-component) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-imap-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type **[]byte** # SSLCertStorePassword Property ([IMAP](#imap-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertStorePassword() (string, error)func (obj *IMAP) SetSSLCertStorePassword(value string) error ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type **string** # SSLCertStoreType Property ([IMAP](#imap-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertStoreType() (int32, error)func (obj *IMAP) SetSSLCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-imap-component), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-imap-component), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-imap-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-imap-component) and set [SSLCertStorePassword](#sslcertstorepassword-property-imap-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # SSLCertSubjectAltNames Property ([IMAP](#imap-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLCertThumbprintMD5 Property ([IMAP](#imap-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertThumbprintSHA1 Property ([IMAP](#imap-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertThumbprintSHA256 Property ([IMAP](#imap-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertUsage Property ([IMAP](#imap-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLCertUsageFlags](#sslcertusageflags-property-imap-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLCertUsageFlags Property ([IMAP](#imap-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-imap-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLCertUsage](#sslcertusage-property-imap-component) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-imap-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLCertVersion Property ([IMAP](#imap-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLCertSubject Property ([IMAP](#imap-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertSubject() (string, error)func (obj *IMAP) SetSSLCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # SSLCertEncoded Property ([IMAP](#imap-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLCertEncoded() ([]byte, error)func (obj *IMAP) SetSSLCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-imap-component) and [SSLCertSubject](#sslcertsubject-property-imap-component) properties also may be used to specify a certificate. When [SSLCertEncoded](#sslcertencoded-property-imap-component) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-imap-component) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-imap-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-imap-component) is set to an empty string. ## Data Type **[]byte** # SSLEnabled Property ([IMAP](#imap-component) Component) This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLEnabled() (bool, error)func (obj *IMAP) SetSSLEnabled(value bool) error ``` ## Default Value false ## Remarks This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled. TLS/SSL may also be enabled by setting [SSLStartMode](#sslstartmode-property-imap-component). Setting [SSLStartMode](#sslstartmode-property-imap-component) will automatically update this property value. ## Data Type **bool** # SSLProvider Property ([IMAP](#imap-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLProvider() (int32, error)func (obj *IMAP) SetSSLProvider(value int32) error ``` ## Possible Values ```text 0 // Automatic1 // Platform2 // Internal ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform. When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. ## Data Type **int32** # SSLServerCertEffectiveDate Property ([IMAP](#imap-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLServerCertExpirationDate Property ([IMAP](#imap-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLServerCertExtendedKeyUsage Property ([IMAP](#imap-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLServerCertFingerprint Property ([IMAP](#imap-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLServerCertFingerprintSHA1 Property ([IMAP](#imap-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLServerCertFingerprintSHA256 Property ([IMAP](#imap-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLServerCertIssuer Property ([IMAP](#imap-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLServerCertPrivateKey Property ([IMAP](#imap-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-imap-component) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-imap-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLServerCertPrivateKeyAvailable Property ([IMAP](#imap-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-imap-component) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-imap-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLServerCertPrivateKeyContainer Property ([IMAP](#imap-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-imap-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLServerCertPublicKey Property ([IMAP](#imap-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLServerCertPublicKeyAlgorithm Property ([IMAP](#imap-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLServerCertPublicKeyLength Property ([IMAP](#imap-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLServerCertSerialNumber Property ([IMAP](#imap-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLServerCertSignatureAlgorithm Property ([IMAP](#imap-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLServerCertStore Property ([IMAP](#imap-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertStore() ([]byte, error) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLServerCertStoreType](#sslservercertstoretype-property-imap-component) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-imap-component). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-imap-component). [SSLServerCertStore](#sslservercertstore-property-imap-component) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-imap-component) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-imap-component) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-imap-component) or [SSLServerCertEncoded](#sslservercertencoded-property-imap-component) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-imap-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). This property is read-only. ## Data Type **[]byte** # SSLServerCertStorePassword Property ([IMAP](#imap-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertStorePassword() (string, error) ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. This property is read-only. ## Data Type **string** # SSLServerCertStoreType Property ([IMAP](#imap-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertStoreType() (int32, error) ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-imap-component), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-imap-component), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-imap-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-imap-component) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-imap-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | This property is read-only. ## Data Type **int32** # SSLServerCertSubjectAltNames Property ([IMAP](#imap-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintMD5 Property ([IMAP](#imap-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintSHA1 Property ([IMAP](#imap-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintSHA256 Property ([IMAP](#imap-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertUsage Property ([IMAP](#imap-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-imap-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLServerCertUsageFlags Property ([IMAP](#imap-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-imap-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLServerCertUsage](#sslservercertusage-property-imap-component) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-imap-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLServerCertVersion Property ([IMAP](#imap-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLServerCertSubject Property ([IMAP](#imap-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertSubject() (string, error) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. This property is read-only. ## Data Type **string** # SSLServerCertEncoded Property ([IMAP](#imap-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLServerCertEncoded() ([]byte, error) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-imap-component) and [SSLServerCertSubject](#sslservercertsubject-property-imap-component) properties also may be used to specify a certificate. When [SSLServerCertEncoded](#sslservercertencoded-property-imap-component) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-imap-component) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-imap-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-imap-component) is set to an empty string. This property is read-only. ## Data Type **[]byte** # SSLStartMode Property ([IMAP](#imap-component) Component) This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. ## Syntax *Go Syntax* ```text func (obj *IMAP) SSLStartMode() (int32, error)func (obj *IMAP) SetSSLStartMode(value int32) error ``` ## Possible Values ```text 0 // Automatic1 // Implicit2 // Explicit3 // None ``` ## Default Value 3 ## Remarks The SSLStartMode property may have one of the following values: | | | | --- | --- | | 0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the struct will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). | | 1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. | | 2 (sslExplicit) | The struct will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. | | 3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. | ## Data Type **int32** # StartByte Property ([IMAP](#imap-component) Component) This property includes the byte index of the position where the transfer should start. ## Syntax *Go Syntax* ```text func (obj *IMAP) StartByte() (int64, error)func (obj *IMAP) SetStartByte(value int64) error ``` ## Default Value 0 ## Remarks StartByte and [EndByte](#endbyte-property-imap-component) are used together with the [RetrieveMessagePart](#retrievemessagepart-method-imap-component) method to specify the portion of the message to be retrieved from the server. When StartByte or [EndByte](#endbyte-property-imap-component) contain values other than the default (0), only the corresponding portion of the message is retrieved from the server. Byte indexes start from 1. The default value for [EndByte](#endbyte-property-imap-component) is 0, which corresponds to the end of the message. ## Data Type **int64** # Timeout Property ([IMAP](#imap-component) Component) The timeout for the class. ## Syntax *Go Syntax* ```text func (obj *IMAP) Timeout() (int32, error)func (obj *IMAP) SetTimeout(value int32) error ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the struct will wait for the operation to complete before returning control. The struct will use [DoEvents](#doevents-method-imap-component) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the struct fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. ## Data Type **int32** # UIDMode Property ([IMAP](#imap-component) Component) If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers. ## Syntax *Go Syntax* ```text func (obj *IMAP) UIDMode() (bool, error)func (obj *IMAP) SetUIDMode(value bool) error ``` ## Default Value false ## Remarks This property indicates if a permanent identifier should be used. Normally, the IMAP server uses temporary message identifiers that are valid only during the current session. If UIDMode is True, permanent message identifiers are used instead. The following IMAP protocol operations use the UID mode: *COPY*, *FETCH*, *STORE*, and *SEARCH*. ## Data Type **bool** # UIDValidity Property ([IMAP](#imap-component) Component) This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command. ## Syntax *Go Syntax* ```text func (obj *IMAP) UIDValidity() (string, error) ``` ## Default Value "" ## Remarks Every time a mailbox is selected, a UIDValidity is returned from the server. Most of the time, this value will not change from call to call. If it does change, this means that all previously returned UIDs for messages inside this mailbox are now invalid. This property is read-only. ## Data Type **string** # User Property ([IMAP](#imap-component) Component) This property includes the username used to authenticate to the MailServer . ## Syntax *Go Syntax* ```text func (obj *IMAP) User() (string, error)func (obj *IMAP) SetUser(value string) error ``` ## Default Value "" ## Remarks This property contains the username used to authenticate to the [MailServer](#mailserver-property-imap-component). Both the User and [Password](#password-property-imap-component) properties must be set before connecting to the [MailServer](#mailserver-property-imap-component). ## Data Type **string** # AddMessageFlags Method ([IMAP](#imap-component) Component) This method adds the specified flags to the messages specified by MessageSet . ## Syntax *Go Syntax* ```text func (obj *IMAP) AddMessageFlags(Flags string) error ``` ## Remarks This method adds the specified flags to the messages specified by the [MessageSet](#messageset-property-imap-component) property. The format of the flags is specified by the IMAP RFCs. Examples of possible flag values are server dependent, but they can include the following: | | | | --- | --- | | \Deleted | Mark a message as deleted (for removal later by [ExpungeMailbox](#expungemailbox-method-imap-component)). | | \Seen | Mark a message as read. | | \Answered | Mark a message as answered. | | \Flagged | Mark a message as flagged. | | \Draft | Mark a message as being incomplete (under composition). | **Example. Setting Adding Message Flags:** ```text IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted") ``` # AppendToMailbox Method ([IMAP](#imap-component) Component) This method appends the message in MessageText to the mailbox specified by Mailbox . ## Syntax *Go Syntax* ```text func (obj *IMAP) AppendToMailbox() error ``` ## Remarks This method appends the RFC 822-encoded message in [MessageText](#messagetext-property-imap-component) to the mailbox specified by [Mailbox](#mailbox-property-imap-component). If the [MessageFlags](#messageflags-property-imap-component) property is not an empty string, its contents are supplied with the *APPEND* command sent to the server. **Example. Append Message to Mailbox:** ```text IMAPControl.MessageText = MessageHeaders + CRLF + CRLF + MessageBody + CRLF IMAPControl.Mailbox = "INBOX" IMAPControl.MessageFlags = "\Deleted" IMAPControl.AppendToMailbox() ``` # CheckMailbox Method ([IMAP](#imap-component) Component) This method sends a CHECK command to the server. ## Syntax *Go Syntax* ```text func (obj *IMAP) CheckMailbox() error ``` ## Remarks This method sends a *CHECK* command to the server, asking it to perform any necessary housekeeping operations on and to update the state of the currently selected mailbox. # CloseMailbox Method ([IMAP](#imap-component) Component) This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox. ## Syntax *Go Syntax* ```text func (obj *IMAP) CloseMailbox() error ``` ## Remarks This method permanently removes all messages that have a 'Deleted' flag that have been set from the current (selected) mailbox. It then closes (deselected) the mailbox. # Config Method ([IMAP](#imap-component) Component) Sets or retrieves a configuration setting. ## Syntax *Go Syntax* ```text func (obj *IMAP) Config(ConfigurationString string) (string, error) ``` ## Remarks Config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-imap-component) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-imap-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Connect Method ([IMAP](#imap-component) Component) This method connects to an IMAP server. ## Syntax *Go Syntax* ```text func (obj *IMAP) Connect() error ``` ## Remarks This method connects to the IMAP server specified by [MailServer](#mailserver-property-imap-component) and authenticates it using the username and password supplied in the [User](#user-property-imap-component) and [Password](#password-property-imap-component) properties. **Example. Connect IMAP Server:** ```text IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect() IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "DOMAIN/USERNT/INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect() ``` # CopyToMailbox Method ([IMAP](#imap-component) Component) Copies the specified messages to another mailbox. ## Syntax *Go Syntax* ```text func (obj *IMAP) CopyToMailbox() error ``` ## Remarks This method copies the messages specified by the [MessageSet](#messageset-property-imap-component) property to the mailbox specified by the [Mailbox](#mailbox-property-imap-component) property. # CreateMailbox Method ([IMAP](#imap-component) Component) This method creates a new mailbox specified by Mailbox . ## Syntax *Go Syntax* ```text func (obj *IMAP) CreateMailbox() error ``` ## Remarks This method creates a new mailbox. The mailbox name is specified by the [Mailbox](#mailbox-property-imap-component) property. # DeleteFromMailbox Method ([IMAP](#imap-component) Component) The method marks the messages specified by MessageSet as deleted. ## Syntax *Go Syntax* ```text func (obj *IMAP) DeleteFromMailbox() error ``` ## Remarks This method marks the messages specified by [MessageSet](#messageset-property-imap-component) as deleted. Calling this method is equivalent to calling [AddMessageFlags](#addmessageflags-method-imap-component) with "\Deleted" as the *Flags* parameter. # DeleteMailbox Method ([IMAP](#imap-component) Component) This method deletes a mailbox specified by Mailbox . ## Syntax *Go Syntax* ```text func (obj *IMAP) DeleteMailbox() error ``` ## Remarks This method deletes a mailbox. The mailbox name is specified by the [Mailbox](#mailbox-property-imap-component) property. # DeleteMailboxACL Method ([IMAP](#imap-component) Component) This method deletes mailbox access control rights for a specific user. ## Syntax *Go Syntax* ```text func (obj *IMAP) DeleteMailboxACL(User string) error ``` ## Remarks This message asks the server to remove all rights associated with *User* from the mailbox specified in the [Mailbox](#mailbox-property-imap-component) property. Refer to [SetMailboxACL](#setmailboxacl-method-imap-component) and [GetMailboxACL](#getmailboxacl-method-imap-component) for more information on mailbox access rights. # Disconnect Method ([IMAP](#imap-component) Component) This method disconnects from an IMAP server. ## Syntax *Go Syntax* ```text func (obj *IMAP) Disconnect() error ``` ## Remarks This method logs out and disconnects from the IMAP server. # DoEvents Method ([IMAP](#imap-component) Component) This method processes events from the internal message queue. ## Syntax *Go Syntax* ```text func (obj *IMAP) DoEvents() error ``` ## Remarks When DoEvents is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns. # ExamineMailbox Method ([IMAP](#imap-component) Component) This method selects a mailbox in read-only mode. ## Syntax *Go Syntax* ```text func (obj *IMAP) ExamineMailbox() error ``` ## Remarks This method asks the server to select the mailbox specified in the [Mailbox](#mailbox-property-imap-component) property in read-only mode. **Example 1. Open a Mailbox in Read/Write Mode:** ```text IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox ``` **Example 2. Open a Mailbox in Read-Only Mode:** ```text IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox ``` # ExpungeMailbox Method ([IMAP](#imap-component) Component) This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox. ## Syntax *Go Syntax* ```text func (obj *IMAP) ExpungeMailbox() error ``` ## Remarks This method permanently removes all messages that have a 'Deleted' flag from the current (selected) mailbox. **Example. Set "Deleted" Flag and Expunge:** ```text IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted") IMAPControl.ExpungeMailbox() ``` # GetMailboxACL Method ([IMAP](#imap-component) Component) This method retrieves mailbox access control rights. ## Syntax *Go Syntax* ```text func (obj *IMAP) GetMailboxACL() error ``` ## Remarks This method retrieves the mailbox access control rights, which are provided through one or more [MailboxACL](#mailboxacl-event-imap-component) events. Standard rights include the following: | | | | --- | --- | | l | Lookup (Visible to be listed) | | r | Read (Can be selected, retrieved, searched, and copied) | | s | Keep (Seen/unseen information across sessions) | | w | Write (Stores flags other than SEEN and DELETED) | | i | Insert (Can be appended and copied into) | | p | Post (Can send mail to submission address for mailbox) | | c | Create (Can create new sub-mailboxes) | | d | Delete (Stores DELETED flag and performs EXPUNGE) | | a | Administer (Set access permissions) | # Interrupt Method ([IMAP](#imap-component) Component) This method interrupts the current method. ## Syntax *Go Syntax* ```text func (obj *IMAP) Interrupt() error ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # ListMailboxes Method ([IMAP](#imap-component) Component) This method lists all of the mailboxes matching all criteria in the Mailbox property. ## Syntax *Go Syntax* ```text func (obj *IMAP) ListMailboxes() error ``` ## Remarks This method lists all of the mailboxes matching the criteria in the [Mailbox](#mailbox-property-imap-component) property. Matching mailboxes are returned through the [MailboxList](#mailboxlist-event-imap-component) event. **Example 1. List All Mailboxes:** ```text IMAPControl.Mailbox = "*" IMAPControl.ListMailboxes() ``` **Example 2. List All Mailboxes Inside INBOX:** ```text IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListMailboxes() ``` # ListSubscribedMailboxes Method ([IMAP](#imap-component) Component) This method lists all subscribed mailboxes matching all criteria in the Mailbox property. ## Syntax *Go Syntax* ```text func (obj *IMAP) ListSubscribedMailboxes() error ``` ## Remarks This method lists all *subscribed* mailboxes matching the criteria in the [Mailbox](#mailbox-property-imap-component) property. Matching mailboxes are returned through [MailboxList](#mailboxlist-event-imap-component) event. **Example 1. List All Subscribed Mailboxes:** ```text IMAPControl.Mailbox = "*" IMAPControl.ListSubscribedMailboxes() ``` **Example 2. List All Subscribed Mailboxes Inside INBOX:** ```text IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListSubscribedMailboxes() ``` # LocalizeDate Method ([IMAP](#imap-component) Component) This method converts a valid RFC 822 message date to a local date and time. ## Syntax *Go Syntax* ```text func (obj *IMAP) LocalizeDate(DateTime string) (string, error) ``` ## Remarks This method can be used to convert an RFC 822 date and time string to the corresponding local date and time. NOTE: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss". # MoveToMailbox Method ([IMAP](#imap-component) Component) Copies the specified messages to another mailbox and marks the original messages as deleted. ## Syntax *Go Syntax* ```text func (obj *IMAP) MoveToMailbox() error ``` ## Remarks This method copies the messages specified by the [MessageSet](#messageset-property-imap-component) property to the mailbox specified by the [Mailbox](#mailbox-property-imap-component) property. Additionally, the messages in the original mailbox are marked as deleted. Calling this method is equivalent to calling the [CopyToMailbox](#copytomailbox-method-imap-component) method immediately followed by the [DeleteFromMailbox](#deletefrommailbox-method-imap-component) method. # Noop Method ([IMAP](#imap-component) Component) This method sends a NOOP command to the server. ## Syntax *Go Syntax* ```text func (obj *IMAP) Noop() error ``` ## Remarks This method sends an IMAP *NOOP* command to the server. This is useful when the connection needs to be kept alive for long periods of time. (Normally, servers break the connection automatically after 30 minutes of inactivity.) # RenameMailbox Method ([IMAP](#imap-component) Component) This method changes the name of Mailbox to NewName . ## Syntax *Go Syntax* ```text func (obj *IMAP) RenameMailbox(NewName string) error ``` ## Remarks This method allows a mailbox to be renamed. The mailbox is specified by the [Mailbox](#mailbox-property-imap-component) property, and the new name is specified by the *NewName* parameter. # Reset Method ([IMAP](#imap-component) Component) This method will reset the class. ## Syntax *Go Syntax* ```text func (obj *IMAP) Reset() error ``` ## Remarks This method will reset the struct's properties to their default values. # ResetMessageFlags Method ([IMAP](#imap-component) Component) This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags . ## Syntax *Go Syntax* ```text func (obj *IMAP) ResetMessageFlags() error ``` ## Remarks This method replaces the flags of the messages specified by the [MessageSet](#messageset-property-imap-component) property with the flags specified by the [MessageFlags](#messageflags-property-imap-component) property. The format of the flags is specified by the IMAP RFCs. Examples of possible flag values are server dependent, but they can include the following: | | | | --- | --- | | \Deleted | Mark a message as deleted (for removal later by [ExpungeMailbox](#expungemailbox-method-imap-component)). | | \Seen | Mark a message as read. | | \Answered | Mark a message as answered. | | \Flagged | Mark a message as flagged. | | \Draft | Mark a message as being incomplete (under composition). | # RetrieveMessageHeaders Method ([IMAP](#imap-component) Component) This method retrieves the message headers of the messages specified by the MessageSet property. ## Syntax *Go Syntax* ```text func (obj *IMAP) RetrieveMessageHeaders() error ``` ## Remarks This method retrieves RFC 822 headers of the messages specified by [MessageSet](#messageset-property-imap-component) and stores them in the MessageHeaders property. # RetrieveMessageInfo Method ([IMAP](#imap-component) Component) This method retrieves information about messages specified by the MessageSet property. ## Syntax *Go Syntax* ```text func (obj *IMAP) RetrieveMessageInfo() error ``` ## Remarks This method retrieves information for the messages specified by the [MessageSet](#messageset-property-imap-component) property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a [MessageInfo](#messageinfo-event-imap-component) event is fired, and message envelope information is stored in properties, such as the following: [MessageSubject](#messagesubject-property-imap-component), [MessageFrom](#messagefrom-property-imap-component), and MessageRecipients. If the message is a multipart message, one or more [MessagePart](#messagepart-event-imap-component) events will be fired before the [MessageInfo](#messageinfo-event-imap-component) event (one for each message part). # RetrieveMessagePart Method ([IMAP](#imap-component) Component) This method retrieves the message part specified by PartID. ## Syntax *Go Syntax* ```text func (obj *IMAP) RetrieveMessagePart(PartId string) error ``` ## Remarks This method retrieves the contents of the message part specified by the *PartId* property of the messages specified by the [MessageSet](#messageset-property-imap-component) property. If the [LocalFile](#localfile-property-imap-component) property contains a file name, the message part is stored in [LocalFile](#localfile-property-imap-component). If the [LocalFile](#localfile-property-imap-component) property is set to an empty string, then the message part is stored in the [MessageText](#messagetext-property-imap-component) property. Additionally, the [Transfer](#transfer-event-imap-component) will also provide the message part and denote the progress of the retrieval. The part identifiers for each message part (if any) are provided through the corresponding [MessagePart](#messagepart-event-imap-component) events. This method retrieves the RFC 822-encoded text of the messages specified by [MessageSet](#messageset-property-imap-component). # RetrieveMessagePartHeaders Method ([IMAP](#imap-component) Component) This method retrieves the headers of message part specified by PartID. ## Syntax *Go Syntax* ```text func (obj *IMAP) RetrieveMessagePartHeaders(PartId string) error ``` ## Remarks This method retrieves RFC 822 headers of the message part specified by PartID and stores them in the MessageHeaders property. # RetrieveMessageText Method ([IMAP](#imap-component) Component) This method retrieves the message text of the messages specified by the MessageSet property. ## Syntax *Go Syntax* ```text func (obj *IMAP) RetrieveMessageText() error ``` ## Remarks This method retrieves the RFC 822-encoded text of the messages specified by [MessageSet](#messageset-property-imap-component). If the [LocalFile](#localfile-property-imap-component) property contains a file name, the text is stored in [LocalFile](#localfile-property-imap-component). If the [LocalFile](#localfile-property-imap-component) property is set to an empty string, then the text is stored in the [MessageText](#messagetext-property-imap-component) property. Additionally, the [Transfer](#transfer-event-imap-component) event will also provide the text and denote the progress of the retrieval. # SearchMailbox Method ([IMAP](#imap-component) Component) This method searches the selected mailbox for specified text. ## Syntax *Go Syntax* ```text func (obj *IMAP) SearchMailbox(SearchCriteria string) error ``` ## Remarks This method searches the selected mailbox using the criteria specified in the *SearchCriteria* parameter. For every message matching the criteria, the [RetrieveMessageInfo](#retrievemessageinfo-method-imap-component) method is called and a [MessageInfo](#messageinfo-event-imap-component) event is fired. The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: "SINCE 1-Feb-1994 NOT FROM Smith". Possible search keys include the following: | | | | --- | --- | | | Messages with message sequence numbers corresponding to the specified message sequence number set. | | ALL | All messages in the mailbox; this is the default initial key for AND-ing. | | ANSWERED | Messages with the \Answered flag set. | | BCC | Messages that contain the specified string in the envelope structure's BCC field. | | BEFORE | Messages whose internal date is earlier than the specified date. | | BODY | Messages that contain the specified string in the body of the message. | | CC | Messages that contain the specified string in the envelope structure's CC field. | | DELETED | Messages with the \Deleted flag set. | | DRAFT | Messages with the \Draft flag set. | | FLAGGED | Messages with the \Flagged flag set. | | FROM | Messages that contain the specified string in the envelope structure's FROM field. | | HEADER | Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contains the specified string in the [RFC-822] field-body. | | KEYWORD | Messages with the specified keyword set. | | LARGER | Messages with an RFC822.SIZE larger than the specified number of octets. | | NEW | Messages that have the \Recent flag set but not the \Seen flag. This is functionally equivalent to "(RECENT UNSEEN)". | | NOT | Messages that do not match the specified search key. | | OLD | Messages that do not have the \Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW"). | | ON | Messages whose internal date is within the specified date. | | OR | Messages that match either search key. | | RECENT | Messages that have the \Recent flag set. | | SEEN | Messages that have the \Seen flag set. | | SENTBEFORE | Messages whose [RFC-822] Date: header is earlier than the specified date. | | SENTON | Messages whose [RFC-822] Date: header is within the specified date. | | SENTSINCE | Messages whose [RFC-822] Date: header is within or later than the specified date. | | SINCE | Messages whose internal date is within or later than the specified date. | | SMALLER | Messages with an RFC822.SIZE smaller than the specified number of octets. | | SUBJECT | Messages that contain the specified string in the envelope structure's SUBJECT field. | | TEXT | Messages that contain the specified string in the header or body of the message. | | TO | Messages that contain the specified string in the envelope structure's TO field. | | UID | Messages with unique identifiers corresponding to the specified unique identifier set. | | UNANSWERED | Messages that do not have the \Answered flag set. | | UNDELETED | Messages that do not have the \Deleted flag set. | | UNDRAFT | Messages that do not have the \Draft flag set. | | UNFLAGGED | Messages that do not have the \Flagged flag set. | | UNKEYWORD | Messages that do not have the specified keyword set. | | UNSEEN | Messages that do not have the \Seen flag set. | # SelectMailbox Method ([IMAP](#imap-component) Component) This method selects a mailbox. ## Syntax *Go Syntax* ```text func (obj *IMAP) SelectMailbox() error ``` ## Remarks This method asks the server to select the mailbox specified in the [Mailbox](#mailbox-property-imap-component) property. The mailbox is selected in read/write mode (if the server permits). **Example 1. Open a Mailbox in Read/Write Mode:** ```text IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox ``` **Example 2. Open a Mailbox in Read-Only Mode:** ```text IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox ``` # SendCommand Method ([IMAP](#imap-component) Component) This method sends the exact command directly to the server. ## Syntax *Go Syntax* ```text func (obj *IMAP) SendCommand(Command string) error ``` ## Remarks This method sends the command specified by *Command* to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server. After calling this method, check the [LastReply](#lastreply-property-imap-component) property or monitor the [PITrail](#pitrail-event-imap-component) event to obtain the server's response. # SetMailboxACL Method ([IMAP](#imap-component) Component) This method sets mailbox access control rights for a specific user. ## Syntax *Go Syntax* ```text func (obj *IMAP) SetMailboxACL(User string, Rights string) error ``` ## Remarks This method changes the access control list for the mailbox specified in the [Mailbox](#mailbox-property-imap-component) property so that *User* is granted the permissions specified in *Rights*. *Rights* is a string containing an optional plus ("+") or minus ("-") prefix, followed by zero or more rights characters. If the string starts with a plus, the rights are added to any existing rights for the identifier. If the string starts with a minus, the rights are removed from any existing rights for the identifier. If the string does not start with a plus or minus, the rights replace any existing rights for the identifier. Standard rights include the following: | | | | --- | --- | | l | Lookup (Visible to be listed) | | r | Read (Can be selected, retrieved, searched, and copied) | | s | Keep (Seen/unseen information across sessions) | | w | Write (Stores flags other than SEEN and DELETED) | | i | Insert (Can be appended and copied into) | | p | Post (Can send mail to submission address for mailbox) | | c | Create (Can create new sub-mailboxes) | | d | Delete (Stores DELETED flag and performs EXPUNGE) | | a | Administer (Set access permissions) | # StartIdle Method ([IMAP](#imap-component) Component) This method begins idling. ## Syntax *Go Syntax* ```text func (obj *IMAP) StartIdle() error ``` ## Remarks This method sends the *IDLE* command to the server and begins idling. As responses are received from the server the [IdleInfo](#idleinfo-event-imap-component) event fires. To stop idling, call [StopIdle](#stopidle-method-imap-component). If the struct is being used in a formless application (such as a console application) be sure to call [DoEvents](#doevents-method-imap-component) in a loop after calling this method to ensure that incoming events are processed. # StopIdle Method ([IMAP](#imap-component) Component) This method stops idling. ## Syntax *Go Syntax* ```text func (obj *IMAP) StopIdle() error ``` ## Remarks This method stops idling if it was previously started via [StartIdle](#startidle-method-imap-component). If the struct is not idling, this method does nothing. # SubscribeMailbox Method ([IMAP](#imap-component) Component) This method subscribes to the mailbox specified by Mailbox . ## Syntax *Go Syntax* ```text func (obj *IMAP) SubscribeMailbox() error ``` ## Remarks This method subscribes to the mailbox specified by the [Mailbox](#mailbox-property-imap-component) property. # UnsetMessageFlags Method ([IMAP](#imap-component) Component) This method removes the flags specified by MessageFlags from the messages specified by MessageSet . ## Syntax *Go Syntax* ```text func (obj *IMAP) UnsetMessageFlags() error ``` ## Remarks This method removes the flags specified by the [MessageFlags](#messageflags-property-imap-component) property from the messages specified by the [MessageSet](#messageset-property-imap-component) property. The format of the flags is specified by the IMAP RFCs. Examples of possible flag values are server dependent, but they can include the following: | | | | --- | --- | | \Deleted | Mark a message as deleted (for removal later by [ExpungeMailbox](#expungemailbox-method-imap-component)). | | \Seen | Mark a message as read. | | \Answered | Mark a message as answered. | | \Flagged | Mark a message as flagged. | | \Draft | Mark a message as being incomplete (under composition). | # UnsubscribeMailbox Method ([IMAP](#imap-component) Component) This method unsubscribes from the mailbox specified by Mailbox . ## Syntax *Go Syntax* ```text func (obj *IMAP) UnsubscribeMailbox() error ``` ## Remarks This method unsubscribes from the mailbox specified by the [Mailbox](#mailbox-property-imap-component) property. # ConnectionStatus Event ([IMAP](#imap-component) Component) Fired to indicate changes in the connection state. ## Syntax *Go Syntax* ```text // IMAPConnectionStatusEventArgs carries the IMAP ConnectionStatus event's parameters. type IMAPConnectionStatusEventArgs struct {...} func (args *IMAPConnectionStatusEventArgs) ConnectionEvent() string func (args *IMAPConnectionStatusEventArgs) StatusCode() int32 func (args *IMAPConnectionStatusEventArgs) Description() string // IMAPConnectionStatusEvent defines the signature of the IMAP ConnectionStatus event's handler function. type IMAPConnectionStatusEvent func(sender *IMAP, args *IMAPConnectionStatusEventArgs) func (obj *IMAP) GetOnConnectionStatusHandler() IMAPConnectionStatusEvent func (obj *IMAP) SetOnConnectionStatusHandler(handlerFunc IMAPConnectionStatusEvent) ``` ## Remarks This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake. The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. # EndTransfer Event ([IMAP](#imap-component) Component) This event is fired when the message or the part data finishes transferring. ## Syntax *Go Syntax* ```text // IMAPEndTransferEventArgs carries the IMAP EndTransfer event's parameters. type IMAPEndTransferEventArgs struct {...} func (args *IMAPEndTransferEventArgs) Direction() int32 // IMAPEndTransferEvent defines the signature of the IMAP EndTransfer event's handler function. type IMAPEndTransferEvent func(sender *IMAP, args *IMAPEndTransferEventArgs) func (obj *IMAP) GetOnEndTransferHandler() IMAPEndTransferEvent func (obj *IMAP) SetOnEndTransferHandler(handlerFunc IMAPEndTransferEvent) ``` ## Remarks The EndTransfer event is fired when the requested message body or part completes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Error Event ([IMAP](#imap-component) Component) Fired when information is available about errors during data delivery. ## Syntax *Go Syntax* ```text // IMAPErrorEventArgs carries the IMAP Error event's parameters. type IMAPErrorEventArgs struct {...} func (args *IMAPErrorEventArgs) ErrorCode() int32 func (args *IMAPErrorEventArgs) Description() string // IMAPErrorEvent defines the signature of the IMAP Error event's handler function. type IMAPErrorEvent func(sender *IMAP, args *IMAPErrorEventArgs) func (obj *IMAP) GetOnErrorHandler() IMAPErrorEvent func (obj *IMAP) SetOnErrorHandler(handlerFunc IMAPErrorEvent) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-imap-component) section. # Header Event ([IMAP](#imap-component) Component) This event is fired every time a header line comes in. ## Syntax *Go Syntax* ```text // IMAPHeaderEventArgs carries the IMAP Header event's parameters. type IMAPHeaderEventArgs struct {...} func (args *IMAPHeaderEventArgs) Field() string func (args *IMAPHeaderEventArgs) Value() string // IMAPHeaderEvent defines the signature of the IMAP Header event's handler function. type IMAPHeaderEvent func(sender *IMAP, args *IMAPHeaderEventArgs) func (obj *IMAP) GetOnHeaderHandler() IMAPHeaderEvent func (obj *IMAP) SetOnHeaderHandler(handlerFunc IMAPHeaderEvent) ``` ## Remarks The *Field* parameter contains the name of the HTTP header (in the same case as it is delivered). The *Value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *Field* parameter contains "" (empty string). # IdleInfo Event ([IMAP](#imap-component) Component) This event fires whenever responses from the server are received while idling. ## Syntax *Go Syntax* ```text // IMAPIdleInfoEventArgs carries the IMAP IdleInfo event's parameters. type IMAPIdleInfoEventArgs struct {...} func (args *IMAPIdleInfoEventArgs) Message() string func (args *IMAPIdleInfoEventArgs) Cancel() bool func (args *IMAPIdleInfoEventArgs) SetCancel(value bool) // IMAPIdleInfoEvent defines the signature of the IMAP IdleInfo event's handler function. type IMAPIdleInfoEvent func(sender *IMAP, args *IMAPIdleInfoEventArgs) func (obj *IMAP) GetOnIdleInfoHandler() IMAPIdleInfoEvent func (obj *IMAP) SetOnIdleInfoHandler(handlerFunc IMAPIdleInfoEvent) ``` ## Remarks This event fires each time a response is received from the server after calling [StartIdle](#startidle-method-imap-component). This will fire with information from the server intended to update the client. The type of data sent by the server may vary. *Message* holds the response received from the server. *Cancel* may be set to stop idling from within the event. This is equivalent to calling [StopIdle](#stopidle-method-imap-component). The following are possible values returned by the server: ```text + idling * 43 EXISTS * 1 RECENT ``` # LaunchBrowser Event ([IMAP](#imap-component) Component) Fires before launching a browser with the authorization URL. ## Syntax *Go Syntax* ```text // IMAPLaunchBrowserEventArgs carries the IMAP LaunchBrowser event's parameters. type IMAPLaunchBrowserEventArgs struct {...} func (args *IMAPLaunchBrowserEventArgs) URL() string func (args *IMAPLaunchBrowserEventArgs) SetURL(value string) func (args *IMAPLaunchBrowserEventArgs) Command() string func (args *IMAPLaunchBrowserEventArgs) SetCommand(value string) // IMAPLaunchBrowserEvent defines the signature of the IMAP LaunchBrowser event's handler function. type IMAPLaunchBrowserEvent func(sender *IMAP, args *IMAPLaunchBrowserEventArgs) func (obj *IMAP) GetOnLaunchBrowserHandler() IMAPLaunchBrowserEvent func (obj *IMAP) SetOnLaunchBrowserHandler(handlerFunc IMAPLaunchBrowserEvent) ``` ## Remarks When the ClientProfile property is set to ocpApplication and GetAuthorization is called, the struct will fire this event with the *Command*, which will be executed by the struct. The *URL* parameter will be the authorization URL that the user will be directed to authenticate. Within this event, you may override the current value of either *Command* or *URL* and provide your own value. If *Command* is set to an empty string, the struct will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter. If *Command* is not empty, the URL will be appended to the end. In Windows, ShellExecute is used to execute *Command*, which limits the verbs available for use in *Command* to: - edit - explore - find - open - print # Log Event ([IMAP](#imap-component) Component) Fired once for each log message. ## Syntax *Go Syntax* ```text // IMAPLogEventArgs carries the IMAP Log event's parameters. type IMAPLogEventArgs struct {...} func (args *IMAPLogEventArgs) LogLevel() int32 func (args *IMAPLogEventArgs) Message() string func (args *IMAPLogEventArgs) LogType() string // IMAPLogEvent defines the signature of the IMAP Log event's handler function. type IMAPLogEvent func(sender *IMAP, args *IMAPLogEventArgs) func (obj *IMAP) GetOnLogHandler() IMAPLogEvent func (obj *IMAP) SetOnLogHandler(handlerFunc IMAPLogEvent) ``` ## Remarks This event is fired once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # MailboxACL Event ([IMAP](#imap-component) Component) This event fires for each set of access control rights returned by the server. ## Syntax *Go Syntax* ```text // IMAPMailboxACLEventArgs carries the IMAP MailboxACL event's parameters. type IMAPMailboxACLEventArgs struct {...} func (args *IMAPMailboxACLEventArgs) Mailbox() string func (args *IMAPMailboxACLEventArgs) User() string func (args *IMAPMailboxACLEventArgs) Rights() string // IMAPMailboxACLEvent defines the signature of the IMAP MailboxACL event's handler function. type IMAPMailboxACLEvent func(sender *IMAP, args *IMAPMailboxACLEventArgs) func (obj *IMAP) GetOnMailboxACLHandler() IMAPMailboxACLEvent func (obj *IMAP) SetOnMailboxACLHandler(handlerFunc IMAPMailboxACLEvent) ``` ## Remarks The event fires for each set of access control rights returned by the server after a call to [GetMailboxACL](#getmailboxacl-method-imap-component). Standard rights include the following: | | | | --- | --- | | l | Lookup (Visible to be listed) | | r | Read (Can be selected, retrieved, searched, and copied) | | s | Keep (Seen/unseen information across sessions) | | w | Write (Stores flags other than SEEN and DELETED) | | i | Insert (Can be appended and copied into) | | p | Post (Can send mail to submission address for mailbox) | | c | Create (Can create new sub-mailboxes) | | d | Delete (Stores DELETED flag and performs EXPUNGE) | | a | Administer (Set access permissions) | # MailboxList Event ([IMAP](#imap-component) Component) This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. ## Syntax *Go Syntax* ```text // IMAPMailboxListEventArgs carries the IMAP MailboxList event's parameters. type IMAPMailboxListEventArgs struct {...} func (args *IMAPMailboxListEventArgs) Mailbox() string func (args *IMAPMailboxListEventArgs) Separator() string func (args *IMAPMailboxListEventArgs) Flags() string // IMAPMailboxListEvent defines the signature of the IMAP MailboxList event's handler function. type IMAPMailboxListEvent func(sender *IMAP, args *IMAPMailboxListEventArgs) func (obj *IMAP) GetOnMailboxListHandler() IMAPMailboxListEvent func (obj *IMAP) SetOnMailboxListHandler(handlerFunc IMAPMailboxListEvent) ``` ## Remarks This method is fired for each mailbox received through the [ListMailboxes](#listmailboxes-method-imap-component) and [ListSubscribedMailboxes](#listsubscribedmailboxes-method-imap-component) methods. The *Separator* parameter contains the character that separates the different parts in the mailbox path hierarchy. # MessageInfo Event ([IMAP](#imap-component) Component) This event is fired with information for the messages retrieved by the server. ## Syntax *Go Syntax* ```text // IMAPMessageInfoEventArgs carries the IMAP MessageInfo event's parameters. type IMAPMessageInfoEventArgs struct {...} func (args *IMAPMessageInfoEventArgs) MessageId() string func (args *IMAPMessageInfoEventArgs) Subject() string func (args *IMAPMessageInfoEventArgs) MessageDate() string func (args *IMAPMessageInfoEventArgs) From() string func (args *IMAPMessageInfoEventArgs) Flags() string func (args *IMAPMessageInfoEventArgs) Size() int64 // IMAPMessageInfoEvent defines the signature of the IMAP MessageInfo event's handler function. type IMAPMessageInfoEvent func(sender *IMAP, args *IMAPMessageInfoEventArgs) func (obj *IMAP) GetOnMessageInfoHandler() IMAPMessageInfoEvent func (obj *IMAP) SetOnMessageInfoHandler(handlerFunc IMAPMessageInfoEvent) ``` ## Remarks The MessageInfo event is fired when messages are searched, listed, or message information is received. *Id* is the Id of the message. *Subject* is the message subject. *MessageDate* is the date of the message. *From* is the email address of the sender. *Flags* is a list of flags associated with this message. *Size* is the size of the message. More information may be received from the respective properties, such as the following: [MessageContentType](#messagecontenttype-property-imap-component), [MessageContentEncoding](#messagecontentencoding-property-imap-component), MessageRecipients, [MessageDeliveryTime](#messagedeliverytime-property-imap-component), [MessageFlags](#messageflags-property-imap-component), MessageHeaders, [MessageInReplyTo](#messageinreplyto-property-imap-component), [MessageNetId](#messagenetid-property-imap-component), [MessageReplyTo](#messagereplyto-property-imap-component), [MessageSender](#messagesender-property-imap-component), [MessageSize](#messagesize-property-imap-component), [MessageSubject](#messagesubject-property-imap-component), [MessageText](#messagetext-property-imap-component), etc. # MessagePart Event ([IMAP](#imap-component) Component) This event is fired for each message part when RetrieveMessageInfo is called. ## Syntax *Go Syntax* ```text // IMAPMessagePartEventArgs carries the IMAP MessagePart event's parameters. type IMAPMessagePartEventArgs struct {...} func (args *IMAPMessagePartEventArgs) PartId() string func (args *IMAPMessagePartEventArgs) Size() int64 func (args *IMAPMessagePartEventArgs) ContentType() string func (args *IMAPMessagePartEventArgs) FileName() string func (args *IMAPMessagePartEventArgs) ContentEncoding() string func (args *IMAPMessagePartEventArgs) Parameters() string func (args *IMAPMessagePartEventArgs) MultipartMode() string func (args *IMAPMessagePartEventArgs) ContentId() string func (args *IMAPMessagePartEventArgs) ContentDisposition() string // IMAPMessagePartEvent defines the signature of the IMAP MessagePart event's handler function. type IMAPMessagePartEvent func(sender *IMAP, args *IMAPMessagePartEventArgs) func (obj *IMAP) GetOnMessagePartHandler() IMAPMessagePartEvent func (obj *IMAP) SetOnMessagePartHandler(handlerFunc IMAPMessagePartEvent) ``` ## Remarks The *PartId* parameter denotes the PartId that may be identified in other parts or messages. The format of PartIds is specified by the IMAP RFCs. The *Size* parameter gives the size of this part. The *ContentType* parameter shows the type of data contained in the part. The *ContentEncoding* parameter shows how data are encoded. The *FileName* parameter shows the filename corresponding to the part (if the part was included in the message as an attached file). The *Parameters* parameter contains the additional parameters passed to the *ContentType* header, such as the part charset. The *MultipartMode* parameter shows the how this part relates to the message's whole multipart structure (e.g., 'mixed', 'alternative', etc.). The *ContentId* parameter shows the value of the Content-Id header for the part. The *ContentDisposition* parameter shows the value of the Content-Disposition header for the part. # PITrail Event ([IMAP](#imap-component) Component) This event traces the commands sent to the mail server, and the respective replies. ## Syntax *Go Syntax* ```text // IMAPPITrailEventArgs carries the IMAP PITrail event's parameters. type IMAPPITrailEventArgs struct {...} func (args *IMAPPITrailEventArgs) Direction() int32 func (args *IMAPPITrailEventArgs) Message() string // IMAPPITrailEvent defines the signature of the IMAP PITrail event's handler function. type IMAPPITrailEvent func(sender *IMAP, args *IMAPPITrailEventArgs) func (obj *IMAP) GetOnPITrailHandler() IMAPPITrailEvent func (obj *IMAP) SetOnPITrailHandler(handlerFunc IMAPPITrailEvent) ``` ## Remarks The PITrail event is useful for debugging and learning purposes. It shows all of the interactions between the client and the server, line by line, except for message header and body transfers. The *Message* parameter contains the full text of the message. The *Direction* parameter shows the originator of the message: | | | | --- | --- | | 0 (Client) | The Message originates from the client. | | 1 (Server) | The Message originates from the server. | | 2 (Information) | The Message is an informative message originating from the client software (the struct code). | # SSLServerAuthentication Event ([IMAP](#imap-component) Component) Fired after the server presents its certificate to the client. ## Syntax *Go Syntax* ```text // IMAPSSLServerAuthenticationEventArgs carries the IMAP SSLServerAuthentication event's parameters. type IMAPSSLServerAuthenticationEventArgs struct {...} func (args *IMAPSSLServerAuthenticationEventArgs) CertEncoded() []byte func (args *IMAPSSLServerAuthenticationEventArgs) CertSubject() string func (args *IMAPSSLServerAuthenticationEventArgs) CertIssuer() string func (args *IMAPSSLServerAuthenticationEventArgs) Status() string func (args *IMAPSSLServerAuthenticationEventArgs) Accept() bool func (args *IMAPSSLServerAuthenticationEventArgs) SetAccept(value bool) // IMAPSSLServerAuthenticationEvent defines the signature of the IMAP SSLServerAuthentication event's handler function. type IMAPSSLServerAuthenticationEvent func(sender *IMAP, args *IMAPSSLServerAuthenticationEventArgs) func (obj *IMAP) GetOnSSLServerAuthenticationHandler() IMAPSSLServerAuthenticationEvent func (obj *IMAP) SetOnSSLServerAuthenticationHandler(handlerFunc IMAPSSLServerAuthenticationEvent) ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True. # SSLStatus Event ([IMAP](#imap-component) Component) Fired when secure connection progress messages are available. ## Syntax *Go Syntax* ```text // IMAPSSLStatusEventArgs carries the IMAP SSLStatus event's parameters. type IMAPSSLStatusEventArgs struct {...} func (args *IMAPSSLStatusEventArgs) Message() string // IMAPSSLStatusEvent defines the signature of the IMAP SSLStatus event's handler function. type IMAPSSLStatusEvent func(sender *IMAP, args *IMAPSSLStatusEventArgs) func (obj *IMAP) GetOnSSLStatusHandler() IMAPSSLStatusEvent func (obj *IMAP) SetOnSSLStatusHandler(handlerFunc IMAPSSLStatusEvent) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([IMAP](#imap-component) Component) This event is fired when the message body or the part data start transferring. ## Syntax *Go Syntax* ```text // IMAPStartTransferEventArgs carries the IMAP StartTransfer event's parameters. type IMAPStartTransferEventArgs struct {...} func (args *IMAPStartTransferEventArgs) Direction() int32 // IMAPStartTransferEvent defines the signature of the IMAP StartTransfer event's handler function. type IMAPStartTransferEvent func(sender *IMAP, args *IMAPStartTransferEventArgs) func (obj *IMAP) GetOnStartTransferHandler() IMAPStartTransferEvent func (obj *IMAP) SetOnStartTransferHandler(handlerFunc IMAPStartTransferEvent) ``` ## Remarks The StartTransfer event is fired when the message body or the part data start transferring from the server to the local host. Further progress information is provided by the [Transfer](#transfer-event-imap-component) and [EndTransfer](#endtransfer-event-imap-component) events. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Transfer Event ([IMAP](#imap-component) Component) This event is fired while the message is transferred from the MailServer . ## Syntax *Go Syntax* ```text // IMAPTransferEventArgs carries the IMAP Transfer event's parameters. type IMAPTransferEventArgs struct {...} func (args *IMAPTransferEventArgs) Direction() int32 func (args *IMAPTransferEventArgs) BytesTransferred() int64 func (args *IMAPTransferEventArgs) PercentDone() int32 func (args *IMAPTransferEventArgs) Text() string // IMAPTransferEvent defines the signature of the IMAP Transfer event's handler function. type IMAPTransferEvent func(sender *IMAP, args *IMAPTransferEventArgs) func (obj *IMAP) GetOnTransferHandler() IMAPTransferEvent func (obj *IMAP) SetOnTransferHandler(handlerFunc IMAPTransferEvent) ``` ## Remarks The Transfer event is fired for every incoming line when receiving a message or part data from the [MailServer](#mailserver-property-imap-component) The *Text* parameter contains the portion of the message or the part data being retrieved. The *BytesTransferred* parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e., when the last Transfer event is fired), *BytesTransferred* equals the value of the [MessageSize](#messagesize-property-imap-component) property. The Transfer event is fired for every line of the message. There is no terminating newline at the end of the *Text* parameter. A faster way to retrieve a message is to assign a value to the [LocalFile](#localfile-property-imap-component) property and use the Transfer event to check the progress only rather than to get the actual data. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # Config Settings ([IMAP](#imap-component) Component) The struct 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 struct, access to these *internal properties* is provided through the [Config](#config-method-imap-component) method. ### IMAP Config Settings **AlwaysReturnUIDs**: Instructs the server to return UIDs even if not in UIDMode. If [UIDMode](#uidmode-property-imap-component) is set to False, the [MessageSet](#messageset-property-imap-component) contains session message Ids, and the response from the server also will contain session message Ids. In some cases, it is desirable that the server sends back UIDs. Set the [AlwaysReturnUIDs](#AlwaysReturnUIDs) to True, to instruct the server to do so. The default value for this setting is False. **AppendToMailboxDateTime**: Specifies the date-time parameter used in the initial APPEND request. When appending to a mailbox using the [AppendToMailbox](#appendtomailbox-method-imap-component) method, the IMAP RFC specifies a date-time parameter that can be used to set the internal date of the resulting message. This configuration setting can be used to specify the date-time parameter used in this case. The date-time should be formatted according to the IMAP RFC specifications. For example, "22-Jan-2013 12:34:56 -0500" indicates January 22nd, 2013, at 12:34:56 PM EST. By default, if this setting is not specified, no date-time is sent with the *APPEND* request, and the server will use the current time. **AuthorizationIdentity**: The value to use as the authorization identity when SASL authentication is used. When [AuthMechanism](#authmechanism-property-imap-component) is set to amSASLPlain, amSASLDigestMD5, or amXOAUTH2, you may use this setting to specify an authorization identity to be used when authenticating. In the case of amXOAUTH2, this should be your OAUTH authorization string. For instance: ```plaintext Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q ``` NOTE: When using amXOAUTH2, [User](#user-property-imap-component) must be specified, but [Password](#password-property-imap-component) is not required. **AutoDecodeSubject**: Instructs the struct to automatically decode message subjects.Subjects that have been Quoted-Printable or Base64 encoded are automatically decoded when this configuration setting is True (default). Only subjects in the format "=?iso-8859-1?Q?data?=" will be correctly decoded. **AutoDecodeText**: Whether to decode MessageText when AutoDecodeParts is True.When [AutoDecodeParts](#autodecodeparts-property-imap-component) is True, this setting controls whether [MessageText](#messagetext-property-imap-component) is also decoded. When [AutoDecodeText](#AutoDecodeText) is True (default), [MessageText](#messagetext-property-imap-component) is decoded. When set to False, [MessageText](#messagetext-property-imap-component) is not decoded. This setting is applicable only when [AutoDecodeParts](#autodecodeparts-property-imap-component) is set to True. **IncludeHeaders**: Instructs the struct to include the headers in the LocalFile.When set to *true*, the headers for the message being retrieved will be written to the LocalFile before the message body. In this manner, the whole content of a MIME-encoded message will be written to the file. **MaskSensitiveData**: Whether sensitive properties should be masked when logging.By default, the [PITrail](#pitrail-event-imap-component) event will include the raw commands sent to the IMAP server, including sensitive values like passwords. To prevent passwords from appearing in plaintext when logging, set this option to True. The default value is True. **RetrieveAfterSearch**: Determines if messages matching the SearchCriteria are retrieved after calling SearchMailbox.If set to False, [RetrieveMessageInfo](#retrievemessageinfo-method-imap-component) will not be called for messages matching the *SearchCriteria* after calling [SearchMailbox](#searchmailbox-method-imap-component). [MessageInfo](#messageinfo-event-imap-component) will still fire, but the MessageId parameter will be the only parameter populated. The default value of this setting is True. **RetrieveTextAndHeaders**: Specifies whether the message body and headers are retrieved in a single request.This setting specifies whether the [RetrieveMessageText](#retrievemessagetext-method-imap-component) method retrieves both the message headers and text, or just the message text. By default this value is *false*, and [RetrieveMessageText](#retrievemessagetext-method-imap-component) will retrieve only the message text from the server. When set to *true*, the struct will retrieve both the message text and headers in a single request from the server and populate both [MessageHeadersString](#messageheadersstring-property-imap-component) and [MessageText](#messagetext-property-imap-component). **SendIDCommand**: Instructs struct to send the ID command if the server advertises support for it. This configuration setting specifies whether the struct will use the IMAP4 Id extension defined in RFC 2971 and send the Id command to the server. When set to *true*, the struct will send the Id command with the value *IPWorksIMAP* if the server supports this as defined in the server's response to the *CAPABILITY* command. The default value is *false*, and this command will not be sent. **UTF7MailboxNames**: Specifies whether or not to automatically encode and decode UTF-7 mailbox names.IMAP servers may represent some characters in a mailbox name in UTF-7 format. This setting determines whether or not the struct should automatically encode and decode these values. When set to False, no encoding or decoding will be performed by the struct. The default value is True. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [Timeout](#timeout-property-imap-component) for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and RemoteHost resolves to more than one address, the struct will try the remaining addresses in turn if the connection to the first one fails, and only fails with an error once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the struct will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the [Connected](#connected-property-imap-component) operation as a whole. **FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-imap-component) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the [LocalHost](#localhost-property-imap-component) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-imap-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-imap-component) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-imap-component) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the struct will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the struct is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-imap-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error. When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error. When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-imap-component) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#sslprovider-property-imap-component) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-imap-component) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#sslprovider-property-imap-component) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-imap-component) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-imap-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-imap-component) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the struct when the [SSLProvider](#sslprovider-property-imap-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-imap-component) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-imap-component) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-imap-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-imap-component) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-imap-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the struct will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-imap-component) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-imap-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-imap-component) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-imap-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([IMAP](#imap-component) Component) ### IMAP Errors | | | | --- | --- | | 118 | Firewall error. Error message contains detailed description. | | 311 | Protocol error. | | 312 | Busy executing current method. | | 314 | A [Mailbox](#mailbox-property-imap-component) must be selected before calling this method. | | 315 | Invalid argument. Please specify a valid [MessageSet](#messageset-property-imap-component). | | 317 | Unknown content encoding. | | 318 | LocalFile already exists and overwrite is False. | The class may also return one of the following error codes, which are inherited from other classes. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-imap-component) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the struct is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |