PSMTP Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.IPWorksOpenPGP.Psmtp

Remarks

You can send an OpenPGP signed and encrypted message using the PSMTP component 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 add the sender's private key to Keys. For instance: psmtp.Keys.Add(new Key("c:\\my_keyring_dir", "sender@nsoftware.com")); psmtp.Keys[0].Passphrase = "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 add the recipient's public key to RecipientKeys. For instance: psmtp.RecipientKeys.Add(new Key("c:\\my_keyring_dir", "recipient@nsoftware.com")); The specified public key will be used to encrypt the message when Encrypt is called.

Sign 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 RecipientKeys property and the private key to be used to sign the message in .

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 component to use ESMTP features (Extended SMTP).

Syntax

• C#
• VB.NET

public bool AllowExtensions { get; set; }

Public Property AllowExtensions As Boolean

Default Value

True

Remarks

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

This property is not available at design time.

AuthMechanism Property (PSMTP Component)

This property is used when connecting to the mail server.

Syntax

• C#
• VB.NET

public PsmtpAuthMechanisms AuthMechanism { get; set; }

enum PsmtpAuthMechanisms {
  amUserPassword,
  amCRAMMD5,
  amNTLM,
  amAPOP,
  amSASLPlain,
  amSASLDigestMD5,
  amKerberos,
  amXOAUTH2
}

Public Property AuthMechanism As PsmtpAuthMechanisms

Enum PsmtpAuthMechanisms
  amUserPassword
  amCRAMMD5
  amNTLM
  amAPOP
  amSASLPlain
  amSASLDigestMD5
  amKerberos
  amXOAUTH2
End Enum

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.

BCc Property (PSMTP Component)

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

Syntax

• C#
• VB.NET

public string BCc { get; set; }

Public Property BCc As String

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 component 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 collection before setting this property to remove previous recipients.

Cc Property (PSMTP Component)

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

Syntax

• C#
• VB.NET

public string Cc { get; set; }

Public Property Cc As String

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 component 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 collection before setting this property to remove previous recipients.

Command Property (PSMTP Component)

This property is used to send additional commands directly to the server.

Syntax

• C#
• VB.NET

public string Command { set; }

Public WriteOnly Property Command As String

Default Value

""

Remarks

This property can be used to send additional commands directly to the server. Check the LastReply property or trap the PITrail events coming from the server to get the response.

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

CompressionMethod Property (PSMTP Component)

The compression algorithm used.

Syntax

• C#
• VB.NET

public string CompressionMethod { get; set; }

Public Property CompressionMethod As String

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

Connected Property (PSMTP Component)

This shows whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; set; }

Public Property Connected As Boolean

Default Value

False

Remarks

This property is used to determine whether or not the component is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

DeliveryNotificationTo Property (PSMTP Component)

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

Syntax

• C#
• VB.NET

public string DeliveryNotificationTo { get; set; }

Public Property DeliveryNotificationTo As String

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.

EncryptingAlgorithm Property (PSMTP Component)

The encryption algorithm used when encrypting.

Syntax

• C#
• VB.NET

public string EncryptingAlgorithm { get; set; }

Public Property EncryptingAlgorithm As String

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

