PPOP Class
Properties Methods Events Configuration Settings Errors
The PPOP component is used retrieve and process OpenPGP encrypted and/or signed messages from Internet Post Office servers (POP).
Syntax
PPOP
Remarks
The PPOP class implements a standard internet post office (POP3) client, as specified in RFC 1725, and supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. You can send an OpenPGP signed and encrypted message using the PSMTP class by calling the Encrypt, Sign, and SignAndEncrypt methods.
Connect to the Server
To connect to a MailServer, first set the appropriate User and Password and then connect by calling the Connect method. Upon successful connection to the MailServer, the number of waiting messages is shown by the MessageCount property. A message is selected by setting the MessageNumber property to a number between 1 and MessageCount (inclusive). Then, the message text and/or headers are received by calling the Retrieve method.
Receive Messages
The message text is received through the Transfer event, whereas the message headers are received through the Header event. Additionally, up to MaxLines from the message body are provided in the MessageText property. The StartTransfer and EndTransfer events are fired at the beginning and end of message transmission. The PITrail event provides a trace of the interaction between the client and server (excluding message transfers).
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:
PPOP1.SignerKeyCount = 1 PPOP1.SignerKeyKeyring(0) = "c:\my_keyring_dir" PPOP1.SignerKeyUserId(0) = "sender@nsoftware.com"The specified public key will be used to verify the signature when calling VerifySignature.
Decrypt
To process an encrypted or signed message first retrieve the message text and headers by calling Retrieve.
To decrypt a message specify the private key to be used for decryption by setting the Key* properties. For instance:
PPOP1.KeyCount = 1 PPOP1.KeyKeyring(0) = "c:\my_keyring_dir" PPOP1.KeyUserId(0) = "recipient@nsoftware.com" PPOP1.KeyPassphrase(0) = "password"The specified private key will be used to decrypt the message when calling Decrypt.
Decrypt and Verify
To decrypt and verify in one step, you can call DecryptAndVerifySignature. Set the public key of the sender in the and the private key to be used for decryption in the Key* properties .
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 | The authentication mechanism to be used when connecting to the mail server. |
| Command | Used to send additional commands directly to the server. |
| Connected | Shows whether the component is connected. |
| FirewallAutoDetect | This property tells the component 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 firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| Idle | The current status of the component. |
| IncludeHeaders | Instructs the component to include the headers in the MessageText and LocalFile. |
| 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 | The last reply from the server. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| MailPort | The server port for POP (default 110). |
| MailServer | The name or address of a mail server (internet post office server). |
| MaxLines | The maximum number of message lines besides headers to retrieve. |
| Message | Provides the raw message content. |
| MessageCc | The value of the CC header of the last retrieved message. |
| MessageCount | The number of messages in the mailbox. |
| MessageDate | The value of the date header of the last retrieved message. |
| MessageFrom | The value of the from header of the last retrieved message. |
| MessageHeaderCount | The number of records in the MessageHeader arrays. |
| MessageHeaderField | This property contains the name of the HTTP header (same case as it is delivered). |
| MessageHeaderValue | This property contains the header contents. |
| MessageHeadersString | A string representation of the full headers of the message as retrieved from the server. |
| MessageNumber | Current (selected) message. |
| MessageRecipientCount | The number of records in the MessageRecipient arrays. |
| MessageRecipientAddress | This property contains the email address of the recipient. |
| MessageRecipientName | This property contains 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 | The value of the Reply-To header of the last retrieved message. |
| MessageSize | The size in bytes of the current message. |
| MessageSubject | The value of the Subject header of the last retrieved message. |
| MessageText | The full text of the message as retrieved from the server. |
| MessageTo | The value of the To header of the last retrieved message. |
| MessageUID | The unique identifier of the message as specified by the server. |
| Password | The password for the mailbox user. |
| 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. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLEnabled | Whether TLS/SSL is enabled. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLStartMode | Determines how the component starts the SSL negotiation. |
| Timeout | A timeout for the component. |
| TotalSize | Cumulative size in bytes of messages in the mailbox (including headers). |
| User | The user identifier for the mailbox. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| Connect | Connects to the mail server and attempts to login. |
| Decrypt | Decrypts the message. |
| DecryptAndVerifySignature | Decrypts and verifies the signature of the message. |
| Delete | Deletes a message specified by MessageNumber on the server. |
| Disconnect | Disconnects from the mail server. |
| DoEvents | Processes events from the internal message queue. |
| Interrupt | Interrupt the current method. |
| ListMessageSizes | Retrieves a list of all message sizes from the server. |
| ListMessageUIDs | Retrieves a list of all message UIDs from the server. |
| LocalizeDate | Converts a valid RFC 822 message date to local date and time. |
| Reset | Resets all changes and revert back to the state when the user first connected. |
| Retrieve | Retrieves a message specified by MessageNumber from the server. |
| RetrieveHeaders | Retrieves headers for a message specified by MessageNumber . |
| 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 | Fired to indicate changes in connection state. |
| EndTransfer | Fired when the message completes transferring. |
| Error | Information about errors during data delivery. |
| Header | Fired for every message header being retrieved. |
| KeyPassphrase | Fired if the passphrase of current key is incorrect or empty. |
| MessageList | Fired for every message listed by ListMessageSizes and/or ListMessageUIDs . |
| PITrail | 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 | Shows the progress of the secure connection. |
| StartTransfer | Fired when the message starts transferring. |
| Status | Shows the progress of the operation. |
| Transfer | Fired while the message gets transferred from MailServer . |
| VerificationStatus | Fired after verification of the signed message. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| Comment | The OpenPGP message comment. |
| ProcessAttachments | Whether or not to process attachments. |
| LogLevel | Specifies the level of detail that is logged. |
| RequireValidSignature | Specifies if an invalid signature is considered an error condition. |
| SymmetricPassphrase | The password used for symmetric encryption or decryption. |
| VersionHeader | The Version header value in the ASCII armored OpenPGP message. |
| AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
| AutoDecodeSubject | Instructs the component to automatically decode message subjects. |
| GetMessageSize | Whether to poll the server for the message size prior to retrieving it. |
| MaxLineLength | The maximum expected length for message lines. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| 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 component 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. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| 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). |
| 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. |
| SelectWaitMillis | The length of time in milliseconds the component will wait when DoEvents is called if there are no events to process. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |