PIMAP Class
Properties Methods Events Config Settings Errors
The PIMAP class is used to communicate with IMAP servers to retrieve and process OpenPGP encrypted and/or signed messages and any attachments.
Class Name
IPWorksOpenPGP_PIMAP
Procedural Interface
ipworksopenpgp_pimap_open(); ipworksopenpgp_pimap_close($res); ipworksopenpgp_pimap_register_callback($res, $id, $function); ipworksopenpgp_pimap_get_last_error($res); ipworksopenpgp_pimap_get_last_error_code($res); ipworksopenpgp_pimap_set($res, $id, $index, $value); ipworksopenpgp_pimap_get($res, $id, $index); ipworksopenpgp_pimap_do_addmessageflags($res, $flags); ipworksopenpgp_pimap_do_appendtomailbox($res); ipworksopenpgp_pimap_do_checkmailbox($res); ipworksopenpgp_pimap_do_closemailbox($res); ipworksopenpgp_pimap_do_config($res, $configurationstring); ipworksopenpgp_pimap_do_connect($res); ipworksopenpgp_pimap_do_copytomailbox($res); ipworksopenpgp_pimap_do_createmailbox($res); ipworksopenpgp_pimap_do_decrypt($res); ipworksopenpgp_pimap_do_decryptandverifysignature($res); ipworksopenpgp_pimap_do_deletefrommailbox($res); ipworksopenpgp_pimap_do_deletemailbox($res); ipworksopenpgp_pimap_do_deletemailboxacl($res, $user); ipworksopenpgp_pimap_do_disconnect($res); ipworksopenpgp_pimap_do_doevents($res); ipworksopenpgp_pimap_do_examinemailbox($res); ipworksopenpgp_pimap_do_expungemailbox($res); ipworksopenpgp_pimap_do_getmailboxacl($res); ipworksopenpgp_pimap_do_interrupt($res); ipworksopenpgp_pimap_do_listmailboxes($res); ipworksopenpgp_pimap_do_listsubscribedmailboxes($res); ipworksopenpgp_pimap_do_localizedate($res, $datetime); ipworksopenpgp_pimap_do_movetomailbox($res); ipworksopenpgp_pimap_do_noop($res); ipworksopenpgp_pimap_do_renamemailbox($res, $newname); ipworksopenpgp_pimap_do_resetmessageflags($res); ipworksopenpgp_pimap_do_retrievemessageheaders($res); ipworksopenpgp_pimap_do_retrievemessageinfo($res); ipworksopenpgp_pimap_do_retrievemessagepart($res, $partid); ipworksopenpgp_pimap_do_retrievemessagepartheaders($res, $partid); ipworksopenpgp_pimap_do_retrievemessagetext($res); ipworksopenpgp_pimap_do_searchmailbox($res, $searchcriteria); ipworksopenpgp_pimap_do_selectmailbox($res); ipworksopenpgp_pimap_do_sendcommand($res, $command); ipworksopenpgp_pimap_do_setmailboxacl($res, $user, $rights); ipworksopenpgp_pimap_do_startidle($res); ipworksopenpgp_pimap_do_stopidle($res); ipworksopenpgp_pimap_do_subscribemailbox($res); ipworksopenpgp_pimap_do_unsetmessageflags($res); ipworksopenpgp_pimap_do_unsubscribemailbox($res); ipworksopenpgp_pimap_do_verifysignature($res);
Remarks
The PIMAP class offers an easy-to-use interface: it implements a standard IMAP client, as specified in RFC 1730 and RFC 2060, and supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. Additionally, it enables you to create messages bound for multiple recipients with different keys, simultaneously encrypt and compress with the most popular compression algorithms, and control other aspects such as the encrypting algorithm to use.
Connect to a Mail Server
The first step in using the class is specifying a MailServer, a User to connect as, and a Password to authenticate with. After that, one or more requests may be sent to the server via the class's methods. Results are retrieved through events and a number of key properties.
Examine a Mailbox
Normally, after connecting to the server a Mailbox is selected (or examined) using the ExamineMailbox method. After the Mailbox is selected, MessageCount and RecentMessageCount show the number of messages in the mailbox, and MailboxFlags shows the flags pertaining to the mailbox.
A number of operations may be performed by the server in response to commands sent via the class's methods. The primary arguments for most commands are the Mailbox property and the MessageSet property. The MessageSet property denotes either a single message or a range of messages. Other arguments are specified through other properties such as SortCriteria, MessageFlags, etc.
Responses are received through events such as MessageInfo and MailboxList, and are also reflected in properties such as MessageText, MessageSubject, etc.
Decrypt
To process an encrypted or signed message, first retrieve the message text and headers by calling RetrieveMessageHeaders and RetrieveMessageText.
To decrypt a message specify the private key to be used for decryption by setting the Key* properties. For instance:
PIMAP1.KeyCount = 1
PIMAP1.KeyKeyring(0) = "c:\my_keyring_dir"
PIMAP1.KeyUserId(0) = "recipient@nsoftware.com"
PIMAP1.KeyPassphrase(0) = "password"
The specified private key will be used to decrypt the message when calling Decrypt.
Verify
To verify the signature of a message specify the public key to be used for signature verification by
setting the SignerKey* properties. For instance:
PIMAP1.SignerKeyCount = 1
PIMAP1.SignerKeyKeyring(0) = "c:\my_keyring_dir"
PIMAP1.SignerKeyUserId(0) = "sender@nsoftware.com"
The specified public key will be used to verify the signature when calling VerifySignature. To
decrypt and verify in one step call DecryptAndVerifySignature.
Retrieve MIME Message Parts
The MessagePart event describes the MIME structure of retrieved messages. One MessagePart event is fired for every message part, giving information about the particular part. Later on, message parts may be retrieved separately through the RetrieveMessagePart method. This speeds up processing by avoiding the need to retrieve full messages from the server.
Trace Client and Server Communication
The PITrail 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 class with short descriptions. Click on the links for further details.
AuthMechanism | This property includes the authentication mechanism to be used when connecting to the mail server. |
AutoDecodeParts | This property determines whether or not to automatically decode message parts. |
Connected | This property shows whether the class is connected. |
EndByte | This property includes the byte index of the position where the transfer should end. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of the firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a username if authentication is to be used when connecting through a firewall. |
Idle | This property specifies the current status of the class. |
KeyCount | The number of records in the Key arrays. |
KeyEncoded | The key. |
KeyKeyring | The location of the keyring. |
KeyPassphrase | The passphrase for the key's secret key (if any). |
KeyUserId | The user Id of the key. |
LastReply | This property indicates the last reply received from the server. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Mailbox | This property includes the name of the mailbox selected on the server. |
MailboxFlags | This property defines flags in the selected mailbox. |
MailboxListCount | The number of records in the MailboxList arrays. |
MailboxListFlags | This property contains the mailbox flags in a mailbox listing. |
MailboxListName | This property contains the mailbox name in a mailbox listing. |
MailboxListSeparator | The Separator property contains the character that separates the different parts in the mailbox path hierarchy. |
MailPort | This property includes the port of the IMAP server (default is 143). |
MailServer | This property includes the name or address of the mail server (IMAP server). |
Message | This property provides the raw message content. |
MessageContentEncoding | This property includes the ContentEncoding of the selected message. |
MessageContentType | This property includes the ContentType of the message. |
MessageCount | This property includes the total number of messages on the Mailbox . |
MessageDate | The property includes the time the message was created. |
MessageDeliveryTime | This property includes the time the message was delivered to the mail server. |
MessageFlags | This property contains the flags of the current message. |
MessageFrom | This property includes the address of the author of the message. |
MessageHeaderCount | The number of records in the MessageHeader arrays. |
MessageHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
MessageHeaderValue | This property contains the header contents. |
MessageHeadersString | This property includes the string version of the RFC 822-encoded headers in the message. |
MessageId | This property includes the message identifier of the current message. |
MessageInfoCount | The number of records in the MessageInfo arrays. |
MessageInfoDate | This property contains the date of a message in a message information listing. |
MessageInfoFlags | This property contains a message flag in a message information listing. |
MessageInfoFrom | This property contains the sender of a message in a message information listing. |
MessageInfoMessageId | The unique identifier of a message in a message information listing. |
MessageInfoSize | This property contains the size of a message in a message information listing. |
MessageInfoSubject | This property contains the subject of a message in a message information listing. |
MessageInReplyTo | This property includes the unique message identifier of the message being replied to. |
MessageNetId | This property includes the globally unique identifier of the message. |
MessagePartCount | The number of records in the MessagePart arrays. |
MessagePartContentDisposition | This property shows the value of the Content-Disposition header of the message part. |
MessagePartContentEncoding | This property shows how the data are encoded. |
MessagePartContentId | This property shows the value of the Content-Id header of the message part. |
MessagePartContentType | This property shows the type of data contained in the message part. |
MessagePartFileName | This property shows the filename corresponding to the part (if the part was included in the message as an attached file). |
MessagePartId | This property contains the identifier of a part listing that may be identified in other parts or messages. |
MessagePartMultipartMode | This property shows how this part relates to the message's whole multipart structure (e. |
MessagePartParameters | This property contains the additional parameters passed to the ContentType header, such as the part charset. |
MessagePartSize | This property contains the size of a part in a message part listing. |
MessageRecipientCount | The number of records in the MessageRecipient arrays. |
MessageRecipientAddress | This property contains the email address of the recipient. |
MessageRecipientName | This property contains the name of the recipient. |
MessageRecipientOptions | This property contains the recipient sending options (used only by SMTP). |
MessageRecipientType | This property contains the recipient type: To, Cc, or Bcc. |
MessageReplyTo | This property includes the email addresses to which replies to the message should be sent. |
MessageSender | This property includes the address of the sender of the message. |
MessageSet | This property includes the set of messages to operate on. |
MessageSize | This property includes the size of the selected message. |
MessageSubject | This property includes the subject of the message. |
MessageText | This property includes the body of the retrieved message. |
Overwrite | This property indicates whether or not the class should overwrite files during transfer. |
Password | This property includes the password to be used to authenticate to the MailServer . |
PeekMode | When set to True, the message Seen flag is not changed during reading. |
RecentMessageCount | This property includes the number of new messages in the Mailbox . |
SignerKeyCount | The number of records in the SignerKey arrays. |
SignerKeyEncoded | The key. |
SignerKeyKeyring | The location of the keyring. |
SignerKeyUserId | The user Id of the key. |
SortCriteria | This property sorts criteria to use for message retrieval operations. |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLEnabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLStartMode | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. |
StartByte | This property includes the byte index of the position where the transfer should start. |
Timeout | This property includes the timeout for the class. |
UIDMode | If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers. |
UIDValidity | This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command. |
User | This property includes the username used to authenticate to the MailServer . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddMessageFlags | This method adds the specified flags to the messages specified by MessageSet . |
AppendToMailbox | This method appends the message in MessageText to the mailbox specified by Mailbox . |
CheckMailbox | This method sends a CHECK command to the server. |
CloseMailbox | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox. |
Config | Sets or retrieves a configuration setting. |
Connect | This method connects to an IMAP server. |
CopyToMailbox | This method copies the messages specified by MessageSet to the mailbox specified by Mailbox . |
CreateMailbox | This method creates a new mailbox specified by Mailbox . |
Decrypt | Decrypts the message. |
DecryptAndVerifySignature | Decrypts and verifies the signature of the message. |
DeleteFromMailbox | The method marks the messages specified by MessageSet as deleted. |
DeleteMailbox | This method deletes a mailbox specified by Mailbox . |
DeleteMailboxACL | This method deletes mailbox access control rights for a specific user. |
Disconnect | This method disconnects from an IMAP server. |
DoEvents | This method processes events from the internal message queue. |
ExamineMailbox | This method selects a mailbox in read-only mode. |
ExpungeMailbox | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox. |
GetMailboxACL | This method retrieves mailbox access control rights. |
Interrupt | This method interrupts the current method. |
ListMailboxes | This method lists all of the mailboxes matching all criteria in the Mailbox property. |
ListSubscribedMailboxes | This method lists all subscribed mailboxes matching all criteria in the Mailbox property. |
LocalizeDate | This method converts a valid RFC 822 message date to a local date and time. |
MoveToMailbox | This method moves the messages specified by MessageSet to the mailbox specified by Mailbox . |
Noop | This method sends a NOOP command to the server. |
RenameMailbox | This method changes the name of Mailbox to NewName . |
ResetMessageFlags | This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags . |
RetrieveMessageHeaders | This method retrieves the message headers of the messages specified by the MessageSet property. |
RetrieveMessageInfo | This method retrieves information about messages specified by the MessageSet property. |
RetrieveMessagePart | This method retrieves the message part specified by PartID. |
RetrieveMessagePartHeaders | This method retrieves the headers of message part specified by PartID. |
RetrieveMessageText | This method retrieves the message text of the messages specified by the MessageSet property. |
SearchMailbox | This method searches the selected mailbox for specified text. |
SelectMailbox | This method selects a mailbox. |
SendCommand | This method sends the exact command directly to the server. |
SetMailboxACL | This method sets mailbox access control rights for a specific user. |
StartIdle | This method begins idling. |
StopIdle | This method stops idling. |
SubscribeMailbox | This method subscribes to the mailbox specified by Mailbox . |
UnsetMessageFlags | This method removes the flags specified by MessageFlags from the messages specified by MessageSet . |
UnsubscribeMailbox | This method unsubscribes from the mailbox specified by Mailbox . |
VerifySignature | Verifies the signature of the current message. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
ConnectionStatus | This event is fired to indicate changes in the connection state. |
EndTransfer | This event is fired when the message or the part data finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
Header | This event is fired every time a header line comes in. |
IdleInfo | This event fires whenever responses from the server are received while idling. |
KeyPassphrase | Fired if the passphrase of current key is incorrect or empty. |
MailboxACL | This event fires for each set of access control rights returned by the server. |
MailboxList | This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. |
MessageInfo | This event is fired with information for the messages retrieved by the server. |
MessagePart | This event is fired for each message part when RetrieveMessageInfo is called. |
PITrail | This event traces the commands sent to the mail server, and the respective replies. |
Progress | Fired as progress is made. |
RecipientInfo | Fired for each recipient key of the encrypted message. |
SignatureInfo | Fired during verification of the signed message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event is fired when the message body or the part data start transferring. |
Status | Shows the progress of the operation. |
Transfer | This event is fired while the message is transferred from the MailServer . |
VerificationStatus | Fired after verification of the signed message. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
Comment | The OpenPGP message comment. |
LogLevel | Specifies the level of detail that is logged. |
ProcessAttachments | Whether or not to process attachments. |
RequireValidSignature | Specifies if an invalid signature is considered an error condition. |
SymmetricPassphrase | The password used for symmetric encryption or decryption. |
VerifyClearTextSignatureWithCache | Whether the cleartext message is cached in memory when verifying a cleartext signature. |
VersionHeader | The Version header value in the ASCII armored OpenPGP message. |
RedownloadHeaders | Whether or not to redownload the message headers when querying MessageEncrypted or MessageSigned. |
AlwaysReturnUIDs | Instructs the server to return UIDs even if not in UIDMode. |
AppendToMailboxDateTime | Specifies the date-time parameter used in the initial APPEND request. |
AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
AutoDecodeSubject | Instructs the class to automatically decode message subjects. |
AutoDecodeText | Whether to decode MessageText when AutoDecodeParts is True. |
IncludeHeaders | Instructs the class to include the headers in the LocalFile. |
MaskSensitiveData | Whether sensitive properties should be masked when logging. |
RetrieveAfterSearch | Determines if messages matching the SearchCriteria are retrieved after calling SearchMailbox. |
RetrieveTextAndHeaders | Specifies whether the message body and headers are retrieved in a single request. |
SendIDCommand | Instructs class to send the ID command if the server advertises support for it. |
UTF7MailboxNames | Specifies whether or not to automatically encode and decode UTF-7 mailbox names. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AuthMechanism Property (IPWorksOpenPGP_PIMAP Class)
This property includes the authentication mechanism to be used when connecting to the mail server.
Object Oriented Interface
public function getAuthMechanism(); public function setAuthMechanism($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 1 ); ipworksopenpgp_pimap_set($res, 1, $value );
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. |
5 (amSASLDigestMD5) | SASLDigestMD5. See 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. |
Data Type
Integer
AutoDecodeParts Property (IPWorksOpenPGP_PIMAP Class)
This property determines whether or not to automatically decode message parts.
Object Oriented Interface
public function getAutoDecodeParts(); public function setAutoDecodeParts($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 2 ); ipworksopenpgp_pimap_set($res, 2, $value );
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
Boolean
Connected Property (IPWorksOpenPGP_PIMAP Class)
This property shows whether the class is connected.
Object Oriented Interface
public function getConnected();
Procedural Interface
ipworksopenpgp_pimap_get($res, 3 );
Default Value
false
Remarks
This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
Data Type
Boolean
EndByte Property (IPWorksOpenPGP_PIMAP Class)
This property includes the byte index of the position where the transfer should end.
Object Oriented Interface
public function getEndByte(); public function setEndByte($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 4 ); ipworksopenpgp_pimap_set($res, 4, $value );
Default Value
0
Remarks
StartByte and EndByte are used together with the RetrieveMessagePart method to specify the portion of the message to be retrieved from the server.
When StartByte 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.
This property is not available at design time.
Data Type
Long64
FirewallAutoDetect Property (IPWorksOpenPGP_PIMAP Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Object Oriented Interface
public function getFirewallAutoDetect(); public function setFirewallAutoDetect($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 5 ); ipworksopenpgp_pimap_set($res, 5, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (IPWorksOpenPGP_PIMAP Class)
This property determines the type of firewall to connect through.
Object Oriented Interface
public function getFirewallType(); public function setFirewallType($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 6 ); ipworksopenpgp_pimap_set($res, 6, $value );
Default Value
0
Remarks
This property determines 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 is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (IPWorksOpenPGP_PIMAP Class)
This property contains the name or IP address of the firewall (optional).
Object Oriented Interface
public function getFirewallHost(); public function setFirewallHost($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 7 ); ipworksopenpgp_pimap_set($res, 7, $value );
Default Value
''
Remarks
This property contains the name or IP address of the firewall (optional). If a FirewallHost 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 class fails with an error.
Data Type
String
FirewallPassword Property (IPWorksOpenPGP_PIMAP Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Object Oriented Interface
public function getFirewallPassword(); public function setFirewallPassword($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 8 ); ipworksopenpgp_pimap_set($res, 8, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (IPWorksOpenPGP_PIMAP Class)
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Object Oriented Interface
public function getFirewallPort(); public function setFirewallPort($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 9 ); ipworksopenpgp_pimap_set($res, 9, $value );
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (IPWorksOpenPGP_PIMAP Class)
This property contains a username if authentication is to be used when connecting through a firewall.
Object Oriented Interface
public function getFirewallUser(); public function setFirewallUser($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 10 ); ipworksopenpgp_pimap_set($res, 10, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
Idle Property (IPWorksOpenPGP_PIMAP Class)
This property specifies the current status of the class.
Object Oriented Interface
public function getIdle();
Procedural Interface
ipworksopenpgp_pimap_get($res, 11 );
Default Value
true
Remarks
Idle 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
Boolean
KeyCount Property (IPWorksOpenPGP_PIMAP Class)
The number of records in the Key arrays.
Object Oriented Interface
public function getKeyCount(); public function setKeyCount($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 12 ); ipworksopenpgp_pimap_set($res, 12, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KeyCount - 1.This property is not available at design time.
Data Type
Integer
KeyEncoded Property (IPWorksOpenPGP_PIMAP Class)
The key.
Object Oriented Interface
public function getKeyEncoded($keyindex); public function setKeyEncoded($keyindex, $value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 15 , $keyindex); ipworksopenpgp_pimap_set($res, 15, $value , $keyindex);
Default Value
''
Remarks
The key. This property can be used to assign a specific key. The KeyFingerprint, KeyId, and KeyUserId properties may also be used to specify a key.
The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is not available at design time.
Data Type
Binary String
KeyKeyring Property (IPWorksOpenPGP_PIMAP Class)
The location of the keyring.
Object Oriented Interface
public function getKeyKeyring($keyindex); public function setKeyKeyring($keyindex, $value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 19 , $keyindex); ipworksopenpgp_pimap_set($res, 19, $value , $keyindex);
Default Value
''
Remarks
The location of the keyring.
If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.
When This property is set the class will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.
The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is not available at design time.
Data Type
String
KeyPassphrase Property (IPWorksOpenPGP_PIMAP Class)
The passphrase for the key's secret key (if any).
Object Oriented Interface
public function getKeyPassphrase($keyindex); public function setKeyPassphrase($keyindex, $value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 21 , $keyindex); ipworksopenpgp_pimap_set($res, 21, $value , $keyindex);
Default Value
''
Remarks
The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.
The passphrase is required when using the following methods in KeyMgr:
- AddUserId
- SignUserId
- ChangeExpirationDate
- ChangePassphrase
When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:
- Decrypt
- Sign
- SignAndEncrypt
The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is not available at design time.
Data Type
String
KeyUserId Property (IPWorksOpenPGP_PIMAP Class)
The user Id of the key.
Object Oriented Interface
public function getKeyUserId($keyindex); public function setKeyUserId($keyindex, $value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 30 , $keyindex); ipworksopenpgp_pimap_set($res, 30, $value , $keyindex);
Default Value
''
Remarks
The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the class will search the Keyring for a key associated with the UserId specified.
When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.
The UserId format is:
FirstName LastName (Comment) <Email>Not all values are required when selecting or generating a key, but at least FirstName or Email are required.
Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.
When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's RecipientInfo event.
The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is not available at design time.
Data Type
String
LastReply Property (IPWorksOpenPGP_PIMAP Class)
This property indicates the last reply received from the server.
Object Oriented Interface
public function getLastReply();
Procedural Interface
ipworksopenpgp_pimap_get($res, 32 );
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 event.
This property is read-only.
Data Type
String
LocalHost Property (IPWorksOpenPGP_PIMAP Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 33 ); ipworksopenpgp_pimap_set($res, 33, $value );
Default Value
''
Remarks
The LocalHost 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 class initiate connections (or accept in the case of server classs) 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 class 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 (IPWorksOpenPGP_PIMAP Class)
This property includes the name of the mailbox selected on the server.
Object Oriented Interface
public function getMailbox(); public function setMailbox($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 34 ); ipworksopenpgp_pimap_set($res, 34, $value );
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 class methods for more information.
Example 1. Open a Mailbox in Read/Write Mode:
IMAPControl.Mailbox = "INBOX"
IMAPControl.SelectMailbox
Example 2. Open a Mailbox in Read-Only Mode:
IMAPControl.Mailbox = "INBOX.Folder"
IMAPControl.ExamineMailbox
Data Type
String
MailboxFlags Property (IPWorksOpenPGP_PIMAP Class)
This property defines flags in the selected mailbox.
Object Oriented Interface
public function getMailboxFlags();
Procedural Interface
ipworksopenpgp_pimap_get($res, 35 );
Default Value
''
Remarks
This property defines flags in the selected mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.
This property is read-only and not available at design time.
Data Type
String
MailboxListCount Property (IPWorksOpenPGP_PIMAP Class)
The number of records in the MailboxList arrays.
Object Oriented Interface
public function getMailboxListCount();
Procedural Interface
ipworksopenpgp_pimap_get($res, 36 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MailboxListCount - 1.This property is read-only and not available at design time.
Data Type
Integer
MailboxListFlags Property (IPWorksOpenPGP_PIMAP Class)
This property contains the mailbox flags in a mailbox listing.
Object Oriented Interface
public function getMailboxListFlags($mailboxlistindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 37 , $mailboxlistindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MailboxListName Property (IPWorksOpenPGP_PIMAP Class)
This property contains the mailbox name in a mailbox listing.
Object Oriented Interface
public function getMailboxListName($mailboxlistindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 38 , $mailboxlistindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MailboxListSeparator Property (IPWorksOpenPGP_PIMAP Class)
The Separator property contains the character that separates the different parts in the mailbox path hierarchy.
Object Oriented Interface
public function getMailboxListSeparator($mailboxlistindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 39 , $mailboxlistindex);
Default Value
''
Remarks
The MailboxListSeparator 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 property.
This property is read-only and not available at design time.
Data Type
String
MailPort Property (IPWorksOpenPGP_PIMAP Class)
This property includes the port of the IMAP server (default is 143).
Object Oriented Interface
public function getMailPort(); public function setMailPort($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 40 ); ipworksopenpgp_pimap_set($res, 40, $value );
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 property for more information).
This property is not available at design time.
Data Type
Integer
MailServer Property (IPWorksOpenPGP_PIMAP Class)
This property includes the name or address of the mail server (IMAP server).
Object Oriented Interface
public function getMailServer(); public function setMailServer($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 41 ); ipworksopenpgp_pimap_set($res, 41, $value );
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 class 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 (IPWorksOpenPGP_PIMAP Class)
This property provides the raw message content.
Object Oriented Interface
public function getMessage(); public function setMessage($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 42 ); ipworksopenpgp_pimap_set($res, 42, $value );
Default Value
''
Remarks
This property is populated after calling RetrieveMessagePart and holds the raw message content. This can be used to access the data before any processing is done by the class.
This property is not available at design time.
Data Type
Binary String
MessageContentEncoding Property (IPWorksOpenPGP_PIMAP Class)
This property includes the ContentEncoding of the selected message.
Object Oriented Interface
public function getMessageContentEncoding();
Procedural Interface
ipworksopenpgp_pimap_get($res, 43 );
Default Value
''
Remarks
The property is automatically set by the class when message information is retrieved through the RetrieveMessageInfo method.
This property is read-only and not available at design time.
Data Type
String
MessageContentType Property (IPWorksOpenPGP_PIMAP Class)
This property includes the ContentType of the message.
Object Oriented Interface
public function getMessageContentType();
Procedural Interface
ipworksopenpgp_pimap_get($res, 44 );
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 property or read the individual message parts.
This property is read-only and not available at design time.
Data Type
String
MessageCount Property (IPWorksOpenPGP_PIMAP Class)
This property includes the total number of messages on the Mailbox .
Object Oriented Interface
public function getMessageCount();
Procedural Interface
ipworksopenpgp_pimap_get($res, 45 );
Default Value
0
Remarks
This property contains the total number of messages on the Mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.
This property is read-only.
Data Type
Integer
MessageDate Property (IPWorksOpenPGP_PIMAP Class)
The property includes the time the message was created.
Object Oriented Interface
public function getMessageDate();
Procedural Interface
ipworksopenpgp_pimap_get($res, 46 );
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 and not available at design time.
Data Type
String
MessageDeliveryTime Property (IPWorksOpenPGP_PIMAP Class)
This property includes the time the message was delivered to the mail server.
Object Oriented Interface
public function getMessageDeliveryTime();
Procedural Interface
ipworksopenpgp_pimap_get($res, 47 );
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 and not available at design time.
Data Type
String
MessageFlags Property (IPWorksOpenPGP_PIMAP Class)
This property contains the flags of the current message.
Object Oriented Interface
public function getMessageFlags(); public function setMessageFlags($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 48 ); ipworksopenpgp_pimap_set($res, 48, $value );
Default Value
''
Remarks
This property contains the flags of the current message. It also is used to specify flags when AppendToMailbox 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). |
\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). |
IMAPControl.MessageSet = "1"
IMAPControl.AddMessageFlags("\Deleted")
This property is not available at design time.
Data Type
String
MessageFrom Property (IPWorksOpenPGP_PIMAP Class)
This property includes the address of the author of the message.
Object Oriented Interface
public function getMessageFrom();
Procedural Interface
ipworksopenpgp_pimap_get($res, 49 );
Default Value
''
Remarks
This property normally has the same value as MessageSender.
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 and not available at design time.
Data Type
String
MessageHeaderCount Property (IPWorksOpenPGP_PIMAP Class)
The number of records in the MessageHeader arrays.
Object Oriented Interface
public function getMessageHeaderCount(); public function setMessageHeaderCount($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 50 ); ipworksopenpgp_pimap_set($res, 50, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessageHeaderCount - 1.This property is not available at design time.
Data Type
Integer
MessageHeaderField Property (IPWorksOpenPGP_PIMAP Class)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Object Oriented Interface
public function getMessageHeaderField($messageheaderindex); public function setMessageHeaderField($messageheaderindex, $value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 51 , $messageheaderindex); ipworksopenpgp_pimap_set($res, 51, $value , $messageheaderindex);
Default Value
''
Remarks
This property contains the name of the HTTP 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 property.
This property is not available at design time.
Data Type
String
MessageHeaderValue Property (IPWorksOpenPGP_PIMAP Class)
This property contains the header contents.
Object Oriented Interface
public function getMessageHeaderValue($messageheaderindex); public function setMessageHeaderValue($messageheaderindex, $value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 52 , $messageheaderindex); ipworksopenpgp_pimap_set($res, 52, $value , $messageheaderindex);
Default Value
''
Remarks
This property contains the Header contents.
The $messageheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.
This property is not available at design time.
Data Type
String
MessageHeadersString Property (IPWorksOpenPGP_PIMAP Class)
This property includes the string version of the RFC 822-encoded headers in the message.
Object Oriented Interface
public function getMessageHeadersString(); public function setMessageHeadersString($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 53 ); ipworksopenpgp_pimap_set($res, 53, $value );
Default Value
''
Remarks
This property contains the full headers of the message in RFC 822 format. The headers are retrieved by calling the RetrieveMessageHeaders or the RetrieveMessagePartHeaders method.
This property is not available at design time.
Data Type
String
MessageId Property (IPWorksOpenPGP_PIMAP Class)
This property includes the message identifier of the current message.
Object Oriented Interface
public function getMessageId();
Procedural Interface
ipworksopenpgp_pimap_get($res, 54 );
Default Value
''
Remarks
The class fills out this property when message information is retrieved from the MailServer.
This Id is permanent if UIDMode is set, and otherwise is temporary.
This property is read-only and not available at design time.
Data Type
String
MessageInfoCount Property (IPWorksOpenPGP_PIMAP Class)
The number of records in the MessageInfo arrays.
Object Oriented Interface
public function getMessageInfoCount();
Procedural Interface
ipworksopenpgp_pimap_get($res, 55 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessageInfoCount - 1.This property is read-only and not available at design time.
Data Type
Integer
MessageInfoDate Property (IPWorksOpenPGP_PIMAP Class)
This property contains the date of a message in a message information listing.
Object Oriented Interface
public function getMessageInfoDate($messageinfoindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 56 , $messageinfoindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoFlags Property (IPWorksOpenPGP_PIMAP Class)
This property contains a message flag in a message information listing.
Object Oriented Interface
public function getMessageInfoFlags($messageinfoindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 57 , $messageinfoindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoFrom Property (IPWorksOpenPGP_PIMAP Class)
This property contains the sender of a message in a message information listing.
Object Oriented Interface
public function getMessageInfoFrom($messageinfoindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 58 , $messageinfoindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoMessageId Property (IPWorksOpenPGP_PIMAP Class)
The unique identifier of a message in a message information listing.
Object Oriented Interface
public function getMessageInfoMessageId($messageinfoindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 59 , $messageinfoindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoSize Property (IPWorksOpenPGP_PIMAP Class)
This property contains the size of a message in a message information listing.
Object Oriented Interface
public function getMessageInfoSize($messageinfoindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 60 , $messageinfoindex);
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 property.
This property is read-only and not available at design time.
Data Type
Long64
MessageInfoSubject Property (IPWorksOpenPGP_PIMAP Class)
This property contains the subject of a message in a message information listing.
Object Oriented Interface
public function getMessageInfoSubject($messageinfoindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 61 , $messageinfoindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessageInReplyTo Property (IPWorksOpenPGP_PIMAP Class)
This property includes the unique message identifier of the message being replied to.
Object Oriented Interface
public function getMessageInReplyTo();
Procedural Interface
ipworksopenpgp_pimap_get($res, 62 );
Default Value
''
Remarks
The class 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 property.
This property is read-only and not available at design time.
Data Type
String
MessageNetId Property (IPWorksOpenPGP_PIMAP Class)
This property includes the globally unique identifier of the message.
Object Oriented Interface
public function getMessageNetId();
Procedural Interface
ipworksopenpgp_pimap_get($res, 63 );
Default Value
''
Remarks
This property contains the globally unique identifier of the message. The class 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 and not available at design time.
Data Type
String
MessagePartCount Property (IPWorksOpenPGP_PIMAP Class)
The number of records in the MessagePart arrays.
Object Oriented Interface
public function getMessagePartCount();
Procedural Interface
ipworksopenpgp_pimap_get($res, 64 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- MessagePartContentDisposition
- MessagePartContentEncoding
- MessagePartContentId
- MessagePartContentType
- MessagePartFileName
- MessagePartId
- MessagePartMultipartMode
- MessagePartParameters
- MessagePartSize
This property is read-only and not available at design time.
Data Type
Integer
MessagePartContentDisposition Property (IPWorksOpenPGP_PIMAP Class)
This property shows the value of the Content-Disposition header of the message part.
Object Oriented Interface
public function getMessagePartContentDisposition($messagepartindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 65 , $messagepartindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessagePartContentEncoding Property (IPWorksOpenPGP_PIMAP Class)
This property shows how the data are encoded.
Object Oriented Interface
public function getMessagePartContentEncoding($messagepartindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 66 , $messagepartindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessagePartContentId Property (IPWorksOpenPGP_PIMAP Class)
This property shows the value of the Content-Id header of the message part.
Object Oriented Interface
public function getMessagePartContentId($messagepartindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 67 , $messagepartindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessagePartContentType Property (IPWorksOpenPGP_PIMAP Class)
This property shows the type of data contained in the message part.
Object Oriented Interface
public function getMessagePartContentType($messagepartindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 68 , $messagepartindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessagePartFileName Property (IPWorksOpenPGP_PIMAP Class)
This property shows the filename corresponding to the part (if the part was included in the message as an attached file).
Object Oriented Interface
public function getMessagePartFileName($messagepartindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 69 , $messagepartindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessagePartId Property (IPWorksOpenPGP_PIMAP Class)
This property contains the identifier of a part listing that may be identified in other parts or messages.
Object Oriented Interface
public function getMessagePartId($messagepartindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 70 , $messagepartindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessagePartMultipartMode Property (IPWorksOpenPGP_PIMAP Class)
This property shows how this part relates to the message's whole multipart structure (e.
Object Oriented Interface
public function getMessagePartMultipartMode($messagepartindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 71 , $messagepartindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessagePartParameters Property (IPWorksOpenPGP_PIMAP Class)
This property contains the additional parameters passed to the ContentType header, such as the part charset.
Object Oriented Interface
public function getMessagePartParameters($messagepartindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 72 , $messagepartindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessagePartSize Property (IPWorksOpenPGP_PIMAP Class)
This property contains the size of a part in a message part listing.
Object Oriented Interface
public function getMessagePartSize($messagepartindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 73 , $messagepartindex);
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 property.
This property is read-only and not available at design time.
Data Type
Long64
MessageRecipientCount Property (IPWorksOpenPGP_PIMAP Class)
The number of records in the MessageRecipient arrays.
Object Oriented Interface
public function getMessageRecipientCount();
Procedural Interface
ipworksopenpgp_pimap_get($res, 74 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessageRecipientCount - 1.This property is read-only and not available at design time.
Data Type
Integer
MessageRecipientAddress Property (IPWorksOpenPGP_PIMAP Class)
This property contains the email address of the recipient.
Object Oriented Interface
public function getMessageRecipientAddress($recipientindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 75 , $recipientindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessageRecipientName Property (IPWorksOpenPGP_PIMAP Class)
This property contains the name of the recipient.
Object Oriented Interface
public function getMessageRecipientName($recipientindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 76 , $recipientindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
MessageRecipientOptions Property (IPWorksOpenPGP_PIMAP Class)
This property contains the recipient sending options (used only by SMTP).
Object Oriented Interface
public function getMessageRecipientOptions($recipientindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 77 , $recipientindex);
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).
One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.
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 property.
This property is read-only and not available at design time.
Data Type
String
MessageRecipientType Property (IPWorksOpenPGP_PIMAP Class)
This property contains the recipient type: To, Cc, or Bcc.
Object Oriented Interface
public function getMessageRecipientType($recipientindex);
Procedural Interface
ipworksopenpgp_pimap_get($res, 78 , $recipientindex);
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 property.
This property is read-only and not available at design time.
Data Type
Integer
MessageReplyTo Property (IPWorksOpenPGP_PIMAP Class)
This property includes the email addresses to which replies to the message should be sent.
Object Oriented Interface
public function getMessageReplyTo();
Procedural Interface
ipworksopenpgp_pimap_get($res, 79 );
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 and not available at design time.
Data Type
String
MessageSender Property (IPWorksOpenPGP_PIMAP Class)
This property includes the address of the sender of the message.
Object Oriented Interface
public function getMessageSender();
Procedural Interface
ipworksopenpgp_pimap_get($res, 80 );
Default Value
''
Remarks
This property contains the address of the sender of the message. This normally is the same value as MessageFrom.
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 and not available at design time.
Data Type
String
MessageSet Property (IPWorksOpenPGP_PIMAP Class)
This property includes the set of messages to operate on.
Object Oriented Interface
public function getMessageSet(); public function setMessageSet($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 81 ); ipworksopenpgp_pimap_set($res, 81, $value );
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:
IMAPControl.MessageSet = "1"
IMAPControl.RetrieveMessageInfo()
IMAPControl.MessageSet = "1:5"
IMAPControl.RetrieveMessageInfo()
IMAPControl.MessageSet = "1,5,7"
IMAPControl.RetrieveMessageInfo()
Data Type
String
MessageSize Property (IPWorksOpenPGP_PIMAP Class)
This property includes the size of the selected message.
Object Oriented Interface
public function getMessageSize();
Procedural Interface
ipworksopenpgp_pimap_get($res, 82 );
Default Value
0
Remarks
The class fills out this property with the size of the selected message when message information is retrieved from the MailServer.
This property is read-only and not available at design time.
Data Type
Long64
MessageSubject Property (IPWorksOpenPGP_PIMAP Class)
This property includes the subject of the message.
Object Oriented Interface
public function getMessageSubject();
Procedural Interface
ipworksopenpgp_pimap_get($res, 83 );
Default Value
''
Remarks
The class fills out this property with the subject of the message when message information is retrieved from the MailServer.
This property is read-only and not available at design time.
Data Type
String
MessageText Property (IPWorksOpenPGP_PIMAP Class)
This property includes the body of the retrieved message.
Object Oriented Interface
public function getMessageText(); public function setMessageText($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 84 ); ipworksopenpgp_pimap_set($res, 84, $value );
Default Value
''
Remarks
The class fills out this property with the contents of the message body (in RFC 822 format) when a call to RetrieveMessageText completes successfully and the LocalFile property is not set.
This property is not available at design time.
Data Type
String
Overwrite Property (IPWorksOpenPGP_PIMAP Class)
This property indicates whether or not the class should overwrite files during transfer.
Object Oriented Interface
public function getOverwrite(); public function setOverwrite($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 85 ); ipworksopenpgp_pimap_set($res, 85, $value );
Default Value
false
Remarks
This property is a value indicating whether or not the class should overwrite files when downloading the message text or a message part and LocalFile is set. If Overwrite is False, an error will be thrown whenever LocalFile exists.
Data Type
Boolean
Password Property (IPWorksOpenPGP_PIMAP Class)
This property includes the password to be used to authenticate to the MailServer .
Object Oriented Interface
public function getPassword(); public function setPassword($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 86 ); ipworksopenpgp_pimap_set($res, 86, $value );
Default Value
''
Remarks
This property contains the password used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.
Data Type
String
PeekMode Property (IPWorksOpenPGP_PIMAP Class)
When set to True, the message Seen flag is not changed during reading.
Object Oriented Interface
public function getPeekMode(); public function setPeekMode($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 87 ); ipworksopenpgp_pimap_set($res, 87, $value );
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.
This property is not available at design time.
Data Type
Boolean
RecentMessageCount Property (IPWorksOpenPGP_PIMAP Class)
This property includes the number of new messages in the Mailbox .
Object Oriented Interface
public function getRecentMessageCount();
Procedural Interface
ipworksopenpgp_pimap_get($res, 88 );
Default Value
0
Remarks
This property contains the number of new messages that are in the Mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.
This property is read-only.
Data Type
Integer
SignerKeyCount Property (IPWorksOpenPGP_PIMAP Class)
The number of records in the SignerKey arrays.
Object Oriented Interface
public function getSignerKeyCount(); public function setSignerKeyCount($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 89 ); ipworksopenpgp_pimap_set($res, 89, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SignerKeyCount - 1.This property is not available at design time.
Data Type
Integer
SignerKeyEncoded Property (IPWorksOpenPGP_PIMAP Class)
The key.
Object Oriented Interface
public function getSignerKeyEncoded($signerkeyindex); public function setSignerKeyEncoded($signerkeyindex, $value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 92 , $signerkeyindex); ipworksopenpgp_pimap_set($res, 92, $value , $signerkeyindex);
Default Value
''
Remarks
The key. This property can be used to assign a specific key. The SignerKeyFingerprint, SignerKeyId, and SignerKeyUserId properties may also be used to specify a key.
The $signerkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.
This property is not available at design time.
Data Type
Binary String
SignerKeyKeyring Property (IPWorksOpenPGP_PIMAP Class)
The location of the keyring.
Object Oriented Interface
public function getSignerKeyKeyring($signerkeyindex); public function setSignerKeyKeyring($signerkeyindex, $value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 96 , $signerkeyindex); ipworksopenpgp_pimap_set($res, 96, $value , $signerkeyindex);
Default Value
''
Remarks
The location of the keyring.
If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.
When This property is set the class will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.
The $signerkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.
This property is not available at design time.
Data Type
String
SignerKeyUserId Property (IPWorksOpenPGP_PIMAP Class)
The user Id of the key.
Object Oriented Interface
public function getSignerKeyUserId($signerkeyindex); public function setSignerKeyUserId($signerkeyindex, $value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 107 , $signerkeyindex); ipworksopenpgp_pimap_set($res, 107, $value , $signerkeyindex);
Default Value
''
Remarks
The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the class will search the Keyring for a key associated with the UserId specified.
When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.
The UserId format is:
FirstName LastName (Comment) <Email>Not all values are required when selecting or generating a key, but at least FirstName or Email are required.
Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.
When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's RecipientInfo event.
The $signerkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.
This property is not available at design time.
Data Type
String
SortCriteria Property (IPWorksOpenPGP_PIMAP Class)
This property sorts criteria to use for message retrieval operations.
Object Oriented Interface
public function getSortCriteria(); public function setSortCriteria($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 109 ); ipworksopenpgp_pimap_set($res, 109, $value );
Default Value
''
Remarks
This property sorts criteria to use for message retrieval operations. When set, the class 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:
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 <criterion> | 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 (IPWorksOpenPGP_PIMAP Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLAcceptServerCertEffectiveDate();
Procedural Interface
ipworksopenpgp_pimap_get($res, 110 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLAcceptServerCertExpirationDate();
Procedural Interface
ipworksopenpgp_pimap_get($res, 111 );
Default Value
''
Remarks
This is the date 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 (IPWorksOpenPGP_PIMAP Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLAcceptServerCertExtendedKeyUsage();
Procedural Interface
ipworksopenpgp_pimap_get($res, 112 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprint();
Procedural Interface
ipworksopenpgp_pimap_get($res, 113 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA1();
Procedural Interface
ipworksopenpgp_pimap_get($res, 114 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA256();
Procedural Interface
ipworksopenpgp_pimap_get($res, 115 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertIssuer();
Procedural Interface
ipworksopenpgp_pimap_get($res, 116 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKey();
Procedural Interface
ipworksopenpgp_pimap_get($res, 117 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksOpenPGP_PIMAP Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyAvailable();
Procedural Interface
ipworksopenpgp_pimap_get($res, 118 );
Default Value
false
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (IPWorksOpenPGP_PIMAP Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyContainer();
Procedural Interface
ipworksopenpgp_pimap_get($res, 119 );
Default Value
''
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (IPWorksOpenPGP_PIMAP Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKey();
Procedural Interface
ipworksopenpgp_pimap_get($res, 120 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyAlgorithm();
Procedural Interface
ipworksopenpgp_pimap_get($res, 121 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyLength();
Procedural Interface
ipworksopenpgp_pimap_get($res, 122 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (IPWorksOpenPGP_PIMAP Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLAcceptServerCertSerialNumber();
Procedural Interface
ipworksopenpgp_pimap_get($res, 123 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertSignatureAlgorithm();
Procedural Interface
ipworksopenpgp_pimap_get($res, 124 );
Default Value
''
Remarks
The property contains 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 (IPWorksOpenPGP_PIMAP Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStore(); public function setSSLAcceptServerCertStore($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 125 ); ipworksopenpgp_pimap_set($res, 125, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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
Binary String
SSLAcceptServerCertStorePassword Property (IPWorksOpenPGP_PIMAP Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLAcceptServerCertStorePassword(); public function setSSLAcceptServerCertStorePassword($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 126 ); ipworksopenpgp_pimap_set($res, 126, $value );
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 (IPWorksOpenPGP_PIMAP Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStoreType(); public function setSSLAcceptServerCertStoreType($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 127 ); ipworksopenpgp_pimap_set($res, 127, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
SSLAcceptServerCertSubjectAltNames Property (IPWorksOpenPGP_PIMAP Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertSubjectAltNames();
Procedural Interface
ipworksopenpgp_pimap_get($res, 128 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (IPWorksOpenPGP_PIMAP Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintMD5();
Procedural Interface
ipworksopenpgp_pimap_get($res, 129 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA1();
Procedural Interface
ipworksopenpgp_pimap_get($res, 130 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA256();
Procedural Interface
ipworksopenpgp_pimap_get($res, 131 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLAcceptServerCertUsage();
Procedural Interface
ipworksopenpgp_pimap_get($res, 132 );
Default Value
''
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
This value will be of 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertUsageFlags();
Procedural Interface
ipworksopenpgp_pimap_get($res, 133 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags 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 property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (IPWorksOpenPGP_PIMAP Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLAcceptServerCertVersion();
Procedural Interface
ipworksopenpgp_pimap_get($res, 134 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLAcceptServerCertSubject(); public function setSSLAcceptServerCertSubject($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 135 ); ipworksopenpgp_pimap_set($res, 135, $value );
Default Value
''
Remarks
This is 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=support@nsoftware.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 (IPWorksOpenPGP_PIMAP Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLAcceptServerCertEncoded(); public function setSSLAcceptServerCertEncoded($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 136 ); ipworksopenpgp_pimap_set($res, 136, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEffectiveDate Property (IPWorksOpenPGP_PIMAP Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLCertEffectiveDate();
Procedural Interface
ipworksopenpgp_pimap_get($res, 137 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLCertExpirationDate();
Procedural Interface
ipworksopenpgp_pimap_get($res, 138 );
Default Value
''
Remarks
This is the date 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 (IPWorksOpenPGP_PIMAP Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLCertExtendedKeyUsage();
Procedural Interface
ipworksopenpgp_pimap_get($res, 139 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprint();
Procedural Interface
ipworksopenpgp_pimap_get($res, 140 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA1();
Procedural Interface
ipworksopenpgp_pimap_get($res, 141 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA256();
Procedural Interface
ipworksopenpgp_pimap_get($res, 142 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLCertIssuer();
Procedural Interface
ipworksopenpgp_pimap_get($res, 143 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKey();
Procedural Interface
ipworksopenpgp_pimap_get($res, 144 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (IPWorksOpenPGP_PIMAP Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLCertPrivateKeyAvailable();
Procedural Interface
ipworksopenpgp_pimap_get($res, 145 );
Default Value
false
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (IPWorksOpenPGP_PIMAP Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKeyContainer();
Procedural Interface
ipworksopenpgp_pimap_get($res, 146 );
Default Value
''
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (IPWorksOpenPGP_PIMAP Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLCertPublicKey();
Procedural Interface
ipworksopenpgp_pimap_get($res, 147 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLCertPublicKeyAlgorithm();
Procedural Interface
ipworksopenpgp_pimap_get($res, 148 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLCertPublicKeyLength();
Procedural Interface
ipworksopenpgp_pimap_get($res, 149 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (IPWorksOpenPGP_PIMAP Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLCertSerialNumber();
Procedural Interface
ipworksopenpgp_pimap_get($res, 150 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLCertSignatureAlgorithm();
Procedural Interface
ipworksopenpgp_pimap_get($res, 151 );
Default Value
''
Remarks
The property contains 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 (IPWorksOpenPGP_PIMAP Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLCertStore(); public function setSSLCertStore($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 152 ); ipworksopenpgp_pimap_set($res, 152, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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
Binary String
SSLCertStorePassword Property (IPWorksOpenPGP_PIMAP Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLCertStorePassword(); public function setSSLCertStorePassword($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 153 ); ipworksopenpgp_pimap_set($res, 153, $value );
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 (IPWorksOpenPGP_PIMAP Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLCertStoreType(); public function setSSLCertStoreType($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 154 ); ipworksopenpgp_pimap_set($res, 154, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
SSLCertSubjectAltNames Property (IPWorksOpenPGP_PIMAP Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLCertSubjectAltNames();
Procedural Interface
ipworksopenpgp_pimap_get($res, 155 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (IPWorksOpenPGP_PIMAP Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintMD5();
Procedural Interface
ipworksopenpgp_pimap_get($res, 156 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA1();
Procedural Interface
ipworksopenpgp_pimap_get($res, 157 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA256();
Procedural Interface
ipworksopenpgp_pimap_get($res, 158 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLCertUsage();
Procedural Interface
ipworksopenpgp_pimap_get($res, 159 );
Default Value
''
Remarks
This property contains the text description of SSLCertUsageFlags.
This value will be of 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLCertUsageFlags();
Procedural Interface
ipworksopenpgp_pimap_get($res, 160 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags 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 property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (IPWorksOpenPGP_PIMAP Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLCertVersion();
Procedural Interface
ipworksopenpgp_pimap_get($res, 161 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLCertSubject(); public function setSSLCertSubject($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 162 ); ipworksopenpgp_pimap_set($res, 162, $value );
Default Value
''
Remarks
This is 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=support@nsoftware.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 (IPWorksOpenPGP_PIMAP Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLCertEncoded(); public function setSSLCertEncoded($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 163 ); ipworksopenpgp_pimap_set($res, 163, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLEnabled Property (IPWorksOpenPGP_PIMAP Class)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Object Oriented Interface
public function getSSLEnabled(); public function setSSLEnabled($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 164 ); ipworksopenpgp_pimap_set($res, 164, $value );
Default Value
false
Remarks
This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.
TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.
This property is not available at design time.
Data Type
Boolean
SSLProvider Property (IPWorksOpenPGP_PIMAP Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Object Oriented Interface
public function getSSLProvider(); public function setSSLProvider($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 165 ); ipworksopenpgp_pimap_set($res, 165, $value );
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 class 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. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEffectiveDate Property (IPWorksOpenPGP_PIMAP Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLServerCertEffectiveDate();
Procedural Interface
ipworksopenpgp_pimap_get($res, 166 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLServerCertExpirationDate();
Procedural Interface
ipworksopenpgp_pimap_get($res, 167 );
Default Value
''
Remarks
This is the date 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 (IPWorksOpenPGP_PIMAP Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLServerCertExtendedKeyUsage();
Procedural Interface
ipworksopenpgp_pimap_get($res, 168 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprint();
Procedural Interface
ipworksopenpgp_pimap_get($res, 169 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA1();
Procedural Interface
ipworksopenpgp_pimap_get($res, 170 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA256();
Procedural Interface
ipworksopenpgp_pimap_get($res, 171 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLServerCertIssuer();
Procedural Interface
ipworksopenpgp_pimap_get($res, 172 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKey();
Procedural Interface
ipworksopenpgp_pimap_get($res, 173 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (IPWorksOpenPGP_PIMAP Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLServerCertPrivateKeyAvailable();
Procedural Interface
ipworksopenpgp_pimap_get($res, 174 );
Default Value
false
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (IPWorksOpenPGP_PIMAP Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKeyContainer();
Procedural Interface
ipworksopenpgp_pimap_get($res, 175 );
Default Value
''
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (IPWorksOpenPGP_PIMAP Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLServerCertPublicKey();
Procedural Interface
ipworksopenpgp_pimap_get($res, 176 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLServerCertPublicKeyAlgorithm();
Procedural Interface
ipworksopenpgp_pimap_get($res, 177 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLServerCertPublicKeyLength();
Procedural Interface
ipworksopenpgp_pimap_get($res, 178 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (IPWorksOpenPGP_PIMAP Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLServerCertSerialNumber();
Procedural Interface
ipworksopenpgp_pimap_get($res, 179 );
Default Value
''
Remarks
This is 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 (IPWorksOpenPGP_PIMAP Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLServerCertSignatureAlgorithm();
Procedural Interface
ipworksopenpgp_pimap_get($res, 180 );
Default Value
''
Remarks
The property contains 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 (IPWorksOpenPGP_PIMAP Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLServerCertStore();
Procedural Interface
ipworksopenpgp_pimap_get($res, 181 );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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
Binary String
SSLServerCertStorePassword Property (IPWorksOpenPGP_PIMAP Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLServerCertStorePassword();
Procedural Interface
ipworksopenpgp_pimap_get($res, 182 );
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 (IPWorksOpenPGP_PIMAP Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLServerCertStoreType();
Procedural Interface
ipworksopenpgp_pimap_get($res, 183 );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
SSLServerCertSubjectAltNames Property (IPWorksOpenPGP_PIMAP Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLServerCertSubjectAltNames();
Procedural Interface
ipworksopenpgp_pimap_get($res, 184 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (IPWorksOpenPGP_PIMAP Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintMD5();
Procedural Interface
ipworksopenpgp_pimap_get($res, 185 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA1();
Procedural Interface
ipworksopenpgp_pimap_get($res, 186 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA256();
Procedural Interface
ipworksopenpgp_pimap_get($res, 187 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLServerCertUsage();
Procedural Interface
ipworksopenpgp_pimap_get($res, 188 );
Default Value
''
Remarks
This property contains the text description of SSLServerCertUsageFlags.
This value will be of 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 (IPWorksOpenPGP_PIMAP Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLServerCertUsageFlags();
Procedural Interface
ipworksopenpgp_pimap_get($res, 189 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags 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 property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (IPWorksOpenPGP_PIMAP Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLServerCertVersion();
Procedural Interface
ipworksopenpgp_pimap_get($res, 190 );
Default Value
''
Remarks
This property contains 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 (IPWorksOpenPGP_PIMAP Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLServerCertSubject();
Procedural Interface
ipworksopenpgp_pimap_get($res, 191 );
Default Value
''
Remarks
This is 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=support@nsoftware.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 (IPWorksOpenPGP_PIMAP Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLServerCertEncoded();
Procedural Interface
ipworksopenpgp_pimap_get($res, 192 );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
SSLStartMode Property (IPWorksOpenPGP_PIMAP Class)
This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.
Object Oriented Interface
public function getSSLStartMode(); public function setSSLStartMode($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 193 ); ipworksopenpgp_pimap_set($res, 193, $value );
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 class 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 class 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
Integer
StartByte Property (IPWorksOpenPGP_PIMAP Class)
This property includes the byte index of the position where the transfer should start.
Object Oriented Interface
public function getStartByte(); public function setStartByte($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 194 ); ipworksopenpgp_pimap_set($res, 194, $value );
Default Value
0
Remarks
StartByte and EndByte are used together with the RetrieveMessagePart method to specify the portion of the message to be retrieved from the server.
When StartByte 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.
This property is not available at design time.
Data Type
Long64
Timeout Property (IPWorksOpenPGP_PIMAP Class)
This property includes the timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 195 ); ipworksopenpgp_pimap_set($res, 195, $value );
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 class will wait for the operation to complete before returning control.
The class will use DoEvents 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 class 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
Integer
UIDMode Property (IPWorksOpenPGP_PIMAP Class)
If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers.
Object Oriented Interface
public function getUIDMode(); public function setUIDMode($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 196 ); ipworksopenpgp_pimap_set($res, 196, $value );
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.
This property is not available at design time.
Data Type
Boolean
UIDValidity Property (IPWorksOpenPGP_PIMAP Class)
This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command.
Object Oriented Interface
public function getUIDValidity();
Procedural Interface
ipworksopenpgp_pimap_get($res, 197 );
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 and not available at design time.
Data Type
String
User Property (IPWorksOpenPGP_PIMAP Class)
This property includes the username used to authenticate to the MailServer .
Object Oriented Interface
public function getUser(); public function setUser($value);
Procedural Interface
ipworksopenpgp_pimap_get($res, 198 ); ipworksopenpgp_pimap_set($res, 198, $value );
Default Value
''
Remarks
This property contains the username used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.
Data Type
String
AddMessageFlags Method (IPWorksOpenPGP_PIMAP Class)
This method adds the specified flags to the messages specified by MessageSet .
Object Oriented Interface
public function doAddMessageFlags($flags);
Procedural Interface
ipworksopenpgp_pimap_do_addmessageflags($res, $flags);
Remarks
This method adds the specified flags to the messages specified by the MessageSet 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). |
\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). |
IMAPControl.MessageSet = "1"
IMAPControl.AddMessageFlags("\Deleted")
AppendToMailbox Method (IPWorksOpenPGP_PIMAP Class)
This method appends the message in MessageText to the mailbox specified by Mailbox .
Object Oriented Interface
public function doAppendToMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_appendtomailbox($res);
Remarks
This method appends the RFC 822-encoded message in MessageText to the mailbox specified by Mailbox. If the MessageFlags property is not an empty string, its contents are supplied with the APPEND command sent to the server.
Example. Append Message to Mailbox:
IMAPControl.MessageText = MessageHeaders + CRLF + CRLF + MessageBody + CRLF
IMAPControl.Mailbox = "INBOX"
IMAPControl.MessageFlags = "\Deleted"
IMAPControl.AppendToMailbox()
CheckMailbox Method (IPWorksOpenPGP_PIMAP Class)
This method sends a CHECK command to the server.
Object Oriented Interface
public function doCheckMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_checkmailbox($res);
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 (IPWorksOpenPGP_PIMAP Class)
This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox.
Object Oriented Interface
public function doCloseMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_closemailbox($res);
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 (IPWorksOpenPGP_PIMAP Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworksopenpgp_pimap_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (IPWorksOpenPGP_PIMAP Class)
This method connects to an IMAP server.
Object Oriented Interface
public function doConnect();
Procedural Interface
ipworksopenpgp_pimap_do_connect($res);
Remarks
This method connects to the IMAP server specified by MailServer and authenticates it using the username and password supplied in the User and Password properties.
Example. Connect IMAP Server:
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 (IPWorksOpenPGP_PIMAP Class)
This method copies the messages specified by MessageSet to the mailbox specified by Mailbox .
Object Oriented Interface
public function doCopyToMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_copytomailbox($res);
Remarks
This method copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.
CreateMailbox Method (IPWorksOpenPGP_PIMAP Class)
This method creates a new mailbox specified by Mailbox .
Object Oriented Interface
public function doCreateMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_createmailbox($res);
Remarks
This method creates a new mailbox. The mailbox name is specified by the Mailbox property.
Decrypt Method (IPWorksOpenPGP_PIMAP Class)
Decrypts the message.
Object Oriented Interface
public function doDecrypt();
Procedural Interface
ipworksopenpgp_pimap_do_decrypt($res);
Remarks
This method decrypts the specified message.
The message will be decrypted using the keys specified in Keys. Before decryption begins the class will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.
DecryptAndVerifySignature Method (IPWorksOpenPGP_PIMAP Class)
Decrypts and verifies the signature of the message.
Object Oriented Interface
public function doDecryptAndVerifySignature();
Procedural Interface
ipworksopenpgp_pimap_do_decryptandverifysignature($res);
Remarks
This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.
This method may be used when the data is signed, encrypted, or signed and encrypted. For instance, if the data is encrypted but not signed you may still use this method and the class will perform the decryption without error.
The message will be decrypted using the keys specified in Keys. Before decryption begins the class will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.
The message will be verified using the keys specified in SignerKeys. Before verification begins the class will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.
By default, if the signature is not valid the class fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.
NOTE: This method does not attempt to check the validity of the signing key itself.
DeleteFromMailbox Method (IPWorksOpenPGP_PIMAP Class)
The method marks the messages specified by MessageSet as deleted.
Object Oriented Interface
public function doDeleteFromMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_deletefrommailbox($res);
Remarks
This method marks the messages specified by MessageSet as deleted. Calling this method is equivalent to calling AddMessageFlags with "\Deleted" as the Flags parameter.
DeleteMailbox Method (IPWorksOpenPGP_PIMAP Class)
This method deletes a mailbox specified by Mailbox .
Object Oriented Interface
public function doDeleteMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_deletemailbox($res);
Remarks
This method deletes a mailbox. The mailbox name is specified by the Mailbox property.
DeleteMailboxACL Method (IPWorksOpenPGP_PIMAP Class)
This method deletes mailbox access control rights for a specific user.
Object Oriented Interface
public function doDeleteMailboxACL($user);
Procedural Interface
ipworksopenpgp_pimap_do_deletemailboxacl($res, $user);
Remarks
This message asks the server to remove all rights associated with User from the mailbox specified in the Mailbox property. Refer to SetMailboxACL and GetMailboxACL for more information on mailbox access rights.
Disconnect Method (IPWorksOpenPGP_PIMAP Class)
This method disconnects from an IMAP server.
Object Oriented Interface
public function doDisconnect();
Procedural Interface
ipworksopenpgp_pimap_do_disconnect($res);
Remarks
This method logs out and disconnects from the IMAP server.
DoEvents Method (IPWorksOpenPGP_PIMAP Class)
This method processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
ipworksopenpgp_pimap_do_doevents($res);
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
ExamineMailbox Method (IPWorksOpenPGP_PIMAP Class)
This method selects a mailbox in read-only mode.
Object Oriented Interface
public function doExamineMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_examinemailbox($res);
Remarks
This method asks the server to select the mailbox specified in the Mailbox property in read-only mode.
Example 1. Open a Mailbox in Read/Write Mode:
IMAPControl.Mailbox = "INBOX"
IMAPControl.SelectMailbox
Example 2. Open a Mailbox in Read-Only Mode:
IMAPControl.Mailbox = "INBOX.Folder"
IMAPControl.ExamineMailbox
ExpungeMailbox Method (IPWorksOpenPGP_PIMAP Class)
This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox.
Object Oriented Interface
public function doExpungeMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_expungemailbox($res);
Remarks
This method permanently removes all messages that have a 'Deleted' flag from the current (selected) mailbox. Example. Set "Deleted" Flag and Expunge:
IMAPControl.MessageSet = "1"
IMAPControl.AddMessageFlags("\Deleted")
IMAPControl.ExpungeMailbox()
GetMailboxACL Method (IPWorksOpenPGP_PIMAP Class)
This method retrieves mailbox access control rights.
Object Oriented Interface
public function doGetMailboxACL();
Procedural Interface
ipworksopenpgp_pimap_do_getmailboxacl($res);
Remarks
This method retrieves the mailbox access control rights, which are provided through one or more MailboxACL 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 (IPWorksOpenPGP_PIMAP Class)
This method interrupts the current method.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
ipworksopenpgp_pimap_do_interrupt($res);
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListMailboxes Method (IPWorksOpenPGP_PIMAP Class)
This method lists all of the mailboxes matching all criteria in the Mailbox property.
Object Oriented Interface
public function doListMailboxes();
Procedural Interface
ipworksopenpgp_pimap_do_listmailboxes($res);
Remarks
This method lists all of the mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through the MailboxList event.
Example 1. List All Mailboxes:
IMAPControl.Mailbox = "*"
IMAPControl.ListMailboxes()
Example 2. List All Mailboxes Inside INBOX:
IMAPControl.Mailbox = "INBOX.*"
IMAPControl.ListMailboxes()
ListSubscribedMailboxes Method (IPWorksOpenPGP_PIMAP Class)
This method lists all subscribed mailboxes matching all criteria in the Mailbox property.
Object Oriented Interface
public function doListSubscribedMailboxes();
Procedural Interface
ipworksopenpgp_pimap_do_listsubscribedmailboxes($res);
Remarks
This method lists all subscribed mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through MailboxList event.
Example 1. List All Subscribed Mailboxes:
IMAPControl.Mailbox = "*"
IMAPControl.ListSubscribedMailboxes()
Example 2. List All Subscribed Mailboxes Inside INBOX:
IMAPControl.Mailbox = "INBOX.*"
IMAPControl.ListSubscribedMailboxes()
LocalizeDate Method (IPWorksOpenPGP_PIMAP Class)
This method converts a valid RFC 822 message date to a local date and time.
Object Oriented Interface
public function doLocalizeDate($datetime);
Procedural Interface
ipworksopenpgp_pimap_do_localizedate($res, $datetime);
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 (IPWorksOpenPGP_PIMAP Class)
This method moves the messages specified by MessageSet to the mailbox specified by Mailbox .
Object Oriented Interface
public function doMoveToMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_movetomailbox($res);
Remarks
This method moves the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.
Noop Method (IPWorksOpenPGP_PIMAP Class)
This method sends a NOOP command to the server.
Object Oriented Interface
public function doNoop();
Procedural Interface
ipworksopenpgp_pimap_do_noop($res);
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 (IPWorksOpenPGP_PIMAP Class)
This method changes the name of Mailbox to NewName .
Object Oriented Interface
public function doRenameMailbox($newname);
Procedural Interface
ipworksopenpgp_pimap_do_renamemailbox($res, $newname);
Remarks
This method allows a mailbox to be renamed. The mailbox is specified by the Mailbox property, and the new name is specified by the NewName parameter.
ResetMessageFlags Method (IPWorksOpenPGP_PIMAP Class)
This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .
Object Oriented Interface
public function doResetMessageFlags();
Procedural Interface
ipworksopenpgp_pimap_do_resetmessageflags($res);
Remarks
This method replaces the flags of the messages specified by the MessageSet property with the flags specified by the MessageFlags 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). |
\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 (IPWorksOpenPGP_PIMAP Class)
This method retrieves the message headers of the messages specified by the MessageSet property.
Object Oriented Interface
public function doRetrieveMessageHeaders();
Procedural Interface
ipworksopenpgp_pimap_do_retrievemessageheaders($res);
Remarks
This method retrieves RFC 822 headers of the messages specified by MessageSet and stores them in the MessageHeaders property.
RetrieveMessageInfo Method (IPWorksOpenPGP_PIMAP Class)
This method retrieves information about messages specified by the MessageSet property.
Object Oriented Interface
public function doRetrieveMessageInfo();
Procedural Interface
ipworksopenpgp_pimap_do_retrievemessageinfo($res);
Remarks
This method retrieves information for the messages specified by the MessageSet property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a MessageInfo event is fired, and message envelope information is stored in properties, such as the following: MessageSubject, MessageFrom, and MessageRecipients. If the message is a multipart message, one or more MessagePart events will be fired before the MessageInfo event (one for each message part).
RetrieveMessagePart Method (IPWorksOpenPGP_PIMAP Class)
This method retrieves the message part specified by PartID.
Object Oriented Interface
public function doRetrieveMessagePart($partid);
Procedural Interface
ipworksopenpgp_pimap_do_retrievemessagepart($res, $partid);
Remarks
This method retrieves the contents of the message part specified by the PartId property of the messages specified by the MessageSet property. If the LocalFile property contains a file name, the message part is stored in LocalFile. If the LocalFile property is set to an empty string, then the message part is stored in the MessageText property. Additionally, the Transfer 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 events. This method retrieves the RFC 822-encoded text of the messages specified by MessageSet.
RetrieveMessagePartHeaders Method (IPWorksOpenPGP_PIMAP Class)
This method retrieves the headers of message part specified by PartID.
Object Oriented Interface
public function doRetrieveMessagePartHeaders($partid);
Procedural Interface
ipworksopenpgp_pimap_do_retrievemessagepartheaders($res, $partid);
Remarks
This method retrieves RFC 822 headers of the message part specified by PartID and stores them in the MessageHeaders property.
RetrieveMessageText Method (IPWorksOpenPGP_PIMAP Class)
This method retrieves the message text of the messages specified by the MessageSet property.
Object Oriented Interface
public function doRetrieveMessageText();
Procedural Interface
ipworksopenpgp_pimap_do_retrievemessagetext($res);
Remarks
This method retrieves the RFC 822-encoded text of the messages specified by MessageSet. If the LocalFile property contains a file name, the text is stored in LocalFile. If the LocalFile property is set to an empty string, then the text is stored in the MessageText property. Additionally, the Transfer event will also provide the text and denote the progress of the retrieval.
SearchMailbox Method (IPWorksOpenPGP_PIMAP Class)
This method searches the selected mailbox for specified text.
Object Oriented Interface
public function doSearchMailbox($searchcriteria);
Procedural Interface
ipworksopenpgp_pimap_do_searchmailbox($res, $searchcriteria);
Remarks
This method searches the selected mailbox using the criteria specified in the SearchCriteria parameter. For every message matching the criteria, the RetrieveMessageInfo method is called and a MessageInfo 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:
<message set> | 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 <string> | Messages that contain the specified string in the envelope structure's BCC field. |
BEFORE <date> | Messages whose internal date is earlier than the specified date. |
BODY <string> | Messages that contain the specified string in the body of the message. |
CC <string> | 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 <string> | Messages that contain the specified string in the envelope structure's FROM field. |
HEADER <field-name> <string> | 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 <flag> | Messages with the specified keyword set. |
LARGER <n> | 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 <search-key> | 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 <date> | Messages whose internal date is within the specified date. |
OR <search-key1> <search-key2> | Messages that match either search key. |
RECENT | Messages that have the \Recent flag set. |
SEEN | Messages that have the \Seen flag set. |
SENTBEFORE <date> | Messages whose [RFC-822] Date: header is earlier than the specified date. |
SENTON <date> | Messages whose [RFC-822] Date: header is within the specified date. |
SENTSINCE <date> | Messages whose [RFC-822] Date: header is within or later than the specified date. |
SINCE <date> | Messages whose internal date is within or later than the specified date. |
SMALLER <n> | Messages with an RFC822.SIZE smaller than the specified number of octets. |
SUBJECT <string> | Messages that contain the specified string in the envelope structure's SUBJECT field. |
TEXT <string> | Messages that contain the specified string in the header or body of the message. |
TO <string> | Messages that contain the specified string in the envelope structure's TO field. |
UID <message set> | 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 <flag> | Messages that do not have the specified keyword set. |
UNSEEN | Messages that do not have the \Seen flag set. |
SelectMailbox Method (IPWorksOpenPGP_PIMAP Class)
This method selects a mailbox.
Object Oriented Interface
public function doSelectMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_selectmailbox($res);
Remarks
This method asks the server to select the mailbox specified in the Mailbox property. The mailbox is selected in read/write mode (if the server permits).
Example 1. Open a Mailbox in Read/Write Mode:
IMAPControl.Mailbox = "INBOX"
IMAPControl.SelectMailbox
Example 2. Open a Mailbox in Read-Only Mode:
IMAPControl.Mailbox = "INBOX.Folder"
IMAPControl.ExamineMailbox
SendCommand Method (IPWorksOpenPGP_PIMAP Class)
This method sends the exact command directly to the server.
Object Oriented Interface
public function doSendCommand($command);
Procedural Interface
ipworksopenpgp_pimap_do_sendcommand($res, $command);
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 property or monitor the PITrail event to obtain the server's response.
SetMailboxACL Method (IPWorksOpenPGP_PIMAP Class)
This method sets mailbox access control rights for a specific user.
Object Oriented Interface
public function doSetMailboxACL($user, $rights);
Procedural Interface
ipworksopenpgp_pimap_do_setmailboxacl($res, $user, $rights);
Remarks
This method changes the access control list for the mailbox specified in the Mailbox 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 (IPWorksOpenPGP_PIMAP Class)
This method begins idling.
Object Oriented Interface
public function doStartIdle();
Procedural Interface
ipworksopenpgp_pimap_do_startidle($res);
Remarks
This method sends the IDLE command to the server and begins idling. As responses are received from the server the IdleInfo event fires. To stop idling, call StopIdle.
If the class is being used in a formless application (such as a console application) be sure to call DoEvents in a loop after calling this method to ensure that incoming events are processed.
StopIdle Method (IPWorksOpenPGP_PIMAP Class)
This method stops idling.
Object Oriented Interface
public function doStopIdle();
Procedural Interface
ipworksopenpgp_pimap_do_stopidle($res);
Remarks
This method stops idling if it was previously started via StartIdle. If the class is not idling, this method does nothing.
SubscribeMailbox Method (IPWorksOpenPGP_PIMAP Class)
This method subscribes to the mailbox specified by Mailbox .
Object Oriented Interface
public function doSubscribeMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_subscribemailbox($res);
Remarks
This method subscribes to the mailbox specified by the Mailbox property.
UnsetMessageFlags Method (IPWorksOpenPGP_PIMAP Class)
This method removes the flags specified by MessageFlags from the messages specified by MessageSet .
Object Oriented Interface
public function doUnsetMessageFlags();
Procedural Interface
ipworksopenpgp_pimap_do_unsetmessageflags($res);
Remarks
This method removes the flags specified by the MessageFlags property from the messages specified by the MessageSet 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). |
\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 (IPWorksOpenPGP_PIMAP Class)
This method unsubscribes from the mailbox specified by Mailbox .
Object Oriented Interface
public function doUnsubscribeMailbox();
Procedural Interface
ipworksopenpgp_pimap_do_unsubscribemailbox($res);
Remarks
This method unsubscribes from the mailbox specified by the Mailbox property.
VerifySignature Method (IPWorksOpenPGP_PIMAP Class)
Verifies the signature of the current message.
Object Oriented Interface
public function doVerifySignature();
Procedural Interface
ipworksopenpgp_pimap_do_verifysignature($res);
Remarks
This method verifies the signature of the message.
The message will be verified using the keys specified in SignerKeys. Before verification begins the class will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.
By default, if the signature is not valid the class fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.
ConnectionStatus Event (IPWorksOpenPGP_PIMAP Class)
This event is fired to indicate changes in the connection state.
Object Oriented Interface
public function fireConnectionStatus($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 1, array($this, 'fireConnectionStatus'));
Parameter List
'connectionevent'
'statuscode'
'description'
Remarks
The ConnectionStatus 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. |
EndTransfer Event (IPWorksOpenPGP_PIMAP Class)
This event is fired when the message or the part data finishes transferring.
Object Oriented Interface
public function fireEndTransfer($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 2, array($this, 'fireEndTransfer'));
Parameter List
'direction'
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 (IPWorksOpenPGP_PIMAP Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 3, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class 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 section.
Header Event (IPWorksOpenPGP_PIMAP Class)
This event is fired every time a header line comes in.
Object Oriented Interface
public function fireHeader($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 4, array($this, 'fireHeader'));
Parameter List
'field'
'value'
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 (IPWorksOpenPGP_PIMAP Class)
This event fires whenever responses from the server are received while idling.
Object Oriented Interface
public function fireIdleInfo($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 5, array($this, 'fireIdleInfo'));
Parameter List
'message'
'cancel'
Remarks
This event fires each time a response is received from the server after calling StartIdle. 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.
The following are possible values returned by the server:
+ idling * 43 EXISTS * 1 RECENT
KeyPassphrase Event (IPWorksOpenPGP_PIMAP Class)
Fired if the passphrase of current key is incorrect or empty.
Object Oriented Interface
public function fireKeyPassphrase($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 6, array($this, 'fireKeyPassphrase'));
Parameter List
'userid'
'keyid'
'fingerprint'
'passphrase'
Remarks
This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the KeyPassphrase property before attempting the operation.
The passphrase is required when using the following methods in KeyMgr:
- AddUserId
- SignUserId
- ChangeExpirationDate
- ChangePassphrase
When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:
- Decrypt
- Sign
- SignAndEncrypt
UserId holds the user Id of the key the passphrase is required for.
The UserId format is:
FirstName LastName (Comment) <Email>Not all values are required when selecting or generating a key, but at least FirstName or Email are required.
Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.
KeyId is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
Fingerprint holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
MailboxACL Event (IPWorksOpenPGP_PIMAP Class)
This event fires for each set of access control rights returned by the server.
Object Oriented Interface
public function fireMailboxACL($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 7, array($this, 'fireMailboxACL'));
Parameter List
'mailbox'
'user'
'rights'
Remarks
The event fires for each set of access control rights returned by the server after a call to GetMailboxACL. 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 (IPWorksOpenPGP_PIMAP Class)
This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.
Object Oriented Interface
public function fireMailboxList($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 8, array($this, 'fireMailboxList'));
Parameter List
'mailbox'
'separator'
'flags'
Remarks
This method is fired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. The Separator parameter contains the character that separates the different parts in the mailbox path hierarchy.
MessageInfo Event (IPWorksOpenPGP_PIMAP Class)
This event is fired with information for the messages retrieved by the server.
Object Oriented Interface
public function fireMessageInfo($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 9, array($this, 'fireMessageInfo'));
Parameter List
'messageid'
'subject'
'messagedate'
'from'
'flags'
'size'
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, MessageContentEncoding, MessageRecipients, MessageDeliveryTime, MessageFlags, MessageHeaders, MessageInReplyTo, MessageNetId, MessageReplyTo, MessageSender, MessageSize, MessageSubject, MessageText, etc.
MessagePart Event (IPWorksOpenPGP_PIMAP Class)
This event is fired for each message part when RetrieveMessageInfo is called.
Object Oriented Interface
public function fireMessagePart($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 10, array($this, 'fireMessagePart'));
Parameter List
'partid'
'size'
'contenttype'
'filename'
'contentencoding'
'parameters'
'multipartmode'
'contentid'
'contentdisposition'
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 (IPWorksOpenPGP_PIMAP Class)
This event traces the commands sent to the mail server, and the respective replies.
Object Oriented Interface
public function firePITrail($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 11, array($this, 'firePITrail'));
Parameter List
'direction'
'message'
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 class code). |
Progress Event (IPWorksOpenPGP_PIMAP Class)
Fired as progress is made.
Object Oriented Interface
public function fireProgress($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 12, array($this, 'fireProgress'));
Parameter List
'bytesprocessed'
'percentprocessed'
Remarks
This event is fired automatically as data is processed by the class.
The PercentProcessed parameter indicates the current status of the operation.
The BytesProcessed parameter holds the total number of bytes processed so far.
RecipientInfo Event (IPWorksOpenPGP_PIMAP Class)
Fired for each recipient key of the encrypted message.
Object Oriented Interface
public function fireRecipientInfo($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 13, array($this, 'fireRecipientInfo'));
Parameter List
'keyid'
'fingerprint'
'publickeyalgorithm'
Remarks
This event fires when the Decrypt or DecryptAndVerifySignature method is called.
KeyId is the hex-encoded 4- or 8-byte Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
The KeyId and Fingerprint parameters can be used to identify the correct key to specify in the Key* properties. The Key* properties can be set from within this event as this event fires directly before the decryption process begins.
It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.
PublicKeyAlgorithm is the algorithm of the public key used to encrypt the message. Possible values are:
- RSA
- DSA
- ECDSA
- EdDSA
- Ed25519
- Ed448
- RSA-Legacy
- ECDH (Subkeys only)
- X25519 (Subkeys only)
- X448 (Subkeys only)
SignatureInfo Event (IPWorksOpenPGP_PIMAP Class)
Fired during verification of the signed message.
Object Oriented Interface
public function fireSignatureInfo($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 14, array($this, 'fireSignatureInfo'));
Parameter List
'keyid'
'fingerprint'
'signingalgorithm'
'publickeyalgorithm'
Remarks
This event fires when the VerifySignature or DecryptAndVerifySignature method is called. It provides information about the signature of the message.
KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
The KeyId and Fingerprint parameters can be used to identify the correct key to specify in the SignerKey* properties. The SignerKey* properties can be set from within this event as this event fires directly before the verification process begins.
It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.
SigningAlgorithm describes the hash algorithm used when the message was originally signed. This value is applicable only to the message signature, not the key used to sign the message. Possible values are:
- SHA1
- MD5
- SHA256
- SHA384
- SHA512
- SHA224
- RIPEMD160
- SHA3-256
- SHA3-512
PublicKeyAlgorithm is the algorithm of the public key used to sign the message. Possible values are:
- RSA
- DSA
- ECDSA
- EdDSA
- Ed25519
- Ed448
- RSA-Legacy
- ECDH (Subkeys only)
- X25519 (Subkeys only)
- X448 (Subkeys only)
SSLServerAuthentication Event (IPWorksOpenPGP_PIMAP Class)
Fired after the server presents its certificate to the client.
Object Oriented Interface
public function fireSSLServerAuthentication($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 15, array($this, 'fireSSLServerAuthentication'));
Parameter List
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
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 (IPWorksOpenPGP_PIMAP Class)
Fired when secure connection progress messages are available.
Object Oriented Interface
public function fireSSLStatus($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 16, array($this, 'fireSSLStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (IPWorksOpenPGP_PIMAP Class)
This event is fired when the message body or the part data start transferring.
Object Oriented Interface
public function fireStartTransfer($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 17, array($this, 'fireStartTransfer'));
Parameter List
'direction'
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 and EndTransfer events.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Status Event (IPWorksOpenPGP_PIMAP Class)
Shows the progress of the operation.
Object Oriented Interface
public function fireStatus($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 18, array($this, 'fireStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.
The level of detail is controlled by the LogLevel setting.
Transfer Event (IPWorksOpenPGP_PIMAP Class)
This event is fired while the message is transferred from the MailServer .
Object Oriented Interface
public function fireTransfer($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 19, array($this, 'fireTransfer'));
Parameter List
'direction'
'bytestransferred'
'percentdone'
'text'
Remarks
The Transfer event is fired for every incoming line when receiving a message or part data from the MailServer
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 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 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.
VerificationStatus Event (IPWorksOpenPGP_PIMAP Class)
Fired after verification of the signed message.
Object Oriented Interface
public function fireVerificationStatus($param);
Procedural Interface
ipworksopenpgp_pimap_register_callback($res, 20, array($this, 'fireVerificationStatus'));
Parameter List
'keyid'
'fingerprint'
'status'
Remarks
This event fires when VerifySignature or DecryptAndVerifySignature is called. It provides information about the result.
KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
Status holds the result of the operation. Possible values are:
0 | Verification succeeded |
1 | Verification failed |
2 | The required key could not be found |
3 | Verification succeeded but the key is expired. |
Config Settings (PIMAP Class)
The class 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 class, access to these internal properties is provided through the Config method.PIMAP Config Settings
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data is logged. |
3 (Debug) | Debug data is logged. |
This config is True by default, and must be true when verifying an OpenPGP v6 cleartext signature. When enabled, the cleartext portion will be cached in memory until the signature is fully processed.
Note: If the signature is known to be an OpenPGP v4 cleartext signature beforehand (i.e., signed with a v4 key), this config may be set to False. However, if this config is disabled, the class will be unable to verify OpenPGP v6 cleartext signatures. In this case, the class will throw an exception when calling VerifySignature or DecryptAndVerifySignature.
This setting will be populated after calling Decrypt, VerifySignature, or DecryptAndVerifySignature.
SIMAP Config Settings
IMAP Config Settings
The default value for this setting is False.
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.
Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q
Note: When using amXOAUTH2, User must be specified, but Password is not required.
This configuration setting specifies whether the class will use the IMAP4 Id extension defined in RFC 2971 and send the Id command to the server. When set to true, the class 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.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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 classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if 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 is a positive value, the system will attempt to send pending data until the specified 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 class 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.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost 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).
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.
If an EOL string is found in the input stream before 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 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 is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
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.
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.
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".
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.
If set to True, the class 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 class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----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-----
When set to 0 (default), the CRL check will not be performed by the class. 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.
When set to 0 (default), the class 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.
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 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If 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 is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider 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
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 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), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
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 class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider 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 and other similar SSL configuration settings are not supported.
- If 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 class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class 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 class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
When specified the class 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 class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
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.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider 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)
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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
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)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class 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
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 |
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 |
- 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class 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 section.
Trappable Errors (PIMAP Class)
IMAP Errors
118 | Firewall error. Error message contains detailed description. |
311 | Protocol error. |
312 | Busy executing current method. |
314 | A Mailbox must be selected before calling this method. |
315 | Invalid argument. Please specify a valid MessageSet. |
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 at this time. A connection is in progress. |
112 | You cannot change 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 class 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. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
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). |
OpenPGP Errors
101 | Cannot decode ASCII Armor data. |
102 | Unknown ASCII Armor data type. |
103 | Checksum failed. |
104 | Unknown ASCII Armor header. |
105 | Cannot decode PGP packet. |
106 | Cannot encode PGP packet. |
107 | Unknown PGP packet tag. |
108 | Unsupported version. |
109 | Unsupported algorithm. |
110 | Unknown subpacket. |
111 | Internal error. |
112 | Feature not supported. |
113 | Secret data was not encrypted. |
114 | Cannot find the key. |
115 | Error reading file. |
116 | Error writing file. |
117 | Error reading key. |
118 | Error writing key. |
119 | Cannot verify signature. |
120 | Cannot create signature. |
121 | Invalid UserId. |
122 | Invalid passphrase. |
123 | Data encryption failed. |
124 | Error creating key. |
125 | Unsupported symmetric algorithm. |
126 | Unsupported hash. |
127 | Unsupported compression algorithm. |
128 | Invalid key usage. |
129 | Component is busy. |
130 | Error decrypting data. |
131 | Data is not compressed. |
132 | Error decompressing data. |
133 | Error compressing data. |
134 | Unsupported signature. |
135 | Failed to overwrite file. |
141 | No input. |
142 | Signing was required, but the message was not signed. |
143 | Encryption was required, but the message was not encrypted. |
146 | No data integrity packet was found (MDC), but one was required. |
200 | Out of memory. |