PSMTP Component

Properties   Methods   Events   Config Settings   Errors  

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 struct by calling the Encrypt, Sign, and SignAndEncrypt methods. Additionally, it enables you to create messages bound for multiple recipients with different keys, simultaneously encrypt and compress with the most popular compression algorithms, and control other aspects such as the encrypting algorithm to use.

Construct the Message

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

Sign

To sign a message specify a recipient key using the Key* properties. For instance: PSMTP1.KeyCount = 1 PSMTP1.KeyKeyring(0) = "c:\my_keyring_dir" PSMTP1.KeyUserId(0) = "sender@nsoftware.com" PSMTP1.KeyPassphrase(0) = "password" The specified private key will be used to sign the message when Sign is called.

Encrypt

To both sign and encrypt a message call SignAndEncrypt.

To encrypt a message specify a recipient key using the RecipientKey* properties. For instance: PSMTP1.RecipientKeyCount = 1 PSMTP1.RecipientKeyKeyring(0) = "c:\my_keyring_dir" PSMTP1.RecipientKeyUserId(0) = "recipient@nsoftware.com" The specified public key will be used to encrypt the message when Encrypt is called.

Sign and Encrypt

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

Send

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

Property List

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

Method List

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

Event List

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

Config Settings

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

AllowExtensions Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) AllowExtensions() (bool, error)
func (obj *PSMTP) SetAllowExtensions(value bool) error

Default Value

true

Remarks

This property is a switch allowing the struct to use ESMTP features (Extended SMTP). If this property is True, the struct 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 does not support SMTP extensions.

Data Type

bool

AuthMechanism Property (PSMTP Component)

This property is used when connecting to the mail server.

Syntax

func (obj *PSMTP) AuthMechanism() (int32, error)
func (obj *PSMTP) SetAuthMechanism(value int32) error

Possible Values

0   // UserPassword
1   // CRAMMD5
2   // NTLM
3   // APOP
4   // SASLPlain
5   // SASLDigestMD5
6   // Kerberos
7   // XOAUTH2

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 and Password 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 to the username and AuthorizationIdentity to the OAuth token. See AuthorizationIdentity for details.

Data Type

int32

BCc Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) BCc() (string, error)
func (obj *PSMTP) SetBCc(value string) error

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 struct will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in this property.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

NOTE: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Data Type

string

Cc Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) Cc() (string, error)
func (obj *PSMTP) SetCc(value string) error

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

The struct will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in BCc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

NOTE: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Data Type

string

CompressionMethod Property (PSMTP Component)

The compression algorithm used.

Syntax

func (obj *PSMTP) CompressionMethod() (string, error)
func (obj *PSMTP) SetCompressionMethod(value string) error

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

Data Type

string

Connected Property (PSMTP Component)

Whether the class is connected.

Syntax

func (obj *PSMTP) Connected() (bool, error)

Default Value

false

Remarks

This property is used to determine whether or not the struct is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only.

Data Type

bool

DeliveryNotificationTo Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) DeliveryNotificationTo() (string, error)
func (obj *PSMTP) SetDeliveryNotificationTo(value string) error

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.

Data Type

string

EncryptingAlgorithm Property (PSMTP Component)

The encryption algorithm used when encrypting.

Syntax

func (obj *PSMTP) EncryptingAlgorithm() (string, error)
func (obj *PSMTP) SetEncryptingAlgorithm(value string) error

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 struct uses a modified form of CFB mode in accordance with the OpenPGP standard.

Note that if UseArgon2 is enabled, and SymmetricPassphrase is specified, an AEAD encryption algorithm (AES*-OCB and AES*-GCM) must be specified for symmetric encryption. If 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). In this case, the AEADChunkSizeExp configuration will specify the chunk size for splitting plaintext for encryption. Please see AEADChunkSizeExp for additional details.

Data Type

string

FirewallAutoDetect Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) FirewallAutoDetect() (bool, error)
func (obj *PSMTP) SetFirewallAutoDetect(value bool) error

Default Value

false

Remarks

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

Data Type

bool

FirewallType Property (PSMTP Component)

The type of firewall to connect through.

Syntax

func (obj *PSMTP) FirewallType() (int32, error)
func (obj *PSMTP) SetFirewallType(value int32) error

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

int32

FirewallHost Property (PSMTP Component)

The name or IP address of the firewall (optional).

Syntax

func (obj *PSMTP) FirewallHost() (string, error)
func (obj *PSMTP) SetFirewallHost(value string) error

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

string

FirewallPassword Property (PSMTP Component)

A password if authentication is to be used when connecting through the firewall.

Syntax

func (obj *PSMTP) FirewallPassword() (string, error)
func (obj *PSMTP) SetFirewallPassword(value string) error

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

string

FirewallPort Property (PSMTP Component)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

func (obj *PSMTP) FirewallPort() (int32, error)
func (obj *PSMTP) SetFirewallPort(value int32) error

Default Value

0

Remarks

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

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

Data Type

int32

FirewallUser Property (PSMTP Component)

A username if authentication is to be used when connecting through a firewall.

Syntax

func (obj *PSMTP) FirewallUser() (string, error)
func (obj *PSMTP) SetFirewallUser(value string) error

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

string

From Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) From() (string, error)
func (obj *PSMTP) SetFrom(value string) error

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, then it is folded according to RFC 822 specifications.

Data Type

string

Idle Property (PSMTP Component)

The current status of the class.

Syntax

func (obj *PSMTP) Idle() (bool, error)

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.

Data Type

bool

Importance Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) Importance() (int32, error)
func (obj *PSMTP) SetImportance(value int32) error

Possible Values

0   // Unspecified
1   // High
2   // Normal
3   // Low

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

Data Type

int32

KeyCount Property (PSMTP Component)

The number of records in the Key arrays.

Syntax

func (obj *PSMTP) KeyCount() (int32, error)
func (obj *PSMTP) SetKeyCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyCurve
• KeyEffectiveDate
• KeyEncoded
• KeyExpirationDate
• KeyFingerprint
• KeyId
• KeyOtherUserIds
• KeyPassphrase
• KeyPublicKey
• KeyPublicKeyAlgorithm
• KeyPublicKeyLength
• KeyRevoked
• Keyring
• KeySecretKey
• KeySecretKeyAvailable
• KeyUsage
• KeyUsageFlags
• KeyUserId
• KeyVersion

The array indices start at 0 and end at KeyCount - 1.

Data Type

int32

KeyCurve Property (PSMTP Component)

This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 .

Syntax

func (obj *PSMTP) KeyCurve(KeyIndex int32) (string, error)

Default Value

""

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyEffectiveDate Property (PSMTP Component)

The date when this key becomes valid.

Syntax

