IP*Works! OpenPGP 2016 C++ Edition
IP*Works! OpenPGP 2016 C++ Edition
Questions / Feedback?

PSMTP Class

Properties   Methods   Events   Configuration Settings   Errors  

The PSMTP component is used to send encrypted and/or signed emails with or without attachments using OpenPGP.

Syntax

PSMTP

Remarks

You can send an OpenPGP signed and encrypted message using the PSMTP class by calling the Encrypt, Sign, and SignAndEncrypt methods. 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.

Construct the Message

To begin specify common email properties such as SendTo, Cc, BCc, Subject, and MessageText. Connection information is specified by setting MailServer, and MailPort.

Sign

To sign a message specify a recipient key using the Key* properties. For instance:

PSMTP1.KeyCount = 1
PSMTP1.KeyKeyring(0) = "c:\my_keyring_dir"
PSMTP1.KeyUserId(0) = "sender@nsoftware.com"
PSMTP1.KeyPassphrase(0) = "password"
The specified private key will be used to sign the message when Sign is called.

Encrypt

To both sign and encrypt a message call SignAndEncrypt.

To encrypt a message specify a recipient key using the RecipientKey* properties. For instance:

PSMTP1.RecipientKeyCount = 1
PSMTP1.RecipientKeyKeyring(0) = "c:\my_keyring_dir"
PSMTP1.RecipientKeyUserId(0) = "recipient@nsoftware.com"
The specified public key will be used to encrypt the message when Encrypt is called.

Sign and Encrypt

You can call the SignAndEncrypt method to sign and encrypt messages in one step. Set the public key of the recipient to be used for encryption in the and the private key to be used to sign the message in the Key* properties .

Send

Once all the appropriate properties have been set, call the Send method and the message will be sent to its intended recipient(s).

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AllowExtensionsA switch allowing the component to use ESMTP features (SMTP extensions).
AuthMechanismUsed when connecting to the mail server.
BCcA comma separated list of addresses for blind carbon copies (optional).
CcA comma separated list of addresses for carbon copies (optional).
CommandUsed to send additional commands directly to the server.
CompressionMethodThe compression algorithm used.
ConnectedShows whether the component is connected.
DeliveryNotificationToEmail address to send to which to send a delivery notification.
EncryptingAlgorithmThe encryption algorithm used when encrypting.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FromThe email address of the sender (required).
IdleThe current status of the component.
ImportanceImportance of the mail message (optional).
KeyCountThe number of records in the Key arrays.
KeyEncodedThe key.
KeyKeyringThe location of the keyring.
KeyPassphraseThe passphrase for the key's secret key (if any).
KeyUserIdThe user Id of the key.
LastReplyThe last reply from the server.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPortThe server port for SMTP (default 25).
MailServerThe name or address of a mail server (mail relay).
MessageProvides a way to set the raw message content.
MessageDateDate of the mail message (optional).
MessageHeaderCountThe number of records in the MessageHeader arrays.
MessageHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
MessageHeaderValueThis property contains the header contents.
MessageHeadersStringString representation of RFC822-encoded headers of the message.
MessageIdThe Message Identifier for the message.
MessageRecipientCountThe number of records in the MessageRecipient arrays.
MessageRecipientAddressThis property contains the email address of the recipient.
MessageRecipientNameThis property contains name of the recipient.
MessageRecipientOptionsThis property contains the recipient sending options (used only by SMTP).
MessageRecipientTypeThis property contains the recipient type: To, Cc, or BCc.
MessageTextThe full text of the message to send (without headers).
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
PasswordA password for logon to the MailServer .
PriorityPriority of the mail message (optional).
ReadReceiptToEmail address to send a read receipt to.
RecipientKeyCountThe number of records in the RecipientKey arrays.
RecipientKeyEncodedThe key.
RecipientKeyKeyringThe location of the keyring.
RecipientKeyUserIdThe user Id of the key.
ReplyToA mail address to which to reply (optional).
ReturnPathSets the Return-Path to be used for sending email.
SendToA comma separated list of addresses for destinations (required).
SensitivitySensitivity of the mail message (optional).
SigningAlgorithmThe signature hash algorithm used when signing.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
SSLStartModeDetermines how the component starts the SSL negotiation.
SubjectThe subject of the mail message (optional).
TimeoutA timeout for the component.
UserA user identifier to login as in 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.

ConfigSets or retrieves a configuration setting .
ConnectConnects to the mail relay and sends the SMTP HELO command.
DisconnectDisconnects from the SMTP server.
DoEventsProcesses events from the internal message queue.
EncryptEncrypts the message.
ExpandAsks the MailServer to expand a name or mailing list.
InterruptInterrupt the current method.
ProcessQueueSends the messages which have previously been queued into QueueDir .
QueueQueues the message into QueueDir .
ResetHeadersResets all the message headers to empty.
SendSends the current message.
SendToTerminalAndEmailSends to terminal and email.
SendToTerminalOnlySends to terminal only.
SendToTerminalOrEmailSends to terminal or email.
SignSigns the message.
SignAndEncryptSigns and encrypts the current message.
VerifySends a Verification request to the SMTP server.

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.

ConnectionStatusFired to indicate changes in connection state.
EndTransferFired when the message text completes transferring.
ErrorInformation about errors during data delivery.
ExpandFired for every email address returned by the server when the Expand method is called.
KeyPassphraseFired if the passphrase of current key is incorrect or empty.
PITrailTraces the commands sent to the mail server, and the respective replies.
ProgressFired as progress is made.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when the message text starts transferring.
StatusShows the progress of the operation.
TransferFired while the message text gets transferred to MailServer .

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

CommentThe OpenPGP message comment.
ClearSignatureSpecifies whether or not to create a cleartext signature.
ProcessAttachmentsWhether or not to process attachments.
LogLevelSpecifies the level of detail that is logged.
EnsureValidDSASignatureHashAlgorithmWhether or not to select a suitable signature hash algorithm automatically.
CompressionLevelThe Zip or Zlib compression level.
SymmetricPassphraseThe password used for symmetric encryption or decryption.
VersionHeaderThe Version header value in the ASCII armored OpenPGP message.
AllowEmptyToIf set to True, then the SendTo property is not required.
AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
CharsetWhen set, the message headers will be encoded using the specified Charset.
HelloThe argument for HELO (herald) command to the server (defaults to local host name).
KeepQueueIf set to True, queued files are not deleted after a successful send.
MaxHeaderLengthMaximum length for headers to avoid line folding (default 80).
MessageHeadersStringString representation of RFC822-encoded headers of the message.
MessageIdAlgorithmDetermines the algorithm used to hash the random MessageId.
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
ReturnPathSets the Return-Path to be used for sending email.
SendRSETWhether to send RSET command.
StopOnToErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the TOs.
StopOnCcErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the CCs.
StopOnBccErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the BCCs.
TransferTextThe current portion of the message being sent.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
SelectWaitMillisThe length of time in milliseconds the component will wait when DoEvents is called if there are no events to process.
CodePageThe system code page used for Unicode to Multibyte translations.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2019 /n software inc. - All rights reserved.
IP*Works! OpenPGP 2016 C++ Edition - Version 16.0 [Build 7239]