Firewall Property (PSMTP Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

From Property (PSMTP Component)

The email address of the sender (required).

Syntax

• C#
• VB.NET

public string From { get; set; }

Public Property From As String

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

Idle Property (PSMTP Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

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

This property is read-only.

Importance Property (PSMTP Component)

Importance of the mail message (optional).

Syntax

• C#
• VB.NET

public PsmtpImportances Importance { get; set; }

enum PsmtpImportances {
  miUnspecified,
  miHigh,
  miNormal,
  miLow
}

Public Property Importance As PsmtpImportances

Enum PsmtpImportances
  miUnspecified
  miHigh
  miNormal
  miLow
End Enum

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 how important the message is. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

Keys Property (PSMTP Component)

A collection of keys used for cryptographic operations.

Syntax

• C#
• VB.NET

public KeyList Keys { get; }

Public Property Keys As KeyList

Remarks

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

This property is not available at design time.

LastReply Property (PSMTP Component)

The last reply from the server.

Syntax

• C#
• VB.NET

public string LastReply { get; }

Public ReadOnly Property LastReply As String

Default Value

""

Remarks

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

This property is read-only.

LocalHost Property (PSMTP Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component 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 multi-homed 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.

MailPort Property (PSMTP Component)

The server port for SMTP (default 25).

Syntax

• C#
• VB.NET

public int MailPort { get; set; }

Public Property MailPort As Integer

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 implicit SSL, use port 465 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

MailServer Property (PSMTP Component)

The name or address of a mail server (mail relay).

Syntax

• C#
• VB.NET

public string MailServer { get; set; }

Public Property MailServer As String

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 component 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 (a UNIX host for example), 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 and 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 component 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.

Message Property (PSMTP Component)

Provides a way to set the raw message content.

Syntax

• C#
• VB.NET

public string Message { get; set; }
public byte[] MessageB { get; set; }

Public Property Message As String
Public Property MessageB As Byte()

Default Value

""

Remarks

This property may be set instead of MessageText. The value set here will not be modified in any way by the component and will be sent as is. Use caution when setting this value as all encoding must be done before supplying the value to the component.

This property is not available at design time.

MessageDate Property (PSMTP Component)

Date of the mail message (optional).

Syntax

• C#
• VB.NET

public string MessageDate { get; set; }

Public Property MessageDate As String

Default Value

"*"

Remarks

If this property contains a non-empty 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 component

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

This property is not available at design time.

MessageHeaders Property (PSMTP Component)

Collection of RFC822-encoded headers of the message.

Syntax

• C#
• VB.NET

public HeaderList MessageHeaders { get; }

Public ReadOnly Property MessageHeaders As HeaderList

Remarks

This property holds the full headers of the message in RFC822 format.

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

MessageHeadersString Property (PSMTP Component)

String representation of RFC822-encoded headers of the message.

Syntax

• C#
• VB.NET

public string MessageHeadersString { get; }

Public ReadOnly Property MessageHeadersString As String

Default Value

""

Remarks

This property holds the full headers of the message in RFC822 format.

This property is read-only.

MessageId Property (PSMTP Component)

The Message Identifier for the message.

Syntax

• C#
• VB.NET

public string MessageId { get; set; }

Public Property MessageId As String

Default Value

"*"

Remarks

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

This property is not available at design time.

MessageRecipients Property (PSMTP Component)

The collection of recipients of the message.

Syntax

• C#
• VB.NET

public MessageRecipientList MessageRecipients { get; }

Public Property MessageRecipients As MessageRecipientList

Remarks

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

This collection is indexed from 0 to count -1.

MessageText Property (PSMTP Component)

The full text of the message to send (without headers).

Syntax

• C#
• VB.NET

public string MessageText { get; set; }

Public Property MessageText As String

Default Value

""

Remarks

This property contains the full text of the message.

It is advisable that the text contained in this property 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 be successfully pass through the multitude of mail systems on the Internet.

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

OtherHeaders Property (PSMTP Component)

An RFC 822 compliant string consisting of extra headers.

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

Default Value

""

Remarks

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

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 component. 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 (Send an Email With 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();

This property is not available at design time.

Password Property (PSMTP Component)

A password for logon to the MailServer .

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

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

This property is not available at design time.

Priority Property (PSMTP Component)

Priority of the mail message (optional).

Syntax

• C#
• VB.NET

public PsmtpPriorities Priority { get; set; }

enum PsmtpPriorities {
  epUnspecified,
  epNormal,
  epUrgent,
  epNonUrgent
}

Public Property Priority As PsmtpPriorities

Enum PsmtpPriorities
  epUnspecified
  epNormal
  epUrgent
  epNonUrgent
End Enum

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.

ReadReceiptTo Property (PSMTP Component)

Email address to send a read receipt to.

Syntax

• C#
• VB.NET

public string ReadReceiptTo { get; set; }

Public Property ReadReceiptTo As String

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 which should receive the read-receipt.

RecipientKeys Property (PSMTP Component)

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

Syntax

• C#
• VB.NET

public KeyList RecipientKeys { get; }

Public Property RecipientKeys As KeyList

Remarks

This property contains the keys of the message recipient.

Set this property before calling Encrypt or SignAndEncrypt.

This property is not available at design time.

ReplyTo Property (PSMTP Component)

A mail address to which to reply (optional).

Syntax

• C#
• VB.NET

public string ReplyTo { get; set; }

Public Property ReplyTo As String

Default Value

""

Remarks

If this property contains a non-empty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies (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.

ReturnPath Property (PSMTP Component)

Sets the Return-Path to be used for sending email.

Syntax

• C#
• VB.NET

public string ReturnPath { get; set; }

Public Property ReturnPath As String

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.

SendTo Property (PSMTP Component)

A comma separated list of addresses for destinations (required).

Syntax

• C#
• VB.NET

public string SendTo { get; set; }

Public Property SendTo As String

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: "Friendly Name" <address@company.com> or address@company.com

The component 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 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 collection before setting this property to remove previous recipients.

Sensitivity Property (PSMTP Component)

Sensitivity of the mail message (optional).

Syntax

• C#
• VB.NET

public PsmtpSensitivities Sensitivity { get; set; }

enum PsmtpSensitivities {
  esUnspecified,
  esPersonal,
  esPrivate,
  esCompanyConfidential
}

Public Property Sensitivity As PsmtpSensitivities

Enum PsmtpSensitivities
  esUnspecified
  esPersonal
  esPrivate
  esCompanyConfidential
End Enum

Default Value

0

Remarks

This property is 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: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

SigningAlgorithm Property (PSMTP Component)

The signature hash algorithm used when signing.

Syntax

• C#
• VB.NET

public string SigningAlgorithm { get; set; }

Public Property SigningAlgorithm As String

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

SSLAcceptServerCert Property (PSMTP Component)

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

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

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

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

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

SSLCert Property (PSMTP Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

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

SSLEnabled Property (PSMTP Component)

Whether TLS/SSL is enabled.

Syntax

• C#
• VB.NET

public bool SSLEnabled { get; set; }

Public Property SSLEnabled As Boolean

Default Value

False

Remarks

This setting specifies whether TLS/SSL is enabled in the component. When False (default) the component 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.

This property is not available at design time.

SSLProvider Property (PSMTP Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public PsmtpSSLProviders SSLProvider { get; set; }

enum PsmtpSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As PsmtpSSLProviders

Enum PsmtpSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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

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

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (PSMTP Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SSLStartMode Property (PSMTP Component)

Determines how the component starts the SSL negotiation.

Syntax

• C#
• VB.NET

public PsmtpSSLStartModes SSLStartMode { get; set; }

enum PsmtpSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Public Property SSLStartMode As PsmtpSSLStartModes

Enum PsmtpSSLStartModes
  sslAutomatic
  sslImplicit
  sslExplicit
  sslNone
End Enum

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Subject Property (PSMTP Component)

The subject of the mail message (optional).

Syntax

• C#
• VB.NET

public string Subject { get; set; }

Public Property Subject As String

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.

Timeout Property (PSMTP Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

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

The component 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 component throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

User Property (PSMTP Component)

A user identifier to login as in the MailServer .

Syntax

• C#
• VB.NET

public string User { get; set; }

Public Property User As String

Default Value

""

Remarks

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

This property is not available at design time.

Config Method (PSMTP Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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

• C#
• VB.NET

public void Connect();

Async Version
public async Task Connect();
public async Task Connect(CancellationToken cancellationToken);

Public Sub Connect()

Async Version
Public Sub Connect() As Task
Public Sub Connect(cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void Disconnect();

Async Version
public async Task Disconnect();
public async Task Disconnect(CancellationToken cancellationToken);

Public Sub Disconnect()

Async Version
Public Sub Disconnect() As Task
Public Sub Disconnect(cancellationToken As CancellationToken) As Task

Remarks

This method disconnects from the mail relay.

DoEvents Method (PSMTP Component)

Processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component 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

• C#
• VB.NET

public void Encrypt();

Async Version
public async Task Encrypt();
public async Task Encrypt(CancellationToken cancellationToken);

Public Sub Encrypt()

Async Version
Public Sub Encrypt() As Task
Public Sub Encrypt(cancellationToken As CancellationToken) As Task

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

• CompressionMethod
• EncryptingAlgorithm

Expand Method (PSMTP Component)

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

Syntax

• C#
• VB.NET

public void Expand(string emailAddress);

Async Version
public async Task Expand(string emailAddress);
public async Task Expand(string emailAddress, CancellationToken cancellationToken);

Public Sub Expand(ByVal EmailAddress As String)

Async Version
Public Sub Expand(ByVal EmailAddress As String) As Task
Public Sub Expand(ByVal EmailAddress As String, cancellationToken As CancellationToken) As Task

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 component will try to connect to the mail relay if it is not already connected.

Interrupt Method (PSMTP Component)

Interrupt the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

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

ProcessQueue Method (PSMTP Component)

Sends the messages which have previously been queued into QueueDir .

Syntax

• C#
• VB.NET

public void ProcessQueue(string queueDir);

Async Version
public async Task ProcessQueue(string queueDir);
public async Task ProcessQueue(string queueDir, CancellationToken cancellationToken);

Public Sub ProcessQueue(ByVal QueueDir As String)

Async Version
Public Sub ProcessQueue(ByVal QueueDir As String) As Task
Public Sub ProcessQueue(ByVal QueueDir As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends the messages which have previously been queued into QueueDir. The PITrail event shows the interaction with the server as messages as are processed.

This method looks in the directory for files with 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)

Queues the message into QueueDir .

Syntax

• C#
• VB.NET

public string Queue(string queueDir);

Async Version
public async Task<string> Queue(string queueDir);
public async Task<string> Queue(string queueDir, CancellationToken cancellationToken);

Public Function Queue(ByVal QueueDir As String) As String

Async Version
Public Function Queue(ByVal QueueDir As String) As Task(Of String)
Public Function Queue(ByVal QueueDir As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

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

Resets all the message headers to empty.

Syntax

• C#
• VB.NET

public void ResetHeaders();

Async Version
public async Task ResetHeaders();
public async Task ResetHeaders(CancellationToken cancellationToken);

Public Sub ResetHeaders()

Async Version
Public Sub ResetHeaders() As Task
Public Sub ResetHeaders(cancellationToken As CancellationToken) As Task

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)

Sends the current message.

Syntax

• C#
• VB.NET

public void Send();

Async Version
public async Task Send();
public async Task Send(CancellationToken cancellationToken);

Public Sub Send()

Async Version
Public Sub Send() As Task
Public Sub Send(cancellationToken As CancellationToken) As Task

Remarks

This method sends the current message. If the component 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 component 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()

SendToTerminalAndEmail Method (PSMTP Component)

Sends to terminal and email.

Syntax

• C#
• VB.NET

public void SendToTerminalAndEmail();

Async Version
public async Task SendToTerminalAndEmail();
public async Task SendToTerminalAndEmail(CancellationToken cancellationToken);

Public Sub SendToTerminalAndEmail()

Async Version
Public Sub SendToTerminalAndEmail() As Task
Public Sub SendToTerminalAndEmail(cancellationToken As CancellationToken) As Task

Remarks

This method is similar to Send but requests also that the message is sent to the terminal of the user as well, if he is logged on and accepts terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

SendToTerminalOnly Method (PSMTP Component)

Sends to terminal only.

Syntax

• C#
• VB.NET

public void SendToTerminalOnly();

Async Version
public async Task SendToTerminalOnly();
public async Task SendToTerminalOnly(CancellationToken cancellationToken);

Public Sub SendToTerminalOnly()

Async Version
Public Sub SendToTerminalOnly() As Task
Public Sub SendToTerminalOnly(cancellationToken As CancellationToken) As Task

Remarks

This method is similar to Send but requests instead that the message is sent to the user's terminal. An exception with the server's response is raised 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)

Sends to terminal or email.

Syntax

• C#
• VB.NET

public void SendToTerminalOrEmail();

Async Version
public async Task SendToTerminalOrEmail();
public async Task SendToTerminalOrEmail(CancellationToken cancellationToken);

Public Sub SendToTerminalOrEmail()

Async Version
Public Sub SendToTerminalOrEmail() As Task
Public Sub SendToTerminalOrEmail(cancellationToken As CancellationToken) As Task

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 mailbox. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

SetMessageStream Method (PSMTP Component)

Sets the stream to be uploaded to the server as part of the message.

Syntax

• C#
• VB.NET

public void SetMessageStream(System.IO.Stream messageStream);

Async Version
public async Task SetMessageStream(System.IO.Stream messageStream);
public async Task SetMessageStream(System.IO.Stream messageStream, CancellationToken cancellationToken);

Public Sub SetMessageStream(ByVal MessageStream As System.IO.Stream)

Async Version
Public Sub SetMessageStream(ByVal MessageStream As System.IO.Stream) As Task
Public Sub SetMessageStream(ByVal MessageStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

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

Note: This method and LocalFile will reset the other.

Sign Method (PSMTP Component)

Signs the message.

Syntax

• C#
• VB.NET

public void Sign();

Async Version
public async Task Sign();
public async Task Sign(CancellationToken cancellationToken);

Public Sub Sign()

Async Version
Public Sub Sign() As Task
Public Sub Sign(cancellationToken As CancellationToken) As Task

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

• ClearSignature
• SigningAlgorithm

SignAndEncrypt Method (PSMTP Component)

Signs and encrypts the current message.

Syntax

• C#
• VB.NET

public void SignAndEncrypt();

Async Version
public async Task SignAndEncrypt();
public async Task SignAndEncrypt(CancellationToken cancellationToken);

Public Sub SignAndEncrypt()

Async Version
Public Sub SignAndEncrypt() As Task
Public Sub SignAndEncrypt(cancellationToken As CancellationToken) As Task

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

• CompressionMethod
• EncryptingAlgorithm

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

• ClearSignature
• SigningAlgorithm

Verify Method (PSMTP Component)

Sends a Verification request to the SMTP server.

Syntax

• C#
• VB.NET

public void Verify(string emailAddress);

Async Version
public async Task Verify(string emailAddress);
public async Task Verify(string emailAddress, CancellationToken cancellationToken);

Public Sub Verify(ByVal EmailAddress As String)

Async Version
Public Sub Verify(ByVal EmailAddress As String) As Task
Public Sub Verify(ByVal EmailAddress As String, cancellationToken As CancellationToken) As Task

Remarks

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

ConnectionStatus Event (PSMTP Component)

This event is fired to indicate changes in the connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, PsmtpConnectionStatusEventArgs e);

public class PsmtpConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As PsmtpConnectionStatusEventArgs)

Public Class PsmtpConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, PsmtpEndTransferEventArgs e);

public class PsmtpEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As PsmtpEndTransferEventArgs)

Public Class PsmtpEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

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)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PsmtpErrorEventArgs e);

public class PsmtpErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As PsmtpErrorEventArgs)

Public Class PsmtpErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

• C#
• VB.NET

public event OnExpandHandler OnExpand;

public delegate void OnExpandHandler(object sender, PsmtpExpandEventArgs e);

public class PsmtpExpandEventArgs : EventArgs {
  public string Address { get; }
}

Public Event OnExpand As OnExpandHandler

Public Delegate Sub OnExpandHandler(sender As Object, e As PsmtpExpandEventArgs)

Public Class PsmtpExpandEventArgs Inherits EventArgs
  Public ReadOnly Property Address As String
End Class

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

• C#
• VB.NET

public event OnKeyPassphraseHandler OnKeyPassphrase;

public delegate void OnKeyPassphraseHandler(object sender, PsmtpKeyPassphraseEventArgs e);

public class PsmtpKeyPassphraseEventArgs : EventArgs {
  public string UserId { get; }
  public string KeyId { get; }
  public string Passphrase { get; set; }
}

Public Event OnKeyPassphrase As OnKeyPassphraseHandler

Public Delegate Sub OnKeyPassphraseHandler(sender As Object, e As PsmtpKeyPassphraseEventArgs)

Public Class PsmtpKeyPassphraseEventArgs Inherits EventArgs
  Public ReadOnly Property UserId As String
  Public ReadOnly Property KeyId As String
  Public Property Passphrase As String
End Class

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 Passphrase field before attempting the operation.

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

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

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

• Decrypt
• Sign
• SignAndEncrypt

PITrail Event (PSMTP Component)

Traces the commands sent to the mail server, and the respective replies.

Syntax

• C#
• VB.NET

public event OnPITrailHandler OnPITrail;

public delegate void OnPITrailHandler(object sender, PsmtpPITrailEventArgs e);

public class PsmtpPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Message { get; }
}

Public Event OnPITrail As OnPITrailHandler

Public Delegate Sub OnPITrailHandler(sender As Object, e As PsmtpPITrailEventArgs)

Public Class PsmtpPITrailEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property Message As String
End Class

Remarks

The PITrail event is useful for debugging purposes. It shows all 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

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, PsmtpProgressEventArgs e);

public class PsmtpProgressEventArgs : EventArgs {
  public long BytesProcessed { get; }
  public int PercentProcessed { get; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As PsmtpProgressEventArgs)

Public Class PsmtpProgressEventArgs Inherits EventArgs
  Public ReadOnly Property BytesProcessed As Long
  Public ReadOnly Property PercentProcessed As Integer
End Class

Remarks

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

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

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, PsmtpSSLServerAuthenticationEventArgs e);

public class PsmtpSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As PsmtpSSLServerAuthenticationEventArgs)

Public Class PsmtpSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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)