func (obj *PSMTP) KeyEffectiveDate(KeyIndex int32) (string, error)

Default Value

""

Remarks

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.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyExpirationDate Property (PSMTP Component)

The date the key expires.

Syntax

func (obj *PSMTP) KeyExpirationDate(KeyIndex int32) (string, error)

Default Value

""

Remarks

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.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

Keyring Property (PSMTP Component)

The location of the keyring.

Syntax

func (obj *PSMTP) Keyring(KeyIndex int32) (string, error)
func (obj *PSMTP) SetKeyring(KeyIndex int32, value string) error

Default Value

""

Remarks

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This property is set the struct will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyOtherUserIds Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) KeyOtherUserIds(KeyIndex int32) (string, error)

Default Value

""

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyPassphrase Property (PSMTP Component)

The passphrase for the key's secret key (if any).

Syntax

func (obj *PSMTP) KeyPassphrase(KeyIndex int32) (string, error)
func (obj *PSMTP) SetKeyPassphrase(KeyIndex int32, value string) error

Default Value

""

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyPublicKey Property (PSMTP Component)

The public key of the key.

Syntax

func (obj *PSMTP) KeyPublicKey(KeyIndex int32) (string, error)

Default Value

""

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyPublicKeyAlgorithm Property (PSMTP Component)

A text description of the public key algorithm of the key.

Syntax

func (obj *PSMTP) KeyPublicKeyAlgorithm(KeyIndex int32) (string, error)

Default Value

""

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyPublicKeyLength Property (PSMTP Component)

The length of the public key in bits.

Syntax

func (obj *PSMTP) KeyPublicKeyLength(KeyIndex int32) (int32, error)

Default Value

0

Remarks

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

If the KeyPublicKeyAlgorithm 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 KeyCurve. Possible lengths are:

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

int32

KeyRevoked Property (PSMTP Component)

Whether or not the key is revoked.

Syntax

func (obj *PSMTP) KeyRevoked(KeyIndex int32) (bool, error)

Default Value

false

Remarks

Whether or not the key is revoked.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

KeySecretKey Property (PSMTP Component)

The secret key of the key (if available).

Syntax

func (obj *PSMTP) KeySecretKey(KeyIndex int32) (string, error)

Default Value

""

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeySecretKeyAvailable Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) KeySecretKeyAvailable(KeyIndex int32) (bool, error)

Default Value

false

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

KeyUsage Property (PSMTP Component)

A text description of UsageFlags .

Syntax

func (obj *PSMTP) KeyUsage(KeyIndex int32) (string, error)

Default Value

""

Remarks

A text description of KeyUsageFlags.

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

string

KeyUsageFlags Property (PSMTP Component)

Flags that show the intended use for the key.

Syntax

func (obj *PSMTP) KeyUsageFlags(KeyIndex int32) (int32, error)

Default Value

47

Remarks

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

Please refer to the KeyUsage property for a text representation of KeyUsageFlags.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

int32

KeyVersion Property (PSMTP Component)

This property can be used to query the OpenPGP version of the currently selected Key .

Syntax

func (obj *PSMTP) KeyVersion(KeyIndex int32) (int32, error)

Default Value

4

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

int32

KeyUserId Property (PSMTP Component)

The user Id of the key.

Syntax

func (obj *PSMTP) KeyUserId(KeyIndex int32) (string, error)
func (obj *PSMTP) SetKeyUserId(KeyIndex int32, value string) error

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the struct will search the Keyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

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 struct 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 struct's RecipientInfo event.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyId Property (PSMTP Component)

The hex-encoded, 4-byte or 8-byte key Id.

Syntax

func (obj *PSMTP) KeyId(KeyIndex int32) (string, error)
func (obj *PSMTP) SetKeyId(KeyIndex int32, value string) error

Default Value

""

Remarks

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:

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 Keyring. When this property is set the struct will search the Keyring 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 KeyFingerprint property when loading a key from the Keyring, as it is possible for different keys to have the same Id.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyFingerprint Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) KeyFingerprint(KeyIndex int32) (string, error)
func (obj *PSMTP) SetKeyFingerprint(KeyIndex int32, value string) error

Default Value

""

Remarks

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 Keyring. When this property is set the struct will search the Keyring for a key associated with the Fingerprint specified.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

string

KeyEncoded Property (PSMTP Component)

The key.

Syntax

func (obj *PSMTP) KeyEncoded(KeyIndex int32) ([]byte, error)
func (obj *PSMTP) SetKeyEncoded(KeyIndex int32, value []byte) error

Default Value

""

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

[]byte

LastReply Property (PSMTP Component)

This property indicates the last reply received from the server.

Syntax

func (obj *PSMTP) LastReply() (string, error)

Default Value

""

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.

This property is read-only.

Data Type

string

LocalHost Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) LocalHost() (string, error)
func (obj *PSMTP) SetLocalHost(value string) error

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 struct initiate connections (or accept in the case of server structs) 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 struct is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

string

MailPort Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) MailPort() (int32, error)
func (obj *PSMTP) SetMailPort(value int32) error

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 property for more information).

Data Type

int32

MailServer Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) MailServer() (string, error)
func (obj *PSMTP) SetMailServer(value string) error

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 struct 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 struct is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

string

Message Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) Message() ([]byte, error)
func (obj *PSMTP) SetMessage(value []byte) error

Default Value

""

Remarks

This property may be set instead of MessageText. This value will not be modified in any way by the struct 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.

Data Type

[]byte

MessageDate Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) MessageDate() (string, error)
func (obj *PSMTP) SetMessageDate(value string) error

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 is computed and the message is sent. This is the default behavior of the struct

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".

Data Type

string

MessageHeaderCount Property (PSMTP Component)

The number of records in the MessageHeader arrays.

Syntax

func (obj *PSMTP) MessageHeaderCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageHeaderField
• MessageHeaderValue

The array indices start at 0 and end at MessageHeaderCount - 1.

This property is read-only.

Data Type

int32

MessageHeaderField Property (PSMTP Component)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

func (obj *PSMTP) MessageHeaderField(MessageHeaderIndex int32) (string, error)

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is read-only.

Data Type

string

MessageHeaderValue Property (PSMTP Component)

This property contains the header contents.

Syntax

func (obj *PSMTP) MessageHeaderValue(MessageHeaderIndex int32) (string, error)

Default Value

""

Remarks

This property contains the Header contents.

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is read-only.

Data Type

string

MessageHeadersString Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) MessageHeadersString() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

MessageId Property (PSMTP Component)

This property includes the message identifier for the message.

Syntax

func (obj *PSMTP) MessageId() (string, error)
func (obj *PSMTP) SetMessageId(value string) error

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.

Data Type

string

MessageRecipientCount Property (PSMTP Component)

