# PSMTP Class

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

## Syntax

**ipworkspgp.psmtp()**

## Remarks

You can send an OpenPGP signed and encrypted message using the PSMTP class by calling the [Encrypt](#psmtpencrypt-method), [Sign](#psmtpsign-method), and [SignAndEncrypt](#psmtpsignandencrypt-method) 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](#psmtpsendto-property), [Cc](#psmtpcc-property), [BCc](#psmtpbcc-property), [Subject](#psmtpsubject-property), and [MessageText](#psmtpmessagetext-property). Connection information is specified by setting [MailServer](#psmtpmailserver-property), and [MailPort](#psmtpmailport-property).

**Sign**

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

```text
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](#psmtpsign-method) is called.

**Encrypt**

To both sign and encrypt a message call [SignAndEncrypt](#psmtpsignandencrypt-method).

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

```text
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](#psmtpencrypt-method) is called.

**Sign and Encrypt**

You can call the [SignAndEncrypt](#psmtpsignandencrypt-method) 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](#psmtpsend-method) 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.*

|  |  |
| --- | --- |
| [AllowExtensions](#psmtpallowextensions-property) | This property is a switch allowing the class to use ESMTP features (Extended SMTP). |
| [AuthMechanism](#psmtpauthmechanism-property) | This property is used when connecting to the mail server. |
| [BCc](#psmtpbcc-property) | This property includes a comma-separated list of addresses for blind carbon copies (optional). |
| [Cc](#psmtpcc-property) | This property includes a comma-separated list of addresses for carbon copies (optional). |
| [CompressionMethod](#psmtpcompressionmethod-property) | The compression algorithm used. |
| [Connected](#psmtpconnected-property) | Whether the class is connected. |
| [DeliveryNotificationTo](#psmtpdeliverynotificationto-property) | This property includes the email address to which to send a delivery notification. |
| [EncryptingAlgorithm](#psmtpencryptingalgorithm-property) | The encryption algorithm used when encrypting. |
| [Firewall](#psmtpfirewall-property) | A set of properties related to firewall access. |
| [From](#psmtpfrom-property) | This property includes the email address of the sender (required). |
| [Idle](#psmtpidle-property) | The current status of the class. |
| [Importance](#psmtpimportance-property) | This property indicates the importance of the mail message (optional). |
| [Keys](#psmtpkeys-property) | A collection of keys used for cryptographic operations. |
| [LastReply](#psmtplastreply-property) | This property indicates the last reply received from the server. |
| [LocalHost](#psmtplocalhost-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [MailPort](#psmtpmailport-property) | This property includes the server port for SMTP (default 25). |
| [MailServer](#psmtpmailserver-property) | This property includes the name or address of a mail server (mail relay). |
| [Message](#psmtpmessage-property) | This property provides a way to set the raw message content. |
| [MessageDate](#psmtpmessagedate-property) | This property includes the date of the mail message (optional). |
| [MessageHeaders](#psmtpmessageheaders-property) | This property includes a collection of RFC 822-encoded headers of the message. |
| [MessageHeadersString](#psmtpmessageheadersstring-property) | This property includes the string representation of RFC 822-encoded headers of the message. |
| [MessageId](#psmtpmessageid-property) | This property includes the message identifier for the message. |
| [MessageRecipients](#psmtpmessagerecipients-property) | This property includes the collection of recipients of the message. |
| [MessageText](#psmtpmessagetext-property) | This property includes the full text of the message to send (without headers). |
| [OAuth](#psmtpoauth-property) | The OAuth settings. |
| [OtherHeaders](#psmtpotherheaders-property) | This property includes an RFC 822-compliant string consisting of extra headers. |
| [Password](#psmtppassword-property) | This property includes a password for logon to the MailServer . |
| [Priority](#psmtppriority-property) | This property includes the priority of the mail message (optional). |
| [ReadReceiptTo](#psmtpreadreceiptto-property) | This property includes the email address to send a read-receipt to. |
| [RecipientKeys](#psmtprecipientkeys-property) | The collection of keys belonging to the recipient of the message. |
| [ReplyTo](#psmtpreplyto-property) | This property includes a mail address to which to reply (optional). |
| [ReturnPath](#psmtpreturnpath-property) | This property sets the Return-Path to be used for sending email. |
| [SendTo](#psmtpsendto-property) | This property includes a comma-separated list of addresses for destinations (required). |
| [Sensitivity](#psmtpsensitivity-property) | This property indicates the sensitivity of the mail message (optional). |
| [SigningAlgorithm](#psmtpsigningalgorithm-property) | The signature hash algorithm used when signing. |
| [SSLAcceptServerCert](#psmtpsslacceptservercert-property) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
| [SSLCert](#psmtpsslcert-property) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| [SSLEnabled](#psmtpsslenabled-property) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
| [SSLProvider](#psmtpsslprovider-property) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCert](#psmtpsslservercert-property) | The server certificate for the last established connection. |
| [SSLStartMode](#psmtpsslstartmode-property) | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. |
| [Subject](#psmtpsubject-property) | This property includes the subject of the mail message (optional). |
| [Timeout](#psmtptimeout-property) | The timeout for the class. |
| [User](#psmtpuser-property) | This property includes the user identifier needed to log in 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.*

|  |  |
| --- | --- |
| [Config](#psmtpconfig-method) | Sets or retrieves a configuration setting. |
| [Connect](#psmtpconnect-method) | This method connects to the mail relay and sends the SMTP HELO command. |
| [Disconnect](#psmtpdisconnect-method) | This method disconnects from the SMTP server. |
| [DoEvents](#psmtpdoevents-method) | This method processes events from the internal message queue. |
| [Encrypt](#psmtpencrypt-method) | Encrypts the message. |
| [Expand](#psmtpexpand-method) | This method asks the MailServer to expand a name or mailing list. |
| [Interrupt](#psmtpinterrupt-method) | This method interrupts the current method. |
| [ProcessQueue](#psmtpprocessqueue-method) | This method sends the messages that previously have been queued into QueueDir . |
| [Queue](#psmtpqueue-method) | This method queues the message into QueueDir . |
| [ResetHeaders](#psmtpresetheaders-method) | This method resets all the message headers to empty. |
| [Send](#psmtpsend-method) | This method sends the current message. |
| [SendCommand](#psmtpsendcommand-method) | This method sends the exact command directly to the server. |
| [SendToTerminalAndEmail](#psmtpsendtoterminalandemail-method) | This method sends to terminal and email. |
| [SendToTerminalOnly](#psmtpsendtoterminalonly-method) | This method sends to terminal only. |
| [SendToTerminalOrEmail](#psmtpsendtoterminaloremail-method) | This method sends to terminal or email. |
| [SetMessageStream](#psmtpsetmessagestream-method) | This method sets the stream to be uploaded to the server as part of the message. |
| [Sign](#psmtpsign-method) | Signs the message. |
| [SignAndEncrypt](#psmtpsignandencrypt-method) | Signs and encrypts the current message. |
| [Verify](#psmtpverify-method) | This method sends 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.*

|  |  |
| --- | --- |
| [ConnectionStatus](#psmtpconnectionstatus-event) | Fired to indicate changes in the connection state. |
| [EndTransfer](#psmtpendtransfer-event) | This event is fired when the message text completes transferring. |
| [Error](#psmtperror-event) | Fired when information is available about errors during data delivery. |
| [Expand](#psmtpexpand-event) | This event is fired for every email address returned by the server when the Expand method is called. |
| [KeyPassphrase](#psmtpkeypassphrase-event) | Fired if the passphrase of current key is incorrect or empty. |
| [LaunchBrowser](#psmtplaunchbrowser-event) | Fires before launching a browser with the authorization URL. |
| [Log](#psmtplog-event) | Fired once for each log message. |
| [PITrail](#psmtppitrail-event) | This event traces the commands sent to the mail server, and the respective replies. |
| [Progress](#psmtpprogress-event) | Fired as progress is made. |
| [SSLServerAuthentication](#psmtpsslserverauthentication-event) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#psmtpsslstatus-event) | Fired when secure connection progress messages are available. |
| [StartTransfer](#psmtpstarttransfer-event) | This event is fired when the message text starts transferring. |
| [Status](#psmtpstatus-event) | Shows the progress of the operation. |
| [Transfer](#psmtptransfer-event) | This event is fired when the message text is transferred to MailServer . |

## Config Settings

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

|  |  |
| --- | --- |
| [ClearSignature](#ClearSignature) | Specifies whether or not to create a cleartext signature. |
| [Comment](#Comment) | The OpenPGP message comment. |
| [CompressionLevel](#CompressionLevel) | The level of compression used. |
| [EnsureValidDSASignatureHashAlgorithm](#EnsureValidDSASignatureHashAlgorithm) | Whether or not to select a suitable signature hash algorithm automatically. |
| [LogLevel](#LogLevel) | Specifies the level of detail that is logged. |
| [ProcessAttachments](#ProcessAttachments) | Whether or not to process attachments. |
| [SymmetricPassphrase](#SymmetricPassphrase) | The password used for symmetric encryption or decryption. |
| [VersionHeader](#VersionHeader) | The Version header value in the ASCII armored OpenPGP message. |
| [AllowEmptyTo](#AllowEmptyTo) | If set to True, then the SendTo property is not required. |
| [AuthorizationIdentity](#AuthorizationIdentity) | The value to use as the authorization identity when SASL authentication is used. |
| [Charset](#Charset) | When set, the message headers will be encoded using the specified Charset. |
| [Hello](#Hello) | The argument for HELO (herald) command to the server (defaults to local host name). |
| [KeepQueue](#KeepQueue) | If set to True, queued files are not deleted after a successful send. |
| [MaxHeaderLength](#MaxHeaderLength) | Maximum length for headers to avoid line folding (default 80). |
| [MessageHeadersString](#MessageHeadersString) | String representation of RFC822-encoded headers of the message. |
| [MessageIdAlgorithm](#MessageIdAlgorithm) | Determines the algorithm used to hash the random MessageId. |
| [OtherHeaders](#OtherHeaders) | An RFC 822 compliant string consisting of extra headers. |
| [ReturnPath](#ReturnPath) | Sets the Return-Path to be used for sending email. |
| [SendRSET](#SendRSET) | Whether to send RSET command. |
| [StopOnBccErrors](#StopOnBccErrors) | Instructs the class to stop sending the message if the server does not acknowledge any of the BCCs. |
| [StopOnCcErrors](#StopOnCcErrors) | Instructs the class to stop sending the message if the server does not acknowledge any of the CCs. |
| [StopOnToErrors](#StopOnToErrors) | Instructs the class to stop sending the message if the server does not acknowledge any of the TOs. |
| [TransferText](#TransferText) | String representation of RFC822-encoded body of the message. |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) | Whether to trust any certificate presented by the server. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# [PSMTP](#psmtp-class).AllowExtensions Property

This property is a switch allowing the class to use ESMTP features (Extended SMTP).

## Syntax

```text
isAllowExtensions(): boolean;
setAllowExtensions(allowExtensions: boolean): void;
```

## Default Value

TRUE

## Remarks

This property is a switch allowing the class to use ESMTP features (Extended SMTP). If this property is True, the class will first send the EHLO greeting (Extended Hello) to the server and, if that fails, the standard HELO command will be sent.

This property is True by default but may be disabled if it is known in advance that the [MailServer](#psmtpmailserver-property) does not support SMTP extensions.

This property is not available at design time.

# [PSMTP](#psmtp-class).AuthMechanism Property

This property is used when connecting to the mail server.

## Syntax

```text
getAuthMechanism(): PSMTPAuthMechanisms;
setAuthMechanism(authMechanism: PSMTPAuthMechanisms): void;
enum PSMTPAuthMechanisms {
  amUserPassword,
  amCRAMMD5,
  amNTLM,
  amAPOP,
  amSASLPlain,
  amSASLDigestMD5,
  amKerberos,
  amXOAUTH2
}
```

## Default Value

0

## Remarks

This is the authentication mechanism property to be used when connecting to the mail server.

By default, this property is amUserPassword (0), and if the [User](#psmtpuser-property) and [Password](#psmtppassword-property) properties are set, the AUTH command is sent to the server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5 authentication is used instead.

If this property is set to amNTLM (2), NTLM authentication will be used.

If this property is set to amKerberos (6), Kerberos authentication will be used.

NOTE: This functionality is available only in Windows.

When set to amXOAUTH2 (7), set [User](#psmtpuser-property) to the username and [AuthorizationIdentity](#AuthorizationIdentity) to the OAuth token. See [AuthorizationIdentity](#AuthorizationIdentity) for details.

# [PSMTP](#psmtp-class).BCc Property

This property includes a comma-separated list of addresses for blind carbon copies (optional).

## Syntax

```text
getBCc(): string;
setBCc(BCc: string): void;
```

## Default Value

""

## Remarks

This property specifies a comma-separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination. Because no *BCc* SMTP header is created containing the destination addresses, individual recipients never see the list of the other recipients.

The class will return an error if the [MailServer](#psmtpmailserver-property) returns an error code about any email address specified in [SendTo](#psmtpsendto-property) or [Cc](#psmtpcc-property) but it will fire an [Error](#psmtperror-event) event only if the same thing happens with an email address specified in this property.

If the resulting header is longer than [MaxHeaderLength](#MaxHeaderLength), then it is folded according to RFC 822 specifications.

NOTE: You must clear the [MessageRecipients](#psmtpmessagerecipients-property) collection before setting this property to remove previous recipients.

# [PSMTP](#psmtp-class).Cc Property

This property includes a comma-separated list of addresses for carbon copies (optional).

## Syntax

```text
getCc(): string;
setCc(cc: string): void;
```

## Default Value

""

## Remarks

This property specifies a comma-separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a *Cc* SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the [BCc](#psmtpbcc-property)).

The class will return an error if the [MailServer](#psmtpmailserver-property) returns an error code about any email address specified in [SendTo](#psmtpsendto-property) or Cc but it will fire an [Error](#psmtperror-event) event only if the same thing happens with an email address specified in [BCc](#psmtpbcc-property).

If the resulting header is longer than [MaxHeaderLength](#MaxHeaderLength), then it is folded according to RFC 822 specifications.

NOTE: You must clear the [MessageRecipients](#psmtpmessagerecipients-property) collection before setting this property to remove previous recipients.

# [PSMTP](#psmtp-class).CompressionMethod Property

The compression algorithm used.

## Syntax

```text
getCompressionMethod(): string;
setCompressionMethod(compressionMethod: string): void;
```

## Default Value

"zip"

## Remarks

This property specifies which compression method is used when generating output. Possible values are:

- zip (default)
- zlib
- bzip2
- none or uncompressed

 Note: The level of compression is controlled by the [CompressionLevel](#CompressionLevel) setting.

# [PSMTP](#psmtp-class).Connected Property

Whether the class is connected.

## Syntax

```text
isConnected(): boolean;
```

## Default Value

FALSE

## Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the [Connect](#psmtpconnect-method) and [Disconnect](#psmtpdisconnect-method) methods to manage the connection.

This property is read-only and not available at design time.

# [PSMTP](#psmtp-class).DeliveryNotificationTo Property

This property includes the email address to which to send a delivery notification.

## Syntax

```text
getDeliveryNotificationTo(): string;
setDeliveryNotificationTo(deliveryNotificationTo: string): void;
```

## Default Value

""

## Remarks

This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address that can receive the delivery notification.

# [PSMTP](#psmtp-class).EncryptingAlgorithm Property

The encryption algorithm used when encrypting.

## Syntax

```text
getEncryptingAlgorithm(): string;
setEncryptingAlgorithm(encryptingAlgorithm: string): void;
```

## Default Value

"AES128"

## Remarks

This property specifies the encryption algorithm used when encrypting. Possible values are:

- CAST5
- 3DES or TripleDES
- AES256
- AES192
- AES128 (default)
- BLOWFISH
- TWOFISH
- IDEA
- AES256-OCB (AEAD)
- AES192-OCB (AEAD)
- AES128-OCB (AEAD)
- AES256-GCM (AEAD)
- AES192-GCM (AEAD)
- AES128-GCM (AEAD)

Note that for *AES256*, *AES192*, and *AES128*, the class uses a modified form of CFB mode in accordance with the OpenPGP standard.

Note that if [UseArgon2](#UseArgon2) is enabled, and [SymmetricPassphrase](#SymmetricPassphrase) is specified, an AEAD encryption algorithm (*AES*-OCB* and *AES*-GCM*) must be specified for symmetric encryption. If [UseArgon2](#UseArgon2) is disabled, and an AEAD encryption algorithm is specified, the AEAD mode (OCB or GCM) will be ignored when performing symmetric encryption.

An AEAD encryption algorithm may optionally be utilized when encrypting messages (when calling [Encrypt](#psmtpencrypt-method)). In this case, the [AEADChunkSizeExp](#AEADChunkSizeExp) configuration will specify the chunk size for splitting plaintext for encryption. Please see [AEADChunkSizeExp](#AEADChunkSizeExp) for additional details.

# [PSMTP](#psmtp-class).Firewall Property

A set of properties related to firewall access.

## Syntax

```text
getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;
```

## Default Value

## Remarks

This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect.

 Please refer to the [Firewall](#firewall-type) type for a complete list of fields.

# [PSMTP](#psmtp-class).From Property

This property includes the email address of the sender (required).

## Syntax

```text
getFrom(): string;
setFrom(from: string): void;
```

## Default Value

""

## Remarks

This property is used to create a *From* SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are as follows: *"Friendly Name" <address@company.com>* or *address@company.com*

If the resulting header is longer than [MaxHeaderLength](#MaxHeaderLength), then it is folded according to RFC 822 specifications.

# [PSMTP](#psmtp-class).Idle Property

The current status of the class.

## Syntax

```text
isIdle(): boolean;
```

## Default Value

TRUE

## Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

# [PSMTP](#psmtp-class).Importance Property

This property indicates the importance of the mail message (optional).

## Syntax

```text
getImportance(): PSMTPImportances;
setImportance(importance: PSMTPImportances): void;
enum PSMTPImportances {
  miUnspecified,
  miHigh,
  miNormal,
  miLow
}
```

## Default Value

0

## Remarks

This property indicates the importance of the mail message (optional). When set, an Importance header will be added to the message.

Importance is an indication to the recipient(s) about the level of importance of the message. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

# [PSMTP](#psmtp-class).Keys Property

A collection of keys used for cryptographic operations.

## Syntax

```text
getKeys(): KeyList;
```

## Default Value

## Remarks

This collection holds keys that are used for signing and decrypting. In most cases only one key will be specified, however multiple keys may be needed in some cases.

This property is not available at design time.

 Please refer to the [Key](#key-type) type for a complete list of fields.

# [PSMTP](#psmtp-class).LastReply Property

This property indicates the last reply received from the server.

## Syntax

```text
getLastReply(): string;
```

## 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](#psmtppitrail-event) event.

This property is read-only.

# [PSMTP](#psmtp-class).LocalHost Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

## Syntax

```text
getLocalHost(): string;
setLocalHost(localHost: string): void;
```

## Default Value

""

## Remarks

This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) 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.

# [PSMTP](#psmtp-class).MailPort Property

This property includes the server port for SMTP (default 25).

## Syntax

```text
getMailPort(): number;
setMailPort(mailPort: number): void;
```

## Default Value

25

## Remarks

This property contains the server port for SMTP (default 25). 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 an implicit Secure Sockets Layer (SSL), use port 465 (please refer to the [SSLStartMode](#psmtpsslstartmode-property) property for more information).

This property is not available at design time.

# [PSMTP](#psmtp-class).MailServer Property

This property includes the name or address of a mail server (mail relay).

## Syntax

```text
getMailServer(): string;
setMailServer(mailServer: string): void;
```

## Default Value

""

## Remarks

This property specifies the IP address (IP number in dotted internet format) or domain name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.

The current version of the class does not provide a default value for the mail relay. You must provide a host name yourself. Generally, any internet host with an SMTP server will suffice (e.g., a UNIX host), but it is preferable to select a MailServer that is close to the machine sending mail.

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, 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.

# [PSMTP](#psmtp-class).Message Property

This property provides a way to set the raw message content.

## Syntax

```text
getMessage(): Uint8Array;
setMessage(message: Uint8Array): void;
```

## Default Value

""

## Remarks

This property may be set instead of [MessageText](#psmtpmessagetext-property). This value will not be modified in any way by the class and will be sent as is. Use caution when setting this value as all encoding must be done before supplying the value to the component.

This property is not available at design time.

# [PSMTP](#psmtp-class).MessageDate Property

This property includes the date of the mail message (optional).

## Syntax

```text
getMessageDate(): string;
setMessageDate(messageDate: string): void;
```

## Default Value

"*"

## Remarks

If this property contains a nonempty string, then a *Date* SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.

Special case: If this property is set to the special value "*", a *Date* SMTP header reflecting the current date and time is generated when [MessageHeaders](#psmtpmessageheaders-property) is computed and the message is sent. This is the default behavior of the class

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 not available at design time.

# [PSMTP](#psmtp-class).MessageHeaders Property

This property includes a collection of RFC 822-encoded headers of the message.

## Syntax

```text
getMessageHeaders(): HeaderList;
```

## Default Value

## Remarks

This property holds the full headers of the message in RFC 822 format.

This property is read-only and not available at design time.

 Please refer to the [Header](#header-type) type for a complete list of fields.

# [PSMTP](#psmtp-class).MessageHeadersString Property

This property includes the string representation of RFC 822-encoded headers of the message.

## Syntax

```text
getMessageHeadersString(): string;
```

## Default Value

""

## Remarks

This property holds the full headers of the message in RFC 822 format.

This property is read-only.

# [PSMTP](#psmtp-class).MessageId Property

This property includes the message identifier for the message.

## Syntax

```text
getMessageId(): string;
setMessageId(messageId: string): void;
```

## Default Value

"*"

## Remarks

This property contains the message identifier for the message. When set, the value of MessageId is used as the Message-Id header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.

This property is not available at design time.

# [PSMTP](#psmtp-class).MessageRecipients Property

This property includes the collection of recipients of the message.

## Syntax

```text
getMessageRecipients(): MessageRecipientList;
```

## Default Value

## Remarks

This property contains a collection that describes to whom the message is being sent. You may include all recipients in this property, even Cc's and BCc's, which are specified by the type field.

 Please refer to the [MessageRecipient](#messagerecipient-type) type for a complete list of fields.

# [PSMTP](#psmtp-class).MessageText Property

This property includes the full text of the message to send (without headers).

## Syntax

```text
getMessageText(): string;
setMessageText(messageText: string): void;
```

## Default Value

""

## Remarks

This property contains the full text of the message.

The text contained in this property should be a collection of lines with lengths less than or equal to 80 bytes separated by . The text in the message lines must contain 7-bit characters so that the message can successfully pass through the multitude of mail systems on the Internet.

The class automatically escapes lines that start with a "." by adding another as specified in RFC 821. The message text is unescaped by the receiving agent, so the process is fully transparent.

# [PSMTP](#psmtp-class).OAuth Property

The OAuth settings.

## Syntax

```text
getOAuth(): MailOAuthSettings;
```

## Default Value

## Remarks

This property is used to configure the necessary fields to authenticate with the service provider. See the introduction for more information.

This property is read-only and not available at design time.

 Please refer to the [MailOAuthSettings](#mailoauthsettings-type) type for a complete list of fields.

# [PSMTP](#psmtp-class).OtherHeaders Property

This property includes an RFC 822-compliant string consisting of extra headers.

## Syntax

```text
getOtherHeaders(): string;
setOtherHeaders(otherHeaders: string): void;
```

## Default Value

""

## Remarks

This property contains a string of headers to be appended to the message headers created from other properties like [SendTo](#psmtpsendto-property), [Subject](#psmtpsubject-property), and so on.

The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by .

Use this property with caution. If this property contains invalid headers, message delivery might not be successful.

This property is useful for extending the functionality of the class. A good example is delivery of MIME-encoded messages.

Special case: If this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed message headers.

**Example. Sending an Email with an Additional Header:**

```text
component.MailServer = "MyServer";
component.From = "me@server.com";
component.SendTo = "recipient@server.com";
component.Subject = "My Subject";
component.MessageText = "This is the message body.";
component.OtherHeaders = "HeaderName: HeaderValue";
component.Send();
```

This property is not available at design time.

# [PSMTP](#psmtp-class).Password Property

This property includes a password for logon to the MailServer .

## Syntax

```text
getPassword(): string;
setPassword(password: string): void;
```

## Default Value

""

## Remarks

If this property is set to a nonempty string, then when connecting to the [MailServer](#psmtpmailserver-property) an AUTH or CRAM-MD5 (depending on the value of [AuthMechanism](#psmtpauthmechanism-property)) command is sent to provide authentication information for the user.

This property is not available at design time.

# [PSMTP](#psmtp-class).Priority Property

This property includes the priority of the mail message (optional).

## Syntax

```text
getPriority(): PSMTPPriorities;
setPriority(priority: PSMTPPriorities): void;
enum PSMTPPriorities {
  epUnspecified,
  epNormal,
  epUrgent,
  epNonUrgent
}
```

## Default Value

0

## Remarks

When this property is set, a priority header will be added to the message. Priority is an indication about the delivery priority of the message. The possible values are epNormal, epUrgent, and epNonUrgent.

# [PSMTP](#psmtp-class).ReadReceiptTo Property

This property includes the email address to send a read-receipt to.

## Syntax

```text
getReadReceiptTo(): string;
setReadReceiptTo(readReceiptTo: string): void;
```

## Default Value

""

## Remarks

When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address that should receive the read-receipt.

# [PSMTP](#psmtp-class).RecipientKeys Property

The collection of keys belonging to the recipient of the message.

## Syntax

```text
getRecipientKeys(): KeyList;
```

## Default Value

## Remarks

This property contains the keys of the message recipient.

Set this property before calling [Encrypt](#psmtpencrypt-method) or [SignAndEncrypt](#psmtpsignandencrypt-method).

This property is not available at design time.

 Please refer to the [Key](#key-type) type for a complete list of fields.

# [PSMTP](#psmtp-class).ReplyTo Property

This property includes a mail address to which to reply (optional).

## Syntax

```text
getReplyTo(): string;
setReplyTo(replyTo: string): void;
```

## Default Value

""

## Remarks

If this property contains a nonempty string, a *Reply-To* SMTP header is created for the message. This header shows the address to use for replies, which is useful if this address is different from the one in [From](#psmtpfrom-property).

If the resulting header is longer than [MaxHeaderLength](#MaxHeaderLength), then it is folded according to RFC 822 specifications.

# [PSMTP](#psmtp-class).ReturnPath Property

This property sets the Return-Path to be used for sending email.

## Syntax

```text
getReturnPath(): string;
setReturnPath(returnPath: string): void;
```

## Default Value

""

## Remarks

Setting this property sets the Return-Path to be used for sending email. If this is not set, the value in the [From](#psmtpfrom-property) property is used.

# [PSMTP](#psmtp-class).SendTo Property

This property includes a comma-separated list of addresses for destinations (required).

## Syntax

```text
getSendTo(): string;
setSendTo(sendTo: string): void;
```

## Default Value

""

## Remarks

This property specifies a comma-separated list of destinations for the mail message. A copy of the message is sent to each of them, and a *To* SMTP header is created containing the destination addresses.

Examples of valid addresses are as follows: *"Friendly Name" <address@company.com>* or *address@company.com*

The class will fail if the [MailServer](#psmtpmailserver-property) returns an error code about any email address specified in *SendTo* or [Cc](#psmtpcc-property) but it will silently ignore the error if the same thing happens with an email address specified in [BCc](#psmtpbcc-property).

If the resulting header is longer than [MaxHeaderLength](#MaxHeaderLength), then it is folded according to RFC 822 specifications.

NOTE: You must clear the [MessageRecipients](#psmtpmessagerecipients-property) collection before setting this property to remove previous recipients.

# [PSMTP](#psmtp-class).Sensitivity Property

This property indicates the sensitivity of the mail message (optional).

## Syntax

```text
getSensitivity(): PSMTPSensitivities;
setSensitivity(sensitivity: PSMTPSensitivities): void;
enum PSMTPSensitivities {
  esUnspecified,
  esPersonal,
  esPrivate,
  esCompanyConfidential
}
```

## Default Value

0

## Remarks

This property provides an indication of how sensitive it is to disclose the message to people other than the recipients of the message. When set, a Sensitivity header will added to the message. Possible values are as follows: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

# [PSMTP](#psmtp-class).SigningAlgorithm Property

The signature hash algorithm used when signing.

## Syntax

```text
getSigningAlgorithm(): string;
setSigningAlgorithm(signingAlgorithm: string): void;
```

## Default Value

"SHA256"

## Remarks

This property specifies the signature hash algorithm used when signing. Possible values are:

- SHA1
- MD5
- SHA256 (default)
- SHA384
- SHA512
- SHA224
- RIPEMD160
- SHA3-256
- SHA3-512

# [PSMTP](#psmtp-class).SSLAcceptServerCert Property

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

## Syntax

```text
getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;
```

## Default Value

## Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [PSMTP](#psmtp-class).SSLCert Property

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

## Syntax

```text
getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;
```

## Default Value

## Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the  field to the encoded certificate. To select a certificate, use the store and subject fields.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [PSMTP](#psmtp-class).SSLEnabled Property

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

## Syntax

```text
isSSLEnabled(): boolean;
setSSLEnabled(SSLEnabled: boolean): void;
```

## 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](#psmtpsslstartmode-property). Setting [SSLStartMode](#psmtpsslstartmode-property) will automatically update this property value.

This property is not available at design time.

# [PSMTP](#psmtp-class).SSLProvider Property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

## Syntax

```text
getSSLProvider(): PSMTPSSLProviders;
setSSLProvider(SSLProvider: PSMTPSSLProviders): void;
enum PSMTPSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}
```

## 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. |

 **Additional Notes**

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, the platform implementation will be used by default in all cases in the JavaScript edition.

NOTE: The internal provider is not support at this time.

# [PSMTP](#psmtp-class).SSLServerCert Property

The server certificate for the last established connection.

## Syntax

```text
getSSLServerCert(): Certificate;
```

## Default Value

## Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [PSMTP](#psmtp-class).SSLStartMode Property

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

## Syntax

```text
getSSLStartMode(): PSMTPSSLStartModes;
setSSLStartMode(SSLStartMode: PSMTPSSLStartModes): void;
enum PSMTPSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}
```

## 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. |

# [PSMTP](#psmtp-class).Subject Property

This property includes the subject of the mail message (optional).

## Syntax

```text
getSubject(): string;
setSubject(subject: string): void;
```

## Default Value

""

## Remarks

The string in this property is sent with a *Subject* SMTP header to the mail recipient.

If the resulting header is longer than [MaxHeaderLength](#MaxHeaderLength), then it is folded according to RFC 822 specifications.

# [PSMTP](#psmtp-class).Timeout Property

The timeout for the class.

## Syntax

```text
getTimeout(): number;
setTimeout(timeout: number): void;
```

## 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](#psmtpdoevents-method) 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 .

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.

# [PSMTP](#psmtp-class).User Property

This property includes the user identifier needed to log in as in the MailServer .

## Syntax

```text
getUser(): string;
setUser(user: string): void;
```

## Default Value

""

## Remarks

If this property is set to a nonempty string, then when connecting to the [MailServer](#psmtpmailserver-property) an *AUTH* or *CRAM-MD5* (depending on the value of [AuthMechanism](#psmtpauthmechanism-property)) command is sent to provide authentication information for the user.

This property is not available at design time.

# [PSMTP](#psmtp-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
async psmtp.config(configurationString : string): Promise< string>
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworkspgppsmtp) 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](#config-settings-class-ipworkspgppsmtp), you must call *Config("PROPERTY")*. The value will be returned as a string.

# [PSMTP](#psmtp-class).connect Method

This method connects to the mail relay and sends the SMTP HELO command.

## Syntax

```text
async psmtp.connect(): Promise< void>
```

## Remarks

This method connects to the mail relay and sends the SMTP *HELO* command, thus preparing to send messages. Any number of messages can later be sent using the [Send](#psmtpsend-method) method.

**Example. Connecting and Sending an Email:**

```text
control.MailServer = "MyServer"
control.From = "me@server.com"
control.SendTo = "recipient@server.com"
control.Subject = "My Subject"
control.MessageText = "This is the message body"
control.Connect()
control.Send()
control.Disconnect()
```

# [PSMTP](#psmtp-class).disconnect Method

This method disconnects from the SMTP server.

## Syntax

```text
async psmtp.disconnect(): Promise< void>
```

## Remarks

This method disconnects from the mail relay.

# [PSMTP](#psmtp-class).doEvents Method

This method processes events from the internal message queue.

## Syntax

```text
async psmtp.doEvents(): Promise< void>
```

## 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.

# [PSMTP](#psmtp-class).encrypt Method

Encrypts the message.

## Syntax

```text
async psmtp.encrypt(): Promise< void>
```

## Remarks

This method encrypts the specified message.

The message is encrypted with the public keys specified in [RecipientKeys](#psmtprecipientkeys-property).

When encrypting, the following properties may be used to further configure the class:

- [CompressionMethod](#psmtpcompressionmethod-property)
- [EncryptingAlgorithm](#psmtpencryptingalgorithm-property)

# [PSMTP](#psmtp-class).expand Method

This method asks the MailServer to expand a name or mailing list.

## Syntax

```text
async psmtp.expand(emailAddress : string): Promise< void>
```

## Remarks

This method asks the [MailServer](#psmtpmailserver-property) to expand a name or mailing list. The resulting response is provided in one or more [Expand](#psmtpexpand-event) events (one for each address). The class will try to connect to the mail relay if it is not already connected.

# [PSMTP](#psmtp-class).interrupt Method

This method interrupts the current method.

## Syntax

```text
async psmtp.interrupt(): Promise< void>
```

## Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

# [PSMTP](#psmtp-class).processQueue Method

This method sends the messages that previously have been queued into QueueDir .

## Syntax

```text
async psmtp.processQueue(queueDir : string): Promise< void>
```

## Remarks

This method sends the messages that previously have been queued into *QueueDir*. The [PITrail](#psmtppitrail-event) event shows the interaction with the server as messages are processed.

This method looks in the directory for files with the extension ".queued" and starts processing them.

When processing starts, the file extension is changed to ".sending". If an error happens at this stage, the sending process is aborted, and the file extension is changed to ".failed".

If the file is successfully sent, the file is normally deleted, unless the [KeepQueue](#KeepQueue) configuration setting is set to True, in which case the file extension is instead changed to ".sent" and the queue file is not deleted.

# [PSMTP](#psmtp-class).queue Method

This method queues the message into QueueDir .

## Syntax

```text
async psmtp.queue(queueDir : string): Promise< string>
```

## Remarks

This method queues the message into *QueueDir*. The message is queued into a unique file into the directory *QueueDir* for future processing.

*QueueDir* must already exist, or an error will be generated. Alternatively, *QueueDir* may be set to "*" to return the result as a string instead of writing it to a file.

This method returns the name of the unique queue file created in *QueueDir*. The file extension is ".queued".

Please refer to the [ProcessQueue](#psmtpprocessqueue-method) method for more information on email queue processing.

# [PSMTP](#psmtp-class).resetHeaders Method

This method resets all the message headers to empty.

## Syntax

```text
async psmtp.resetHeaders(): Promise< void>
```

## Remarks

This method resets all the message headers to "" (empty string). Use this method before creating a new message, so that headers from the previous message are not carried over to the next one.

# [PSMTP](#psmtp-class).send Method

This method sends the current message.

## Syntax

```text
async psmtp.send(): Promise< void>
```

## Remarks

This method sends the current message. If the class is not connected to the mail relay, a connection is created, the message is sent, and then the connection is closed unless an error occurs.

If the class is already connected (by use of the [Connect](#psmtpconnect-method) method), the connection will remain open after the message is sent. To disconnect, call the [Disconnect](#psmtpdisconnect-method) method.

**Example. Send an Email:**

```text
SMTPControl.MailServer = "MyServer"
SMTPControl.From = "me@server.com"
SMTPControl.SendTo = "recipient@server.com"
SMTPControl.Subject = "My Subject"
SMTPControl.MessageText = "This is the message body"
SMTPControl.Send()
```

# [PSMTP](#psmtp-class).sendCommand Method

This method sends the exact command directly to the server.

## Syntax

```text
async psmtp.sendCommand(command : string): Promise< void>
```

## 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](#psmtplastreply-property) property or monitor the [PITrail](#psmtppitrail-event) event to obtain the server's response.

# [PSMTP](#psmtp-class).sendToTerminalAndEmail Method

This method sends to terminal and email.

## Syntax

```text
async psmtp.sendToTerminalAndEmail(): Promise< void>
```

## Remarks

This method is similar to [Send](#psmtpsend-method) but requests also that the message is sent to the terminal of the users as well, if they are logged on and accept terminal messages. This method requires that [AllowExtensions](#psmtpallowextensions-property) is set to True and is not supported by all mail relays.

# [PSMTP](#psmtp-class).sendToTerminalOnly Method

This method sends to terminal only.

## Syntax

```text
async psmtp.sendToTerminalOnly(): Promise< void>
```

## Remarks

This method is similar to *Send* but requests instead that the message is sent to the user's terminal. if the user is not logged in or does not accept terminal messages. This method requires that [AllowExtensions](#psmtpallowextensions-property) is set to True and is not supported by all mail relays.

# [PSMTP](#psmtp-class).sendToTerminalOrEmail Method

This method sends to terminal or email.

## Syntax

```text
async psmtp.sendToTerminalOrEmail(): Promise< void>
```

## Remarks

This method is similar to [Send](#psmtpsend-method) but requests instead that the message is first sent to the user's terminal. If the user is not logged in or does not accept terminal messages, the message is sent to his or her mailbox. This method requires that [AllowExtensions](#psmtpallowextensions-property) is set to True and is not supported by all mail relays.

# [PSMTP](#psmtp-class).setMessageStream Method

This method sets the stream to be uploaded to the server as part of the message.

## Syntax

```text
async psmtp.setMessageStream(messageStream : ReadableStream): Promise< void>
```

## Remarks

This method sets the stream to be uploaded to the server as part of the message. If an upload stream is set before the [Send](#psmtpsend-method) method is called, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position *0*. The class will automatically close this stream if [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) is set to True (default). If the stream is closed, you will need to call this method again before calling [Send](#psmtpsend-method) again. The content of the stream will be read from the current position all the way to the end.

NOTE: This method and LocalFile will reset the other.

# [PSMTP](#psmtp-class).sign Method

Signs the message.

## Syntax

```text
async psmtp.sign(): Promise< void>
```

## Remarks

This method signs the specified message.

The message is signed with the private key specified in [Keys](#psmtpkeys-property).

When signing, the following properties may be used to further configure the class:

- [ClearSignature](#ClearSignature)
- [SigningAlgorithm](#psmtpsigningalgorithm-property)

# [PSMTP](#psmtp-class).signAndEncrypt Method

Signs and encrypts the current message.

## Syntax

```text
async psmtp.signAndEncrypt(): Promise< void>
```

## Remarks

This method signs and encrypts the specified message.

The message is encrypted with the public keys specified in [RecipientKeys](#psmtprecipientkeys-property) and signed with the private key specified in [Keys](#psmtpkeys-property).

When encrypting, the following properties may be used to further configure the class:

- [CompressionMethod](#psmtpcompressionmethod-property)
- [EncryptingAlgorithm](#psmtpencryptingalgorithm-property)

When signing, the following properties may be used to further configure the class:

- [ClearSignature](#ClearSignature)
- [SigningAlgorithm](#psmtpsigningalgorithm-property)

# [PSMTP](#psmtp-class).verify Method

This method sends a verification request to the SMTP server.

## Syntax

```text
async psmtp.verify(emailAddress : string): Promise< void>
```

## Remarks

This method asks the [MailServer](#psmtpmailserver-property) to verify the email address provided in the *'EmailAddress'* parameter.

# [PSMTP](#psmtp-class).ConnectionStatus Event

Fired to indicate changes in the connection state.

## Syntax

```text
psmtp.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )
```

## Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following:

|  |  |
| --- | --- |
|  | Firewall connection complete. |
|  | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). |
|  | Remote host connection complete. |
|  | Remote host disconnected. |
|  | SSL or S/Shell connection broken. |
|  | Firewall host disconnected. |

 *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error.

# [PSMTP](#psmtp-class).EndTransfer Event

This event is fired when the message text completes transferring.

## Syntax

```text
psmtp.on('EndTransfer', listener: (e: {readonly direction: number}) => void )
```

## Remarks

If [MessageText](#psmtpmessagetext-property) is not empty, the EndTransfer event is fired when the [MessageText](#psmtpmessagetext-property) finishes transferring from the local host to the [MailServer](#psmtpmailserver-property). If [MessageText](#psmtpmessagetext-property) is empty, the event is not fired.

If a file is attached to the [MessageText](#psmtpmessagetext-property) via the AttachedFile property, then EndTransfer fires again when the file finishes transferring. For more information, go to the description of the AttachedFile property.

The *Direction* parameter shows whether the client (0) or the server (1) is sending the data.

# [PSMTP](#psmtp-class).Error Event

Fired when information is available about errors during data delivery.

## Syntax

```text
psmtp.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-class-ipworkspgppsmtp) section.

# [PSMTP](#psmtp-class).Expand Event

This event is fired for every email address returned by the server when the Expand method is called.

## Syntax

```text
psmtp.on('Expand', listener: (e: {readonly address: string}) => void )
```

## Remarks

This event is fired for every email address as returned by the mail server when the [Expand](#psmtpexpand-method) method is called.

The *Address* parameter may contain a name and an email address, or just an email address, suitable for any of the addressing properties.

# [PSMTP](#psmtp-class).KeyPassphrase Event

Fired if the passphrase of current key is incorrect or empty.

## Syntax

```text
psmtp.on('KeyPassphrase', listener: (e: {readonly userId: string, readonly keyId: string, readonly fingerprint: string, passphrase: string}) => void )
```

## 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 KeysPassphrase 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](#psmtpsign-method)
- [SignAndEncrypt](#psmtpsignandencrypt-method)

*UserId* holds the user Id of the key the passphrase is required for.

The *UserId* format is:

```text
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 its 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:

```text
5E70662EA810E768
```

*Fingerprint* holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:

```text
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
```

# [PSMTP](#psmtp-class).LaunchBrowser Event

Fires before launching a browser with the authorization URL.

## Syntax

```text
psmtp.on('LaunchBrowser', listener: (e: {URL: string, command: string}) => void )
```

## Remarks

When the ClientProfile property is set to ocpApplication and GetAuthorization is called, the class will fire this event with the *Command*, which will be executed by the class. The *URL* parameter will be the authorization URL that the user will be directed to authenticate.

Within this event, you may override the current value of either *Command* or *URL* and provide your own value. If *Command* is set to an empty string, the class will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter. If *Command* is not empty, the URL will be appended to the end.

In Windows, ShellExecute is used to execute *Command*, which limits the verbs available for use in *Command* to:

- edit
- explore
- find
- open
- print

# [PSMTP](#psmtp-class).Log Event

Fired once for each log message.

## Syntax

```text
psmtp.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )
```

## Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

*LogLevel* indicates the level of message. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

*Message* is the log entry.

*LogType* identifies the type of log entry. Possible values are as follows:

- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"

# [PSMTP](#psmtp-class).PITrail Event

This event traces the commands sent to the mail server, and the respective replies.

## Syntax

```text
psmtp.on('PITrail', listener: (e: {readonly direction: number, readonly message: string}) => void )
```

## Remarks

The PITrail event is useful for debugging purposes. It shows all of the interaction 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 (Info) | The Message is an informative message originating from the client software (the class code). |

# [PSMTP](#psmtp-class).Progress Event

Fired as progress is made.

## Syntax

```text
psmtp.on('Progress', listener: (e: {readonly bytesProcessed: number, readonly percentProcessed: number}) => void )
```

## 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.

# [PSMTP](#psmtp-class).SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

## Syntax

```text
psmtp.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )
```

## Remarks

This event fires with information about the server certificate. The *Status* property shows why verification failed (otherwise, *Status* contains the string *OK*). To manually accept an untrusted certificate, the [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) setting must be set to True before initiating the connection.

# [PSMTP](#psmtp-class).SSLStatus Event

Fired when secure connection progress messages are available.

## Syntax

```text
psmtp.on('SSLStatus', listener: (e: {readonly message: string}) => void )
```

## Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

# [PSMTP](#psmtp-class).StartTransfer Event

This event is fired when the message text starts transferring.

## Syntax

```text
psmtp.on('StartTransfer', listener: (e: {readonly direction: number}) => void )
```

## Remarks

If [MessageText](#psmtpmessagetext-property) is not empty, the StartTransfer event is fired when the [MessageText](#psmtpmessagetext-property) starts transferring from the local host to the [MailServer](#psmtpmailserver-property). If [MessageText](#psmtpmessagetext-property) is empty, the event is not fired.

If a file is attached to the [MessageText](#psmtpmessagetext-property) via the AttachedFile property, then StartTransfer fires again when the file starts transferring. Please go to the description of the AttachedFile property for more information.

The *Direction* parameter shows whether the client (0) or the server (1) is sending the data.

# [PSMTP](#psmtp-class).Status Event

Shows the progress of the operation.

## Syntax

```text
psmtp.on('Status', listener: (e: {readonly message: string}) => void )
```

## 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](#LogLevel) setting.

# [PSMTP](#psmtp-class).Transfer Event

This event is fired when the message text is transferred to MailServer .

## Syntax

```text
psmtp.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void )
```

## Remarks

One or more Transfer events are fired during message delivery. Messages consist of [MessageText](#psmtpmessagetext-property) and an optional AttachedFile. The *BytesTransferred* parameter shows the number of bytes sent starting from the beginning of [MessageText](#psmtpmessagetext-property) or AttachedFile.

*Text* contains the current portion of the message being sent.

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.

# Certificate Type

This is the digital certificate being used.

## Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [KeyPassword](#Certificate_f_KeyPassword)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *string (read-only)*
*Default Value: ""*

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.

 **ExpirationDate** *string (read-only)*
*Default Value: ""*

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

 **ExtendedKeyUsage** *string (read-only)*
*Default Value: ""*

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

 **Fingerprint** *string (read-only)*
*Default Value: ""*

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*

 **FingerprintSHA1** *string (read-only)*
*Default Value: ""*

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*

 **FingerprintSHA256** *string (read-only)*
*Default Value: ""*

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*

 **Issuer** *string (read-only)*
*Default Value: ""*

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

 **KeyPassword** *string*
*Default Value: ""*

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys.

NOTE: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .

 **PrivateKey** *string (read-only)*
*Default Value: ""*

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The  may be available but not exportable. In this case,  returns an empty string.

 **PrivateKeyAvailable** *boolean (read-only)*
*Default Value: False*

Whether a  is available for the selected certificate. If  is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *string (read-only)*
*Default Value: ""*

The name of the  container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *string (read-only)*
*Default Value: ""*

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

 **PublicKeyAlgorithm** *string (read-only)*
*Default Value: ""*

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.

 **PublicKeyLength** *number (read-only)*
*Default Value: 0*

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

 **SerialNumber** *string (read-only)*
*Default Value: ""*

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.

 **SignatureAlgorithm** *string (read-only)*
*Default Value: ""*

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.

 **Store** *string*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The  property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

 is used in conjunction with the  property to specify client certificates. If  has a value, and  or  is set, a search for a certificate is initiated. Please see the  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).

 **StoreB** *Uint8Array*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The  property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

 is used in conjunction with the  property to specify client certificates. If  has a value, and  or  is set, a search for a certificate is initiated. Please see the  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).

 **StorePassword** *string*
*Default Value: ""*

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

 **StoreType** *CertStoreTypes*
*Default Value: 0*

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:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **SubjectAltNames** *string (read-only)*
*Default Value: ""*

Comma-separated lists of alternative subject names for the certificate.

 **ThumbprintMD5** *string (read-only)*
*Default Value: ""*

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.

 **ThumbprintSHA1** *string (read-only)*
*Default Value: ""*

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.

 **ThumbprintSHA256** *string (read-only)*
*Default Value: ""*

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.

 **Usage** *string (read-only)*
*Default Value: ""*

The text description of .

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

 **UsageFlags** *number (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of  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  property for a text representation of .

This functionality currently is not available when the provider is OpenSSL.

 **Version** *string (read-only)*
*Default Value: ""*

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

 **Subject** *string*
*Default Value: ""*

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

If a field value contains a comma, it must be quoted.

 **Encoded** *string*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The  and  properties also may be used to specify a certificate.

When  is set, a search is initiated in the current  for the private key of the certificate. If the key is found,  is updated to reflect the full subject of the selected certificate; otherwise,  is set to an empty string.

 **EncodedB** *Uint8Array*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The  and  properties also may be used to specify a certificate.

When  is set, a search is initiated in the current  for the private key of the certificate. If the key is found,  is updated to reflect the full subject of the selected certificate; otherwise,  is set to an empty string.

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(String certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(int storeType, String store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# Firewall Type

The firewall the class will connect through.

## Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall  and the .

The following fields are available:

- [AutoDetect](#Firewall_f_AutoDetect)

- [FirewallType](#Firewall_f_FirewallType)

- [Host](#Firewall_f_Host)

- [Password](#Firewall_f_Password)

- [Port](#Firewall_f_Port)

- [User](#Firewall_f_User)

## Fields

 **AutoDetect** *boolean*
*Default Value: False*

Whether to automatically detect and use firewall system settings, if available.

 **FirewallType** *FirewallTypes*
*Default Value: 0*

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. [](#f_Port) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [](#f_Port) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [](#f_Port) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [](#f_Port) is set to 1080. |

 **Host** *string*
*Default Value: ""*

The name or IP address of the firewall (optional). If a  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 .

 **Password** *string*
*Default Value: ""*

A password if authentication is to be used when connecting through the firewall. If  is specified, the  and  properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .

 **Port** *number*
*Default Value: 0*

The Transmission Control Protocol (TCP) port for the firewall . See the description of the  property for details.

NOTE: This property is set automatically when  is set to a valid value. See the description of the  property for details.

 **User** *string*
*Default Value: ""*

A username if authentication is to be used when connecting through a firewall. If  is specified, this property and the  property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class .

## Constructors

```text
public Firewall();
```

# Header Type

This is an HTTP header as it is received from the server.

## Remarks

When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a , and its corresponding .

The following fields are available:

- [Field](#Header_f_Field)

- [Value](#Header_f_Value)

## Fields

 **Field** *string*
*Default Value: ""*

This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered).

 **Value** *string*
*Default Value: ""*

This property contains the [Header](#header-type) contents.

## Constructors

```text
public Header();
```

```text
public Header(String field, String value);
```

# Key Type

The OpenPGP key being used.

## Remarks

This type describes the current key. The key may be a public or secret key. The fields are used to identify or select the key.

The following fields are available:

- [Curve](#Key_f_Curve)

- [EffectiveDate](#Key_f_EffectiveDate)

- [ExpirationDate](#Key_f_ExpirationDate)

- [Keyring](#Key_f_Keyring)

- [OtherUserIds](#Key_f_OtherUserIds)

- [Passphrase](#Key_f_Passphrase)

- [PublicKey](#Key_f_PublicKey)

- [PublicKeyAlgorithm](#Key_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Key_f_PublicKeyLength)

- [Revoked](#Key_f_Revoked)

- [SecretKey](#Key_f_SecretKey)

- [SecretKeyAvailable](#Key_f_SecretKeyAvailable)

- [Usage](#Key_f_Usage)

- [UsageFlags](#Key_f_UsageFlags)

- [Version](#Key_f_Version)

- [UserId](#Key_f_UserId)

- [Id](#Key_f_Id)

- [Fingerprint](#Key_f_Fingerprint)

- [Encoded](#Key_f_Encoded)

## Fields

 **Curve** *string (read-only)*
*Default Value: ""*

This property specifies the elliptic curve if  is *ECDSA*, *EdDSA*, *Ed25519*, *Ed448*, *ML-DSA-65+Ed25519*, or *ML-DSA-87+Ed448*. Possible values are:

| Curve | Valid Public Key Algorithms | Description |
| --- | --- | --- |
| secp256r1 | ECDSA | NIST curve P-256 |
| secp384r1 | ECDSA | NIST curve P-384 |
| secp521r1 | ECDSA | NIST curve P-521 |
| secp256k1 | ECDSA | Secp256k1 |
| brainpoolP256r1 | ECDSA | Brainpool curve P-256r1 |
| brainpoolP384r1 | ECDSA | Brainpool curve P-384r1 |
| brainpoolP512r1 | ECDSA | Brainpool curve P-512r1 |
| Ed25519 | EdDSA, Ed25519, ML-DSA-65+Ed25519 | Ed25519 |
| Ed448 | Ed448, ML-DSA-87+Ed448 | Ed448 |

 **EffectiveDate** *string (read-only)*
*Default Value: ""*

The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:

23-Jan-2000 15:00:00.

 **ExpirationDate** *string (read-only)*
*Default Value: ""*

The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:

23-Jan-2001 15:00:00.

 **Keyring** *string*
*Default Value: ""*

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.

 **OtherUserIds** *string (read-only)*
*Default Value: ""*

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

 **Passphrase** *string*
*Default Value: ""*

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

 **PublicKey** *string (read-only)*
*Default Value: ""*

The public key of the key. The key is provided as ASCII armored data.

 **PublicKeyAlgorithm** *string (read-only)*
*Default Value: ""*

A text description of the public key algorithm of the key. Possible values are:

- RSA
- DSA
- ECDSA
- EdDSA
- Ed25519
- Ed448
- ML-DSA-65+Ed25519
- ML-DSA-87+Ed448
- RSA-Legacy

 **PublicKeyLength** *number (read-only)*
*Default Value: 0*

The length of the public key in bits. Common values are 1024, 2048, and 3072.

If the  property is *ECDSA*, *EdDSA*, *Ed25519*, *Ed448*, *ML-DSA-65+Ed25519*, or *ML-DSA-87+Ed448*, the length of the public key is determined by the . Possible lengths are:

| Curve | Public Key Length (bits) |
| --- | --- |
| secp256r1 | 256 |
| secp384r1 | 384 |
| secp521r1 | 528 |
| secp256k1 | 256 |
| Ed25519 | 256 |
| Ed448 | 456 |

 **Revoked** *boolean (read-only)*
*Default Value: False*

Whether or not the key is revoked.

 **SecretKey** *string (read-only)*
*Default Value: ""*

The secret key of the key (if available). The key is provided as ASCII armored data.

 **SecretKeyAvailable** *boolean (read-only)*
*Default Value: False*

Whether or not a secret key is available for the selected key.

 **Usage** *string (read-only)*
*Default Value: ""*

A text description of .

The value will be of one or more of the following strings, separated by commas:

- Certifying Other Certificates
- Signing Emails and Files
- Encrypting Emails and Files
- Split Key
- Authenticate Against Servers
- Group Key

 **UsageFlags** *number (read-only)*
*Default Value: 47*

Flags that show the intended use for the key. The default value is 0x0F. The value of  is a combination of the following flags:

|  |  |
| --- | --- |
| 0x01 | This key may be used to certify other keys. |
| 0x02 | This key may be used to sign data. |
| 0x0C | This key may be used to encrypt communications and encrypt storage. |
| 0x10 | The private component of this key may have been split by a secret-sharing mechanism. |
| 0x20 | This key may be used for authentication. |
| 0x80 | The private component of this key may be in the possession of more than one person. |

Please refer to the  property for a text representation of .

 **Version** *number (read-only)*
*Default Value: 4*

This property can be used to query the OpenPGP version of the currently selected Key. Possible values are:

- *4* - OpenPGP v4 (default)
- *5* - LibrePGP v5
- *6* - OpenPGP v6

 **UserId** *string*
*Default Value: ""*

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 . When this property is set the class will search the  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:

```text
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 its 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.

 **Id** *string*
*Default Value: ""*

The hex-encoded, 4-byte or 8-byte key Id. 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:

```text
5E70662EA810E768
```

When a key is loaded, this property is populated with the Id associated with the key. This property may be set to load a key from the . When this property is set the class will search the  for a key associated with the Id specified.

The KeyIdLength setting may be set to control the length of the returned key Id.

NOTE: It is recommended to use the  property when loading a key from the , as it is possible for different keys to have the same Id.

 **Fingerprint** *string*
*Default Value: ""*

The hex-encoded, 20-byte fingerprint of the key.

When a key is loaded, this property is populated with the Fingerprint associated with the key. This property may be set to load a key from the . When this property is set the class will search the  for a key associated with the Fingerprint specified.

This is in the form:

```text
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
```

 **Encoded** *string*
*Default Value: ""*

The key. This property can be used to assign a specific key. The , , and  properties may also be used to specify a key.

 **EncodedB** *Uint8Array*
*Default Value: ""*

The key. This property can be used to assign a specific key. The , , and  properties may also be used to specify a key.

## Constructors

```text
public Key(String keyring);
```

 Reads the OpenPGP public key from the specified * Keyring * . If multiple keys are present only the first one is used.

```text
public Key(byte[] encoded);
```

 Reads the OpenPGP key from the specified * Encoded * . Both binary-formatted and ASCII-armored data are accepted.

```text
public Key(String keyring, String userId);
```

 Searches the * Keyring * for an OpenPGP key with a matching * UserId * . The UserId parameter can be any of the following: UserID, Fingerprint or KeyId. If * UserId * is set to "*" the first key will be used.

```text
public Key(String keyring, String secretKeyringFile, String publicKeyringFile, String userId);
```

 Searches the * Keyring * for the specified * SecretKeyRingFile * and * PublicKeyringFile * . If * UserId * is set to "*" the first key will be used.

```text
public Key(byte[] encoded, String userId);
```

 Searches the * Encoded * for an OpenPGP key with a matching * UserId * . If * UserId * is set to "*" the first key will be used.

# MailOAuthSettings Type

The settings used to authenticate with the service provider.

## Remarks

This type is used to give the class the necessary information needed to complete the OAuth process.

The following fields are available:

- [AccessToken](#MailOAuthSettings_f_AccessToken)

- [AuthorizationScope](#MailOAuthSettings_f_AuthorizationScope)

- [ClientId](#MailOAuthSettings_f_ClientId)

- [ClientSecret](#MailOAuthSettings_f_ClientSecret)

- [RefreshToken](#MailOAuthSettings_f_RefreshToken)

- [ReturnURL](#MailOAuthSettings_f_ReturnURL)

- [ServerAuthURL](#MailOAuthSettings_f_ServerAuthURL)

- [ServerTokenURL](#MailOAuthSettings_f_ServerTokenURL)

## Fields

 **AccessToken** *string*
*Default Value: ""*

The access token returned by the authorization server. This is set when the class makes a request to the token server.

 **AuthorizationScope** *string*
*Default Value: ""*

The scope request or response parameter used during authorization.

 **ClientId** *string*
*Default Value: ""*

The id of the client assigned when registering the application.

 **ClientSecret** *string*
*Default Value: ""*

The secret value for the client assigned when registering the application.

 **RefreshToken** *string*
*Default Value: ""*

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

 **ReturnURL** *string*
*Default Value: ""*

The URL where the user (browser) returns after authenticating. This property is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

 **ServerAuthURL** *string*
*Default Value: ""*

The URL of the authorization server.

 **ServerTokenURL** *string*
*Default Value: ""*

The URL of the token server used to obtain the access token.

## Constructors

```text
public MailOAuthSettings();
```

# MessageRecipient Type

This types describes the message recipient.

## Remarks

This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the class is sending the message.

The following fields are available:

- [Address](#MessageRecipient_f_Address)

- [Name](#MessageRecipient_f_Name)

- [Options](#MessageRecipient_f_Options)

- [RecipientType](#MessageRecipient_f_RecipientType)

## Fields

 **Address** *string*
*Default Value: ""*

This property contains the email address of the recipient.

 **Name** *string*
*Default Value: ""*

This property contains the name of the recipient.

 **Options** *string*
*Default Value: ""*

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.

```text
component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";
```

 **RecipientType** *EmailRecipientTypes*
*Default Value: 0*

This property contains the recipient type: To, Cc, or Bcc.

## Constructors

```text
public MessageRecipient();
```

```text
public MessageRecipient(String address);
```

```text
public MessageRecipient(String address, int recipientType);
```

# ReadableStream Type

## Syntax

```text
interface ReadableStream {
  read(buffer: Uint8Array, offset: number, length: number): Promise<number>;
  readSync(buffer: Uint8Array, offset: number, length: number): number;
  available(): number;
  close(): void;
  mark():void;
  reset():void;
  markSupported():boolean;
}
```

## Remarks

 The PSMTP class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the PSMTP class.

 When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
read(buffer: Uint8Array, offset: number, length: number): Promise <number> { }
```

```text
readSync(buffer: Uint8Array, offset: number, length: number): number { }
```

```text
available(): number { }
```

```text
close(): void { }
```

```text
mark(): void { }
```

```text
reset(): void { }
```

```text
markSupported(): boolean { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | buffer: The buffer to store the read data. <br> offset: The starting position within the buffer to write data.<br> length: The maximum number of bytes to read.<br> |
| read | Reads data from the stream into the provided buffer. This method must be implemented.<br> Returns a promise resolving to the number of bytes read, -1 if no data is available. |
| readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. |
| available | Returns the number of bytes available for reading. This method must be implemented.<br> |
| close | Closes the stream and releases associated resources. |
| mark | Marks the current position in this stream. |
| reset | Repositions this stream to the position at the time the mark method was last called. |
| markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. |

# WriteableStream Type

## Syntax

```text
interface WriteableStream {
  write(data: Uint8Array, offset: number, length: number): Promise<void>;
  writeSync(data: Uint8Array, offset: number, length: number): void;
  close(): void;
}
```

## Remarks

 The PSMTP class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the PSMTP class.

 When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
write(data: Uint8Array, offset: number, length: number): Promise <void> { }
```

```text
writeSync(data: Uint8Array, offset: number, length: number): void { }
```

```text
close(): void { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | data: The buffer containing the data to write.<br> offset: The starting position in the buffer to read data from.<br> length: The maximum number of bytes to write.<br> |
| write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.<br> Returns a promise that resolves when the write operation completes. |
| writeSync | Synchronously writes data from the buffer to the stream. |
| close | Closes the stream and releases associated resources. |

# Config Settings (*class *ipworkspgp.[psmtp](#psmtp-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](#psmtpconfig-method) method.

### PSMTP Config Settings

**ClearSignature**: Specifies whether or not to create a cleartext signature.This setting controls whether or not a cleartext signature is created during signing. The default value is True. When set to True a cleartext signature will be created when [Sign](#psmtpsign-method) is called.

Note: some mail applications such as GpgOL cannot process cleartext signatures.

**Comment**: The OpenPGP message comment.OpenPGP messages may contain a comment. A comment may optionally be set before calling [Encrypt](#psmtpencrypt-method), [Sign](#psmtpsign-method), or [SignAndEncrypt](#psmtpsignandencrypt-method).

**CompressionLevel**: The level of compression used.This setting specifies the level of compression used: possible values depend on the value of [CompressionMethod](#psmtpcompressionmethod-property) and are detailed below.

This value is passed directly to the underlying compression library:

|  |  |
| --- | --- |
| zlib | -1 (library default), or 0-9 |
| zip | -1 (library default), or 0-9 |
| bzip2 | 1-9 |

 For *zlib* and *zip*, -1 requests the library's own default compression level (typically equivalent to *6*). For *bzip2*, which has no native default level, a value of -1 is treated as *4*. Higher values (other than -1) cause the class to compress better; lower values cause it to compress faster. The default value is -1.

**EnsureValidDSASignatureHashAlgorithm**: Whether or not to select a suitable signature hash algorithm automatically.This setting specifies whether the class ensures a valid hash algorithm is selected for use with the loaded DSA or ECDSA key. The default value is True.

## DSA Notes

DSA requires that the hash be 160 bits or larger, which means MD5 is not a suitable algorithm. When DSA Signature Hash Algorithm selection is enabled (default) the class will use the preferred algorithm from the key if it meets the requirements for DSA. If the preferred algorithm is MD5 and does not meed the requirements for DSA the class will automatically use a suitable algorithm based on the Q element of the DSA key (may be SHA1, SHA224, or SHA256).

## ECDSA Notes

The ECDSA Signature Hash Algorithm requirements are directly related to the KeyCurve used by the key. When this setting is enabled (default) the class will use the preferred algorithm from the key if it meets the requirements for ECDSA. If the preferred algorithm does not meet the requirements the class will automatically select a valid hash algorithm based on the curve as follows:

| Curve | Hash Algorithm |
| --- | --- |
| secp256r1 | SHA256 |
| secp384r1 | SHA384 |
| secp521r1 | SHA512 |
| secp256k1 | SHA256 |

**LogLevel**: Specifies the level of detail that is logged.This setting controls the level of detail that is logged through the [Status](#psmtpstatus-event) event. Possible values are:

|  |  |
| --- | --- |
| 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. |

**ProcessAttachments**: Whether or not to process attachments.This setting controls whether attachments are processed when calling [Encrypt](#psmtpencrypt-method), [Sign](#psmtpsign-method), or [SignAndEncrypt](#psmtpsignandencrypt-method). If set to True the attachments will also be encrypted and/or signed. If set to False the attachments will be added to the message with no additional processing. The default value is False.

**SymmetricPassphrase**: The password used for symmetric encryption or decryption.This setting specifies the passphrase when using symmetric encryption. If a value is provided, symmetric encryption/decryption will be attempted. In this case no keys are used for either encryption or decryption. Only [Encrypt](#psmtpencrypt-method) and Decrypt are valid operations when a value is set. [Sign](#psmtpsign-method), [SignAndEncrypt](#psmtpsignandencrypt-method), VerifySignature, and DecryptAndVerifySignature are not valid operations when using this option.

**VersionHeader**: The Version header value in the ASCII armored OpenPGP message.This setting specifies the Version header value included in the ASCII armored OpenPGP message. This may be set before calling [Encrypt](#psmtpencrypt-method), [Sign](#psmtpsign-method), or [SignAndEncrypt](#psmtpsignandencrypt-method). The default value is "IPWorks PGP 2026".

This setting will be populated after calling Decrypt, VerifySignature, or DecryptAndVerifySignature.

### SMTP Config Settings

**AllowEmptyTo**: If set to True, then the SendTo property is not required.Normally, the [SendTo](#psmtpsendto-property) property is required to send a message. If [AllowEmptyTo](#AllowEmptyTo) is True, then this is not the case, and messages can be sent with just one or both of [Cc](#psmtpcc-property) and [BCc](#psmtpbcc-property) set.

**AuthorizationIdentity**: The value to use as the authorization identity when SASL authentication is used.When [AuthMechanism](#psmtpauthmechanism-property) is set to amXOAUTH2, you may use this configuration setting to specify an authorization identity to be used when authenticating. In the case of amXOAUTH2, this should be your OAUTH authorization string. For instance:

```plaintext
Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q
```

NOTE: When using amXOAUTH2, [User](#psmtpuser-property) must be specified, but [Password](#psmtppassword-property) is not required.

**Charset**: When set, the message headers will be encoded using the specified Charset.This configuration setting is used to specify the "charset" to be used to encode the message headers. For example, to use UTF-8 you can set this property to "UTF-8". The default value is "" (empty string) in which case the headers will not be encoded.

**Hello**: The argument for HELO (herald) command to the server (defaults to local host name).The [Hello](#Hello) property specifies a string to send to the [MailServer](#psmtpmailserver-property) at connection time as an argument to the SMTP *HELO* command. This generally identifies the host sending mail, and that is why the [Hello](#Hello) property defaults to the name of the local host. The property is provided in case the class does not accept the default value and a custom value (e.g., a fully qualified domain name) must be sent.

If [AllowExtensions](#psmtpallowextensions-property) is True, the *EHLO* command will be sent instead of the *HELO* command.

**KeepQueue**: If set to True, queued files are not deleted after a successful send.Normally, [ProcessQueue](#psmtpprocessqueue-method) deletes queued files after processing them. If [KeepQueue](#KeepQueue) is True, then the file extension is instead changed to ".sent" and the files are not deleted.

**MaxHeaderLength**: Maximum length for headers to avoid line folding (default 80).The [MaxHeaderLength](#MaxHeaderLength) specifies the maximum line length supported by the mail delivery system. Any headers longer than [MaxHeaderLength](#MaxHeaderLength) are folded as specified in RFC 822.

It is generally a good idea to use a [MaxHeaderLength](#MaxHeaderLength) of less than 100 bytes, although different mail relays and mail servers have different requirements for header lengths.

**MessageHeadersString**: String representation of RFC822-encoded headers of the message.This setting holds the full headers of the message in RFC 822 format. Use this along with [TransferText](#TransferText) to store the entire message in RFC 822 format.

**Example:**

```csharp
smtp1.Send();
string rawMsg = smtp1.Config("MessageHeadersString") + smtp1.Config("TransferText");
```

**MessageIdAlgorithm**: Determines the algorithm used to hash the random MessageId. The [MessageIdAlgorithm](#MessageIdAlgorithm) specifies which algorithm to use in the hash for the [MessageId](#psmtpmessageid-property) when the property is set to "*". The default value is "SHA1".

Possible values are as follows:

- "MD5"
- "SHA1" (default)
- "SHA256"

**OtherHeaders**: An RFC 822 compliant string consisting of extra headers.This is the same as the [OtherHeaders](#psmtpotherheaders-property) property. This configuration setting is exposed for use by classes that are inherited from SMTP.

**ReturnPath**: Sets the Return-Path to be used for sending email.This is the same as the [ReturnPath](#psmtpreturnpath-property) property. This configuration setting is exposed for use by classes that are inherited from SMTP.

**SendRSET**: Whether to send RSET command.By default, the class will periodically send the *RSET* command to the server. Changing this configuration setting to False will prevent the *RSET* command from being sent. This can be useful when interacting with some servers that do not respond properly to the *RSET* command.

**StopOnBccErrors**: Instructs the class to stop sending the message if the server does not acknowledge any of the BCCs.If this configuration setting is set to True, the class will fail the moment the server does not acknowledge a Bcc address. If it is set to False, an error will be fired for every Bcc that is not recognized by the server, but the message will be sent to the rest of the recipients. The default value is False.

**StopOnCcErrors**: Instructs the class to stop sending the message if the server does not acknowledge any of the CCs.If this configuration setting is set to True, the class will fail the moment the server does not acknowledge a Cc address. If it is set to False, an error will be fired for every Cc that is not recognized by the server, but the message will be sent to the rest of the recipients. The default value is True.

**StopOnToErrors**: Instructs the class to stop sending the message if the server does not acknowledge any of the TOs.If this configuration setting is set to True, the class will fail the moment the server does not acknowledge a To address. If it is set to False, an error will be fired for every To that is not recognized by the server, but the message will be sent to the rest of the recipients. The default value is True.

**TransferText**: String representation of RFC822-encoded body of the message.This configuration setting holds the full body of the message in RFC 822 format. Use this along with [MessageHeadersString](#MessageHeadersString) to store the entire message in RFC 822 format.

**Example:**

```csharp
smtp1.Send();
string rawMsg = smtp1.Config("MessageHeadersString") + smtp1.Config("TransferText");
```

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#psmtptimeout-property) for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class .

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class .

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the 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.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#psmtplocalhost-property) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

If the class is connected, the [LocalHost](#psmtplocalhost-property) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#psmtpsslprovider-property) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#psmtpsslstatus-event) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#psmtpsslprovider-property) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the 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.

**SSLAcceptAnyServerCert**: Whether to trust any certificate presented by the server.This configuration setting disables all certificate verification when set to *True*. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#psmtpsslprovider-property) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#psmtpsslcert-property) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#psmtpsslstatus-event) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [SSLProvider](#psmtpsslprovider-property) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [SSLProvider](#psmtpsslprovider-property) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [SSLProvider](#psmtpsslprovider-property) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [SSLProvider](#psmtpsslprovider-property) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

In the JavaScript edition, the platform implementation is used when TLS 1.3 is enabled and [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#psmtpsslprovider-property) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#psmtpsslprovider-property) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [SSLProvider](#psmtpsslprovider-property) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#psmtpsslserverauthentication-event) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#psmtpsslserverauthentication-event) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#psmtpsslserverauthentication-event) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the 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](#psmtpsslprovider-property) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

This functionality is currently not available when the provider is OpenSSL.

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#psmtpsslprovider-property) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

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 .

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [SSLProvider](#psmtpsslprovider-property) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#psmtptimeout-property) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the 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

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 This setting is set to *false* by default on all platforms.

# Trappable Errors (*class *ipworkspgp.[psmtp](#psmtp-class))

### SMTP Errors

|  |  |
| --- | --- |
| 118 | Firewall Error. Error message contains detailed description. |
| 161 | SMTP protocol error. Description contains the server reply. |
| 162 | Error communicating with server. Error text is attached. |
| 163 | Please specify a [MailServer](#psmtpmailserver-property). |
| 164 | Please specify a sender ([From](#psmtpfrom-property)). |
| 165 | Please specify a recipient. |
| 166 | Busy executing current method. |
| 301 | Operation interrupted. |
| 302 | Cannot open AttachedFile. |

### 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](#psmtplocalhost-property) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | RemotePort cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the 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. |