Shows the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, PsmtpSSLStatusEventArgs e);

public class PsmtpSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As PsmtpSSLStatusEventArgs)

Public Class PsmtpSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

StartTransfer Event (PSMTP Component)

Fired when the message text starts transferring.

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, PsmtpStartTransferEventArgs e);

public class PsmtpStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As PsmtpStartTransferEventArgs)

Public Class PsmtpStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

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

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, PsmtpStatusEventArgs e);

public class PsmtpStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As PsmtpStatusEventArgs)

Public Class PsmtpStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

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)

Fired while the message text gets transferred to MailServer .

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, PsmtpTransferEventArgs e);

public class PsmtpTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As PsmtpTransferEventArgs)

Public Class PsmtpTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

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 and/or AttachedFile.

Text contains the current portion of the message being sent.

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

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Firewall Type

This is the firewall the component will connect through.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Header Type

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

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

Key Type

The OpenPGP key being used.

Remarks

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

Fields

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

89C9D7B1

FirstName LastName (Comment) <Email>

Constructors

• C#
• VB.NET

public Key(string keyPath);

Public Key(ByVal KeyPath As String)

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

• C#
• VB.NET

public Key(byte[] keyData);

Public Key(ByVal KeyData As Byte())

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

• C#
• VB.NET

public Key(string keyPath, string userId);

Public Key(ByVal KeyPath As String, ByVal UserId As String)

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

• C#
• VB.NET

public Key(string keyPath, string secretKeyringFile, string publicKeyringFile, string userId);

Public Key(ByVal KeyPath As String, ByVal SecretKeyringFile As String, ByVal PublicKeyringFile As String, ByVal UserId As String)

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

• C#
• VB.NET

public Key(byte[] keyData, string userId);

Public Key(ByVal KeyData As Byte(), ByVal UserId As String)

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

MessageRecipient Type

This types describes the message recipient.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public MessageRecipient();

Public MessageRecipient()

• C#
• VB.NET

public MessageRecipient(string address);

Public MessageRecipient(ByVal Address As String)

• C#
• VB.NET

public MessageRecipient(string address, int recipientType);

Public MessageRecipient(ByVal Address As String, ByVal RecipientType As Integer)

Config Settings (PSMTP Component)

PSMTP Config Settings

SMTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (PSMTP Component)

SMTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

SSL Errors

TCP/IP Errors

OpenPGP Errors