The number of records in the MessageRecipient arrays.

Syntax

func (obj *PSMTP) MessageRecipientCount() (int32, error)
func (obj *PSMTP) SetMessageRecipientCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageRecipientAddress
• MessageRecipientName
• MessageRecipientOptions
• MessageRecipientType

The array indices start at 0 and end at MessageRecipientCount - 1.

Data Type

int32

MessageRecipientAddress Property (PSMTP Component)

This property contains the email address of the recipient.

Syntax

func (obj *PSMTP) MessageRecipientAddress(RecipientIndex int32) (string, error)
func (obj *PSMTP) SetMessageRecipientAddress(RecipientIndex int32, value string) error

Default Value

""

Remarks

This property contains the email address of the recipient.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

Data Type

string

MessageRecipientName Property (PSMTP Component)

This property contains the name of the recipient.

Syntax

func (obj *PSMTP) MessageRecipientName(RecipientIndex int32) (string, error)
func (obj *PSMTP) SetMessageRecipientName(RecipientIndex int32, value string) error

Default Value

""

Remarks

This property contains the name of the recipient.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

Data Type

string

MessageRecipientOptions Property (PSMTP Component)

This property contains the recipient sending options (used only by SMTP).

Syntax

func (obj *PSMTP) MessageRecipientOptions(RecipientIndex int32) (string, error)
func (obj *PSMTP) SetMessageRecipientOptions(RecipientIndex int32, value string) error

Default Value

""

Remarks

This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).

One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.

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

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

Data Type

string

MessageRecipientType Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) MessageRecipientType(RecipientIndex int32) (int32, error)
func (obj *PSMTP) SetMessageRecipientType(RecipientIndex int32, value int32) error

Possible Values

0   // To
1   // Cc
2   // BCc

Default Value

0

Remarks

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

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

Data Type

int32

MessageText Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) MessageText() (string, error)
func (obj *PSMTP) SetMessageText(value string) error

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 CRLF ("\r\n") . 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 struct 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.

Data Type

string

OAuthAccessToken Property (PSMTP Component)

The access token returned by the authorization server.

Syntax

func (obj *PSMTP) OAuthAccessToken() (string, error)
func (obj *PSMTP) SetOAuthAccessToken(value string) error

Default Value

""

Remarks

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

Data Type

string

OAuthAuthorizationScope Property (PSMTP Component)

The scope request or response parameter used during authorization.

Syntax

func (obj *PSMTP) OAuthAuthorizationScope() (string, error)
func (obj *PSMTP) SetOAuthAuthorizationScope(value string) error

Default Value

""

Remarks

The scope request or response parameter used during authorization.

Data Type

string

OAuthClientId Property (PSMTP Component)

The id of the client assigned when registering the application.

Syntax

func (obj *PSMTP) OAuthClientId() (string, error)
func (obj *PSMTP) SetOAuthClientId(value string) error

Default Value

""

Remarks

The id of the client assigned when registering the application.

Data Type

string

OAuthClientSecret Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) OAuthClientSecret() (string, error)
func (obj *PSMTP) SetOAuthClientSecret(value string) error

Default Value

""

Remarks

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

Data Type

string

OAuthRefreshToken Property (PSMTP Component)

Specifies the refresh token received from or sent to the authorization server.

Syntax

func (obj *PSMTP) OAuthRefreshToken() (string, error)
func (obj *PSMTP) SetOAuthRefreshToken(value string) error

Default Value

""

Remarks

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.

Data Type

string

OAuthReturnURL Property (PSMTP Component)

The URL where the user (browser) returns after authenticating.

Syntax

func (obj *PSMTP) OAuthReturnURL() (string, error)
func (obj *PSMTP) SetOAuthReturnURL(value string) error

Default Value

""

Remarks

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

Data Type

string

OAuthServerAuthURL Property (PSMTP Component)

The URL of the authorization server.

Syntax

func (obj *PSMTP) OAuthServerAuthURL() (string, error)
func (obj *PSMTP) SetOAuthServerAuthURL(value string) error

Default Value

""

Remarks

The URL of the authorization server.

Data Type

string

OAuthServerTokenURL Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) OAuthServerTokenURL() (string, error)
func (obj *PSMTP) SetOAuthServerTokenURL(value string) error

Default Value

""

Remarks

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

Data Type

string

OtherHeaders Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) OtherHeaders() (string, error)
func (obj *PSMTP) SetOtherHeaders(value string) error

Default Value

""

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like SendTo, Subject, and so on.

The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\r\n") .

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

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();

Data Type

string

Password Property (PSMTP Component)

This property includes a password for logon to the MailServer .

Syntax

func (obj *PSMTP) Password() (string, error)
func (obj *PSMTP) SetPassword(value string) error

Default Value

""

Remarks

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

Data Type

string

Priority Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) Priority() (int32, error)
func (obj *PSMTP) SetPriority(value int32) error

Possible Values

0   // Unspecified
1   // Normal
2   // Urgent
3   // NonUrgent

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.

Data Type

int32

ReadReceiptTo Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) ReadReceiptTo() (string, error)
func (obj *PSMTP) SetReadReceiptTo(value string) error

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.

Data Type

string

RecipientKeyCount Property (PSMTP Component)

The number of records in the RecipientKey arrays.

Syntax

func (obj *PSMTP) RecipientKeyCount() (int32, error)
func (obj *PSMTP) SetRecipientKeyCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientKeyCurve
• RecipientKeyEffectiveDate
• RecipientKeyEncoded
• RecipientKeyExpirationDate
• RecipientKeyFingerprint
• RecipientKeyId
• RecipientKeyKeyring
• RecipientKeyOtherUserIds
• RecipientKeyPassphrase
• RecipientKeyPublicKey
• RecipientKeyPublicKeyAlgorithm
• RecipientKeyPublicKeyLength
• RecipientKeyRevoked
• RecipientKeySecretKey
• RecipientKeySecretKeyAvailable
• RecipientKeyUsage
• RecipientKeyUsageFlags
• RecipientKeyUserId
• RecipientKeyVersion

The array indices start at 0 and end at RecipientKeyCount - 1.

Data Type

int32

RecipientKeyCurve Property (PSMTP Component)

This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 .

Syntax

