IPWorks OpenPGP 2020 Android Edition

Questions / Feedback?

PHTMLMailer Component

Properties   Methods   Events   Configuration Settings   Errors  

The PHTMLMailer component is used to send encrypted and/or signed HTML-formatted emails with or without any attachments using OpenPGP.

Syntax

IPWorksOpenPGP.Phtmlmailer

Remarks

The PHTMLMailer component offers an easy-to-use interface that supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. 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.

Encrypt

To encrypt a message add the recipient's public key to RecipientKeys. For instance:

phtmlmailer.RecipientKeys.Add(new Key("c:\\my_keyring_dir", "recipient@nsoftware.com"));
The specified public key will be used to encrypt the message when Encrypt is called.

Sign

To sign a message add the sender's private key to Keys. For instance:

phtmlmailer.Keys.Add(new Key("c:\\my_keyring_dir", "sender@nsoftware.com"));
phtmlmailer.Keys[0].Passphrase = "password";
The specified private key will be used to sign the message when Sign is called.

Sign and Encrypt

To both sign and encrypt a message call SignAndEncrypt. The message will be signed with the private keys specified in Keys and encrypted with the public keys specified in RecipientKeys.

Add Attachments

To add attachments simply call AddAttachment. The ProcessAttachments setting specifies whether attachments are also encrypted and signed.

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 component with short descriptions. Click on the links for further details.

AttachmentsThe paths of files to attach to the message.
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 which to send a delivery notification.
EncryptingAlgorithmThe encryption algorithm used when encrypting.
FirewallA set of properties related to firewall access.
FromThe email address of the sender (required).
HTMLFileThe path to a local HTML file.
IdleThe current status of the component.
ImagesThe embedded images in the HTML message.
ImportanceImportance of the mail message (optional).
KeysA collection of keys used for cryptographic operations.
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).
MessageDateDate of the mail message (optional).
MessageHTMLThe HTML version of the message.
MessageIdThe Message Identifier for the message.
MessageRecipientsThe collection of recipients of the message.
MessageTextThe plain text version of the message.
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
ParseHTMLControls the behavior of the MessageHTML property.
PasswordA password for logon to the MailServer .
PriorityPriority of the mail message (optional).
ReadReceiptToEmail address to send a read receipt to.
RecipientKeysThe collection of keys belonging to the recipient of the message.
ReplyToA mail address to which to reply (optional).
SendToA comma separated list of addresses for destinations (required).
SensitivitySensitivity of the mail message (optional).
SigningAlgorithmThe signature hash algorithm used when signing.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLEnabledWhether TLS/SSL is enabled.
SSLServerCertThe server certificate for the last established connection.
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 component with short descriptions. Click on the links for further details.

addAttachmentAdds FileName as an attachment.
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.
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 and MIME encoded attachment.
setMessageHTMLStreamSets the stream from which the component will read the HTML version of the message.
signSigns the message.
signAndEncryptSigns and encrypts the current message.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ConnectionStatusFired to indicate changes in connection state.
EndTransferFired when the message text completes transferring.
ErrorInformation about errors during data delivery.
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 component with short descriptions. Click on the links for further details.

ClearSignatureSpecifies whether or not to create a cleartext signature.
CommentThe OpenPGP message comment.
CompressionLevelThe level of compression used.
EnsureValidDSASignatureHashAlgorithmWhether or not to select a suitable signature hash algorithm automatically.
LogLevelSpecifies the level of detail that is logged.
ProcessAttachmentsWhether or not to process attachments.
SymmetricPassphraseThe password used for symmetric encryption or decryption.
VersionHeaderThe Version header value in the ASCII armored OpenPGP message.
AttachmentEncoding[index]Content-Transfer-Encoding for attached file (at index).
AttachmentType[index]Content-type for attached file (at index).
CharsetWhen set, the charset Content-Type attribute will be added using the specified value.
MessageTextEncodingWhen set, the MessageHTML and MessageText values will be encoded using the specified encoding.
OverrideFilenameIf set to true, the AttachmentName property value will be used to set the MIME part Filename attribute.
TempFilePathIf set, the temporary files created during message creation will be put in the path specified.
UseTempFileDetermines if temporary files are used during message creation.
UseTempFileIf set, the component uses temporary files when generating messages.
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.
FoldHeadersTells the component whether to fold the headers.
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.
StopOnBccErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the BCCs.
StopOnCcErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the CCs.
StopOnToErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the TOs.
TransferTextThe current portion of the message being sent.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
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).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
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.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
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.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLContextProtocolThe protocol used when getting an SSLContext instance.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithmThe algorithm to be used to create a TrustManager through TrustManagerFactory.
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.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
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.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the component are daemon threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Android Edition - Version 20.0 [Build 8161]