func (obj *PSMTP) RecipientKeyCurve(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyEffectiveDate Property (PSMTP Component)

The date when this key becomes valid.

Syntax

func (obj *PSMTP) RecipientKeyEffectiveDate(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

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.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyExpirationDate Property (PSMTP Component)

The date the key expires.

Syntax

func (obj *PSMTP) RecipientKeyExpirationDate(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

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.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyKeyring Property (PSMTP Component)

The location of the keyring.

Syntax

func (obj *PSMTP) RecipientKeyKeyring(RecipientKeyIndex int32) (string, error)
func (obj *PSMTP) SetRecipientKeyKeyring(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This property is set the struct will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyOtherUserIds Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) RecipientKeyOtherUserIds(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyPassphrase Property (PSMTP Component)

The passphrase for the key's secret key (if any).

Syntax

func (obj *PSMTP) RecipientKeyPassphrase(RecipientKeyIndex int32) (string, error)
func (obj *PSMTP) SetRecipientKeyPassphrase(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyPublicKey Property (PSMTP Component)

The public key of the key.

Syntax

func (obj *PSMTP) RecipientKeyPublicKey(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyPublicKeyAlgorithm Property (PSMTP Component)

A text description of the public key algorithm of the key.

Syntax

func (obj *PSMTP) RecipientKeyPublicKeyAlgorithm(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyPublicKeyLength Property (PSMTP Component)

The length of the public key in bits.

Syntax

func (obj *PSMTP) RecipientKeyPublicKeyLength(RecipientKeyIndex int32) (int32, error)

Default Value

0

Remarks

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

If the RecipientKeyPublicKeyAlgorithm 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 RecipientKeyCurve. Possible lengths are:

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

int32

RecipientKeyRevoked Property (PSMTP Component)

Whether or not the key is revoked.

Syntax

func (obj *PSMTP) RecipientKeyRevoked(RecipientKeyIndex int32) (bool, error)

Default Value

false

Remarks

Whether or not the key is revoked.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

bool

RecipientKeySecretKey Property (PSMTP Component)

The secret key of the key (if available).

Syntax

func (obj *PSMTP) RecipientKeySecretKey(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeySecretKeyAvailable Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) RecipientKeySecretKeyAvailable(RecipientKeyIndex int32) (bool, error)

Default Value

false

Remarks

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

bool

RecipientKeyUsage Property (PSMTP Component)

A text description of UsageFlags .

Syntax

func (obj *PSMTP) RecipientKeyUsage(RecipientKeyIndex int32) (string, error)

Default Value

""

Remarks

A text description of RecipientKeyUsageFlags.

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

string

RecipientKeyUsageFlags Property (PSMTP Component)

Flags that show the intended use for the key.

Syntax

func (obj *PSMTP) RecipientKeyUsageFlags(RecipientKeyIndex int32) (int32, error)

Default Value

47

Remarks

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

Please refer to the RecipientKeyUsage property for a text representation of RecipientKeyUsageFlags.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

int32

RecipientKeyVersion Property (PSMTP Component)

This property can be used to query the OpenPGP version of the currently selected Key .

Syntax

func (obj *PSMTP) RecipientKeyVersion(RecipientKeyIndex int32) (int32, error)

Default Value

4

Remarks

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is read-only.

Data Type

int32

RecipientKeyUserId Property (PSMTP Component)

The user Id of the key.

Syntax

func (obj *PSMTP) RecipientKeyUserId(RecipientKeyIndex int32) (string, error)
func (obj *PSMTP) SetRecipientKeyUserId(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the RecipientKeyKeyring. When this property is set the struct will search the RecipientKeyKeyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

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 struct 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 struct's RecipientInfo event.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyId Property (PSMTP Component)

The hex-encoded, 4-byte or 8-byte key Id.

Syntax

func (obj *PSMTP) RecipientKeyId(RecipientKeyIndex int32) (string, error)
func (obj *PSMTP) SetRecipientKeyId(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

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:

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 RecipientKeyKeyring. When this property is set the struct will search the RecipientKeyKeyring 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 RecipientKeyFingerprint property when loading a key from the RecipientKeyKeyring, as it is possible for different keys to have the same Id.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyFingerprint Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) RecipientKeyFingerprint(RecipientKeyIndex int32) (string, error)
func (obj *PSMTP) SetRecipientKeyFingerprint(RecipientKeyIndex int32, value string) error

Default Value

""

Remarks

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 RecipientKeyKeyring. When this property is set the struct will search the RecipientKeyKeyring for a key associated with the Fingerprint specified.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

string

RecipientKeyEncoded Property (PSMTP Component)

The key.

Syntax

func (obj *PSMTP) RecipientKeyEncoded(RecipientKeyIndex int32) ([]byte, error)
func (obj *PSMTP) SetRecipientKeyEncoded(RecipientKeyIndex int32, value []byte) error

Default Value

""

Remarks

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

Data Type

[]byte

ReplyTo Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) ReplyTo() (string, error)
func (obj *PSMTP) SetReplyTo(value string) error

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.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Data Type

string

ReturnPath Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) ReturnPath() (string, error)
func (obj *PSMTP) SetReturnPath(value string) error

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 property is used.

Data Type

string

SendTo Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SendTo() (string, error)
func (obj *PSMTP) SetSendTo(value string) error

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 struct will fail if the MailServer returns an error code about any email address specified in SendTo or Cc but it will silently ignore the error if the same thing happens with an email address specified in BCc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

NOTE: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Data Type

string

Sensitivity Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) Sensitivity() (int32, error)
func (obj *PSMTP) SetSensitivity(value int32) error

Possible Values

0   // Unspecified
1   // Personal
2   // Private
3   // CompanyConfidential

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

Data Type

int32

SigningAlgorithm Property (PSMTP Component)

The signature hash algorithm used when signing.

Syntax

func (obj *PSMTP) SigningAlgorithm() (string, error)
func (obj *PSMTP) SetSigningAlgorithm(value string) error

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

Data Type

string

SSLAcceptServerCertEffectiveDate Property (PSMTP Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PSMTP) SSLAcceptServerCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSLAcceptServerCertExpirationDate Property (PSMTP Component)

The date on which the certificate expires.

Syntax

func (obj *PSMTP) SSLAcceptServerCertExpirationDate() (string, error)

Default Value

""

Remarks

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.

This property is read-only.

Data Type

string

SSLAcceptServerCertExtendedKeyUsage Property (PSMTP Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PSMTP) SSLAcceptServerCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertFingerprint Property (PSMTP Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSLAcceptServerCertFingerprintSHA1 Property (PSMTP Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSLAcceptServerCertFingerprintSHA256 Property (PSMTP Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSLAcceptServerCertIssuer Property (PSMTP Component)

The issuer of the certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertIssuer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertPrivateKey Property (PSMTP Component)

The private key of the certificate (if available).

Syntax

func (obj *PSMTP) SSLAcceptServerCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SSLAcceptServerCertPrivateKeyAvailable Property (PSMTP Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SSLAcceptServerCertPrivateKeyContainer Property (PSMTP Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *PSMTP) SSLAcceptServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKey Property (PSMTP Component)

The public key of the certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertPublicKey() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKeyAlgorithm Property (PSMTP Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *PSMTP) SSLAcceptServerCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKeyLength Property (PSMTP Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *PSMTP) SSLAcceptServerCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

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

This property is read-only.

Data Type

int32

SSLAcceptServerCertSerialNumber Property (PSMTP Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PSMTP) SSLAcceptServerCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSLAcceptServerCertSignatureAlgorithm Property (PSMTP Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PSMTP) SSLAcceptServerCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLAcceptServerCertStore Property (PSMTP Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertStore() ([]byte, error)
func (obj *PSMTP) SetSSLAcceptServerCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSLAcceptServerCertStorePassword Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SSLAcceptServerCertStorePassword() (string, error)
func (obj *PSMTP) SetSSLAcceptServerCertStorePassword(value string) error

Default Value

""

Remarks

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

Data Type

string

SSLAcceptServerCertStoreType Property (PSMTP Component)

The type of certificate store for this certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertStoreType() (int32, error)
func (obj *PSMTP) SetSSLAcceptServerCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

int32

SSLAcceptServerCertSubjectAltNames Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SSLAcceptServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintMD5 Property (PSMTP Component)

The MD5 hash of the certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintSHA1 Property (PSMTP Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintSHA256 Property (PSMTP Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLAcceptServerCertUsage Property (PSMTP Component)

The text description of UsageFlags .

Syntax

func (obj *PSMTP) SSLAcceptServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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.

This property is read-only.

Data Type

string

SSLAcceptServerCertUsageFlags Property (PSMTP Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PSMTP) SSLAcceptServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

int32

SSLAcceptServerCertVersion Property (PSMTP Component)

The certificate's version number.

Syntax

func (obj *PSMTP) SSLAcceptServerCertVersion() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertSubject Property (PSMTP Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PSMTP) SSLAcceptServerCertSubject() (string, error)
func (obj *PSMTP) SetSSLAcceptServerCertSubject(value string) error

Default Value

""

Remarks

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:

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

Data Type

string

SSLAcceptServerCertEncoded Property (PSMTP Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PSMTP) SSLAcceptServerCertEncoded() ([]byte, error)
func (obj *PSMTP) SetSSLAcceptServerCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

SSLCertEffectiveDate Property (PSMTP Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PSMTP) SSLCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSLCertExpirationDate Property (PSMTP Component)

The date on which the certificate expires.

Syntax

func (obj *PSMTP) SSLCertExpirationDate() (string, error)

Default Value

""

Remarks

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.

This property is read-only.

Data Type

string

SSLCertExtendedKeyUsage Property (PSMTP Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PSMTP) SSLCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertFingerprint Property (PSMTP Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *PSMTP) SSLCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSLCertFingerprintSHA1 Property (PSMTP Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *PSMTP) SSLCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSLCertFingerprintSHA256 Property (PSMTP Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *PSMTP) SSLCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSLCertIssuer Property (PSMTP Component)

The issuer of the certificate.

Syntax

func (obj *PSMTP) SSLCertIssuer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertPrivateKey Property (PSMTP Component)

The private key of the certificate (if available).

Syntax

func (obj *PSMTP) SSLCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SSLCertPrivateKeyAvailable Property (PSMTP Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PSMTP) SSLCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SSLCertPrivateKeyContainer Property (PSMTP Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *PSMTP) SSLCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertPublicKey Property (PSMTP Component)

The public key of the certificate.

Syntax

func (obj *PSMTP) SSLCertPublicKey() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertPublicKeyAlgorithm Property (PSMTP Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *PSMTP) SSLCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLCertPublicKeyLength Property (PSMTP Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *PSMTP) SSLCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

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

This property is read-only.

Data Type

int32

SSLCertSerialNumber Property (PSMTP Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PSMTP) SSLCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSLCertSignatureAlgorithm Property (PSMTP Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PSMTP) SSLCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLCertStore Property (PSMTP Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PSMTP) SSLCertStore() ([]byte, error)
func (obj *PSMTP) SetSSLCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSLCertStorePassword Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SSLCertStorePassword() (string, error)
func (obj *PSMTP) SetSSLCertStorePassword(value string) error

Default Value

""

Remarks

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

Data Type

string

SSLCertStoreType Property (PSMTP Component)

The type of certificate store for this certificate.

Syntax

func (obj *PSMTP) SSLCertStoreType() (int32, error)
func (obj *PSMTP) SetSSLCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

int32

SSLCertSubjectAltNames Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SSLCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertThumbprintMD5 Property (PSMTP Component)

The MD5 hash of the certificate.

Syntax

func (obj *PSMTP) SSLCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLCertThumbprintSHA1 Property (PSMTP Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PSMTP) SSLCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLCertThumbprintSHA256 Property (PSMTP Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PSMTP) SSLCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLCertUsage Property (PSMTP Component)

The text description of UsageFlags .

Syntax

func (obj *PSMTP) SSLCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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.

This property is read-only.

Data Type

string

SSLCertUsageFlags Property (PSMTP Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PSMTP) SSLCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

int32

SSLCertVersion Property (PSMTP Component)

The certificate's version number.

Syntax

func (obj *PSMTP) SSLCertVersion() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertSubject Property (PSMTP Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PSMTP) SSLCertSubject() (string, error)
func (obj *PSMTP) SetSSLCertSubject(value string) error

Default Value

""

Remarks

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:

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

Data Type

string

SSLCertEncoded Property (PSMTP Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PSMTP) SSLCertEncoded() ([]byte, error)
func (obj *PSMTP) SetSSLCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

SSLEnabled Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SSLEnabled() (bool, error)
func (obj *PSMTP) SetSSLEnabled(value bool) error

Default Value

false

Remarks

This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

Data Type

bool

SSLProvider Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SSLProvider() (int32, error)
func (obj *PSMTP) SetSSLProvider(value int32) error

Possible Values

0   // Automatic
1   // Platform
2   // Internal

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 struct 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:

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

int32

SSLServerCertEffectiveDate Property (PSMTP Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PSMTP) SSLServerCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSLServerCertExpirationDate Property (PSMTP Component)

The date on which the certificate expires.

Syntax

func (obj *PSMTP) SSLServerCertExpirationDate() (string, error)

Default Value

""

Remarks

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.

This property is read-only.

Data Type

string

SSLServerCertExtendedKeyUsage Property (PSMTP Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PSMTP) SSLServerCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertFingerprint Property (PSMTP Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *PSMTP) SSLServerCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSLServerCertFingerprintSHA1 Property (PSMTP Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *PSMTP) SSLServerCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSLServerCertFingerprintSHA256 Property (PSMTP Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *PSMTP) SSLServerCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSLServerCertIssuer Property (PSMTP Component)

The issuer of the certificate.

Syntax

func (obj *PSMTP) SSLServerCertIssuer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertPrivateKey Property (PSMTP Component)

The private key of the certificate (if available).

Syntax

func (obj *PSMTP) SSLServerCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SSLServerCertPrivateKeyAvailable Property (PSMTP Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PSMTP) SSLServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SSLServerCertPrivateKeyContainer Property (PSMTP Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *PSMTP) SSLServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertPublicKey Property (PSMTP Component)

The public key of the certificate.

Syntax

func (obj *PSMTP) SSLServerCertPublicKey() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertPublicKeyAlgorithm Property (PSMTP Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *PSMTP) SSLServerCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLServerCertPublicKeyLength Property (PSMTP Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *PSMTP) SSLServerCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

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

This property is read-only.

Data Type

int32

SSLServerCertSerialNumber Property (PSMTP Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PSMTP) SSLServerCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSLServerCertSignatureAlgorithm Property (PSMTP Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PSMTP) SSLServerCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLServerCertStore Property (PSMTP Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PSMTP) SSLServerCertStore() ([]byte, error)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

[]byte

SSLServerCertStorePassword Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SSLServerCertStorePassword() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertStoreType Property (PSMTP Component)

The type of certificate store for this certificate.

Syntax

func (obj *PSMTP) SSLServerCertStoreType() (int32, error)

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

int32

SSLServerCertSubjectAltNames Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SSLServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertThumbprintMD5 Property (PSMTP Component)

The MD5 hash of the certificate.

Syntax

func (obj *PSMTP) SSLServerCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLServerCertThumbprintSHA1 Property (PSMTP Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PSMTP) SSLServerCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLServerCertThumbprintSHA256 Property (PSMTP Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PSMTP) SSLServerCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLServerCertUsage Property (PSMTP Component)

The text description of UsageFlags .

Syntax

func (obj *PSMTP) SSLServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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.

This property is read-only.

Data Type

string

SSLServerCertUsageFlags Property (PSMTP Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PSMTP) SSLServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

int32

SSLServerCertVersion Property (PSMTP Component)

The certificate's version number.

Syntax

func (obj *PSMTP) SSLServerCertVersion() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertSubject Property (PSMTP Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PSMTP) SSLServerCertSubject() (string, error)

Default Value

""

Remarks

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:

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

This property is read-only.

Data Type

string

SSLServerCertEncoded Property (PSMTP Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PSMTP) SSLServerCertEncoded() ([]byte, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

[]byte

SSLStartMode Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) SSLStartMode() (int32, error)
func (obj *PSMTP) SetSSLStartMode(value int32) error

Possible Values

0   // Automatic
1   // Implicit
2   // Explicit
3   // None

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

int32

Subject Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) Subject() (string, error)
func (obj *PSMTP) SetSubject(value string) error

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, then it is folded according to RFC 822 specifications.

Data Type

string

Timeout Property (PSMTP Component)

The timeout for the class.

Syntax

func (obj *PSMTP) Timeout() (int32, error)
func (obj *PSMTP) SetTimeout(value int32) error

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 struct will wait for the operation to complete before returning control.

The struct will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

int32

User Property (PSMTP Component)

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

Syntax

func (obj *PSMTP) User() (string, error)
func (obj *PSMTP) SetUser(value string) error

Default Value

""

Remarks

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

Data Type

string

Config Method (PSMTP Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *PSMTP) Config(ConfigurationString string) (string, error)

Remarks

Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (PSMTP Component)

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

Syntax

func (obj *PSMTP) Connect() error

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

Example. Connecting and Sending an Email:

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()

Disconnect Method (PSMTP Component)

This method disconnects from the SMTP server.

Syntax

func (obj *PSMTP) Disconnect() error

Remarks

This method disconnects from the mail relay.

DoEvents Method (PSMTP Component)

This method processes events from the internal message queue.

Syntax

func (obj *PSMTP) DoEvents() error

Remarks

When DoEvents is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Encrypt Method (PSMTP Component)

Encrypts the message.

Syntax

func (obj *PSMTP) Encrypt() error

Remarks

This method encrypts the specified message.

The message is encrypted with the public keys specified in RecipientKeys.

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

• CompressionMethod
• EncryptingAlgorithm

Expand Method (PSMTP Component)

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

Syntax

func (obj *PSMTP) Expand(EmailAddress string) error

Remarks

This method asks the MailServer to expand a name or mailing list. The resulting response is provided in one or more Expand events (one for each address). The struct will try to connect to the mail relay if it is not already connected.

Interrupt Method (PSMTP Component)

This method interrupts the current method.

Syntax

func (obj *PSMTP) Interrupt() error

Remarks

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

ProcessQueue Method (PSMTP Component)

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

Syntax

func (obj *PSMTP) ProcessQueue(QueueDir string) error

Remarks

This method sends the messages that previously have been queued into QueueDir. The PITrail 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 configuration setting is set to True, in which case the file extension is instead changed to ".sent" and the queue file is not deleted.

Queue Method (PSMTP Component)

This method queues the message into QueueDir .

Syntax

func (obj *PSMTP) Queue(QueueDir string) (string, error)

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 method for more information on email queue processing.

ResetHeaders Method (PSMTP Component)

This method resets all the message headers to empty.

Syntax

func (obj *PSMTP) ResetHeaders() error

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.

Send Method (PSMTP Component)

This method sends the current message.

Syntax

func (obj *PSMTP) Send() error

Remarks

This method sends the current message. If the struct 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 struct is already connected (by use of the Connect method), the connection will remain open after the message is sent. To disconnect, call the Disconnect method.

Example. Send an Email:

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()

SendCommand Method (PSMTP Component)

This method sends the exact command directly to the server.

Syntax

func (obj *PSMTP) SendCommand(Command string) error

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method, check the LastReply property or monitor the PITrail event to obtain the server's response.

SendToTerminalAndEmail Method (PSMTP Component)

This method sends to terminal and email.

Syntax

func (obj *PSMTP) SendToTerminalAndEmail() error

Remarks

This method is similar to Send 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 is set to True and is not supported by all mail relays.

SendToTerminalOnly Method (PSMTP Component)

This method sends to terminal only.

Syntax

func (obj *PSMTP) SendToTerminalOnly() error

Remarks

This method is similar to Send but requests instead that the message is sent to the user's terminal. An error code with the server's response is returned if the user is not logged in or does not accept terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

SendToTerminalOrEmail Method (PSMTP Component)

This method sends to terminal or email.

Syntax

func (obj *PSMTP) SendToTerminalOrEmail() error

Remarks

This method is similar to Send 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 is set to True and is not supported by all mail relays.

Sign Method (PSMTP Component)

Signs the message.

Syntax

func (obj *PSMTP) Sign() error

Remarks

This method signs the specified message.

The message is signed with the private key specified in Keys.

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

• ClearSignature
• SigningAlgorithm

SignAndEncrypt Method (PSMTP Component)

Signs and encrypts the current message.

Syntax

func (obj *PSMTP) SignAndEncrypt() error

Remarks

This method signs and encrypts the specified message.

The message is encrypted with the public keys specified in RecipientKeys and signed with the private key specified in Keys.

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

• CompressionMethod
• EncryptingAlgorithm

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

• ClearSignature
• SigningAlgorithm

Verify Method (PSMTP Component)

This method sends a verification request to the SMTP server.

Syntax

func (obj *PSMTP) Verify(EmailAddress string) error

Remarks

This method asks the MailServer to verify the email address provided in the 'EmailAddress' parameter.

ConnectionStatus Event (PSMTP Component)

Fired to indicate changes in the connection state.

Syntax

// PSMTPConnectionStatusEventArgs carries the PSMTP ConnectionStatus event's parameters.
type PSMTPConnectionStatusEventArgs struct {...}

func (args *PSMTPConnectionStatusEventArgs) ConnectionEvent() string
func (args *PSMTPConnectionStatusEventArgs) StatusCode() int32
func (args *PSMTPConnectionStatusEventArgs) Description() string
// PSMTPConnectionStatusEvent defines the signature of the PSMTP ConnectionStatus event's handler function.
type PSMTPConnectionStatusEvent func(sender *PSMTP, args *PSMTPConnectionStatusEventArgs)

func (obj *PSMTP) GetOnConnectionStatusHandler() PSMTPConnectionStatusEvent
func (obj *PSMTP) SetOnConnectionStatusHandler(handlerFunc PSMTPConnectionStatusEvent)

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:

EndTransfer Event (PSMTP Component)

This event is fired when the message text completes transferring.

Syntax

// PSMTPEndTransferEventArgs carries the PSMTP EndTransfer event's parameters.
type PSMTPEndTransferEventArgs struct {...}

func (args *PSMTPEndTransferEventArgs) Direction() int32
// PSMTPEndTransferEvent defines the signature of the PSMTP EndTransfer event's handler function.
type PSMTPEndTransferEvent func(sender *PSMTP, args *PSMTPEndTransferEventArgs)

func (obj *PSMTP) GetOnEndTransferHandler() PSMTPEndTransferEvent
func (obj *PSMTP) SetOnEndTransferHandler(handlerFunc PSMTPEndTransferEvent)

Remarks

If MessageText is not empty, the EndTransfer event is fired when the MessageText finishes transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.

If a file is attached to the MessageText 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.

Error Event (PSMTP Component)

Fired when information is available about errors during data delivery.

Syntax

// PSMTPErrorEventArgs carries the PSMTP Error event's parameters.
type PSMTPErrorEventArgs struct {...}

func (args *PSMTPErrorEventArgs) ErrorCode() int32
func (args *PSMTPErrorEventArgs) Description() string
// PSMTPErrorEvent defines the signature of the PSMTP Error event's handler function.
type PSMTPErrorEvent func(sender *PSMTP, args *PSMTPErrorEventArgs)

func (obj *PSMTP) GetOnErrorHandler() PSMTPErrorEvent
func (obj *PSMTP) SetOnErrorHandler(handlerFunc PSMTPErrorEvent)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Expand Event (PSMTP Component)

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

Syntax

// PSMTPExpandEventArgs carries the PSMTP Expand event's parameters.
type PSMTPExpandEventArgs struct {...}

func (args *PSMTPExpandEventArgs) Address() string
// PSMTPExpandEvent defines the signature of the PSMTP Expand event's handler function.
type PSMTPExpandEvent func(sender *PSMTP, args *PSMTPExpandEventArgs)

func (obj *PSMTP) GetOnExpandHandler() PSMTPExpandEvent
func (obj *PSMTP) SetOnExpandHandler(handlerFunc PSMTPExpandEvent)

Remarks

This event is fired for every email address as returned by the mail server when the Expand 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.

KeyPassphrase Event (PSMTP Component)

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

Syntax

// PSMTPKeyPassphraseEventArgs carries the PSMTP KeyPassphrase event's parameters.
type PSMTPKeyPassphraseEventArgs struct {...}

func (args *PSMTPKeyPassphraseEventArgs) UserId() string
func (args *PSMTPKeyPassphraseEventArgs) KeyId() string
func (args *PSMTPKeyPassphraseEventArgs) Fingerprint() string
func (args *PSMTPKeyPassphraseEventArgs) Passphrase() string
func (args *PSMTPKeyPassphraseEventArgs) SetPassphrase(value string)

// PSMTPKeyPassphraseEvent defines the signature of the PSMTP KeyPassphrase event's handler function.
type PSMTPKeyPassphraseEvent func(sender *PSMTP, args *PSMTPKeyPassphraseEventArgs)

func (obj *PSMTP) GetOnKeyPassphraseHandler() PSMTPKeyPassphraseEvent
func (obj *PSMTP) SetOnKeyPassphraseHandler(handlerFunc PSMTPKeyPassphraseEvent)

Remarks

This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the KeyPassphrase property before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

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

The UserId format is:

FirstName LastName (Comment) <Email>

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:

5E70662EA810E768

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

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

LaunchBrowser Event (PSMTP Component)

Fires before launching a browser with the authorization URL.

Syntax

// PSMTPLaunchBrowserEventArgs carries the PSMTP LaunchBrowser event's parameters.
type PSMTPLaunchBrowserEventArgs struct {...}

func (args *PSMTPLaunchBrowserEventArgs) URL() string
func (args *PSMTPLaunchBrowserEventArgs) SetURL(value string)

func (args *PSMTPLaunchBrowserEventArgs) Command() string
func (args *PSMTPLaunchBrowserEventArgs) SetCommand(value string)

// PSMTPLaunchBrowserEvent defines the signature of the PSMTP LaunchBrowser event's handler function.
type PSMTPLaunchBrowserEvent func(sender *PSMTP, args *PSMTPLaunchBrowserEventArgs)

func (obj *PSMTP) GetOnLaunchBrowserHandler() PSMTPLaunchBrowserEvent
func (obj *PSMTP) SetOnLaunchBrowserHandler(handlerFunc PSMTPLaunchBrowserEvent)

Remarks

When the ClientProfile property is set to ocpApplication and GetAuthorization is called, the struct will fire this event with the Command, which will be executed by the struct. 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 struct 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

Log Event (PSMTP Component)

Fired once for each log message.

Syntax

// PSMTPLogEventArgs carries the PSMTP Log event's parameters.
type PSMTPLogEventArgs struct {...}

func (args *PSMTPLogEventArgs) LogLevel() int32
func (args *PSMTPLogEventArgs) Message() string
func (args *PSMTPLogEventArgs) LogType() string
// PSMTPLogEvent defines the signature of the PSMTP Log event's handler function.
type PSMTPLogEvent func(sender *PSMTP, args *PSMTPLogEventArgs)

func (obj *PSMTP) GetOnLogHandler() PSMTPLogEvent
func (obj *PSMTP) SetOnLogHandler(handlerFunc PSMTPLogEvent)

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

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

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"

PITrail Event (PSMTP Component)

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

Syntax

// PSMTPPITrailEventArgs carries the PSMTP PITrail event's parameters.
type PSMTPPITrailEventArgs struct {...}

func (args *PSMTPPITrailEventArgs) Direction() int32
func (args *PSMTPPITrailEventArgs) Message() string
// PSMTPPITrailEvent defines the signature of the PSMTP PITrail event's handler function.
type PSMTPPITrailEvent func(sender *PSMTP, args *PSMTPPITrailEventArgs)

func (obj *PSMTP) GetOnPITrailHandler() PSMTPPITrailEvent
func (obj *PSMTP) SetOnPITrailHandler(handlerFunc PSMTPPITrailEvent)

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:

Progress Event (PSMTP Component)

Fired as progress is made.

Syntax

// PSMTPProgressEventArgs carries the PSMTP Progress event's parameters.
type PSMTPProgressEventArgs struct {...}

func (args *PSMTPProgressEventArgs) BytesProcessed() int64
func (args *PSMTPProgressEventArgs) PercentProcessed() int32
// PSMTPProgressEvent defines the signature of the PSMTP Progress event's handler function.
type PSMTPProgressEvent func(sender *PSMTP, args *PSMTPProgressEventArgs)

func (obj *PSMTP) GetOnProgressHandler() PSMTPProgressEvent
func (obj *PSMTP) SetOnProgressHandler(handlerFunc PSMTPProgressEvent)

Remarks

This event is fired automatically as data is processed by the struct.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

SSLServerAuthentication Event (PSMTP Component)

Fired after the server presents its certificate to the client.

Syntax

// PSMTPSSLServerAuthenticationEventArgs carries the PSMTP SSLServerAuthentication event's parameters.
type PSMTPSSLServerAuthenticationEventArgs struct {...}

func (args *PSMTPSSLServerAuthenticationEventArgs) CertEncoded() []byte
func (args *PSMTPSSLServerAuthenticationEventArgs) CertSubject() string
func (args *PSMTPSSLServerAuthenticationEventArgs) CertIssuer() string
func (args *PSMTPSSLServerAuthenticationEventArgs) Status() string
func (args *PSMTPSSLServerAuthenticationEventArgs) Accept() bool
func (args *PSMTPSSLServerAuthenticationEventArgs) SetAccept(value bool)

// PSMTPSSLServerAuthenticationEvent defines the signature of the PSMTP SSLServerAuthentication event's handler function.
type PSMTPSSLServerAuthenticationEvent func(sender *PSMTP, args *PSMTPSSLServerAuthenticationEventArgs)

func (obj *PSMTP) GetOnSSLServerAuthenticationHandler() PSMTPSSLServerAuthenticationEvent
func (obj *PSMTP) SetOnSSLServerAuthenticationHandler(handlerFunc PSMTPSSLServerAuthenticationEvent)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (PSMTP Component)

Fired when secure connection progress messages are available.

Syntax

// PSMTPSSLStatusEventArgs carries the PSMTP SSLStatus event's parameters.
type PSMTPSSLStatusEventArgs struct {...}

func (args *PSMTPSSLStatusEventArgs) Message() string
// PSMTPSSLStatusEvent defines the signature of the PSMTP SSLStatus event's handler function.
type PSMTPSSLStatusEvent func(sender *PSMTP, args *PSMTPSSLStatusEventArgs)

func (obj *PSMTP) GetOnSSLStatusHandler() PSMTPSSLStatusEvent
func (obj *PSMTP) SetOnSSLStatusHandler(handlerFunc PSMTPSSLStatusEvent)

Remarks

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

StartTransfer Event (PSMTP Component)

This event is fired when the message text starts transferring.

Syntax

// PSMTPStartTransferEventArgs carries the PSMTP StartTransfer event's parameters.
type PSMTPStartTransferEventArgs struct {...}

func (args *PSMTPStartTransferEventArgs) Direction() int32
// PSMTPStartTransferEvent defines the signature of the PSMTP StartTransfer event's handler function.
type PSMTPStartTransferEvent func(sender *PSMTP, args *PSMTPStartTransferEventArgs)

func (obj *PSMTP) GetOnStartTransferHandler() PSMTPStartTransferEvent
func (obj *PSMTP) SetOnStartTransferHandler(handlerFunc PSMTPStartTransferEvent)

Remarks

If MessageText is not empty, the StartTransfer event is fired when the MessageText starts transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.

If a file is attached to the MessageText 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.

Status Event (PSMTP Component)

Shows the progress of the operation.

Syntax

// PSMTPStatusEventArgs carries the PSMTP Status event's parameters.
type PSMTPStatusEventArgs struct {...}

func (args *PSMTPStatusEventArgs) Message() string
// PSMTPStatusEvent defines the signature of the PSMTP Status event's handler function.
type PSMTPStatusEvent func(sender *PSMTP, args *PSMTPStatusEventArgs)

func (obj *PSMTP) GetOnStatusHandler() PSMTPStatusEvent
func (obj *PSMTP) SetOnStatusHandler(handlerFunc PSMTPStatusEvent)

Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the LogLevel setting.

Transfer Event (PSMTP Component)

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

Syntax

// PSMTPTransferEventArgs carries the PSMTP Transfer event's parameters.
type PSMTPTransferEventArgs struct {...}

func (args *PSMTPTransferEventArgs) Direction() int32
func (args *PSMTPTransferEventArgs) BytesTransferred() int64
func (args *PSMTPTransferEventArgs) PercentDone() int32
func (args *PSMTPTransferEventArgs) Text() []byte
// PSMTPTransferEvent defines the signature of the PSMTP Transfer event's handler function.
type PSMTPTransferEvent func(sender *PSMTP, args *PSMTPTransferEventArgs)

func (obj *PSMTP) GetOnTransferHandler() PSMTPTransferEvent
func (obj *PSMTP) SetOnTransferHandler(handlerFunc PSMTPTransferEvent)

Remarks

One or more Transfer events are fired during message delivery. Messages consist of MessageText and an optional AttachedFile. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of MessageText 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.

Config Settings (PSMTP Component)

PSMTP Config Settings

SMTP Config Settings

TCPClient Config Settings

SSL Config Settings

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