PPOP Component

Properties   Methods   Events   Config Settings   Errors  

The PPOP component is used retrieve and process OpenPGP encrypted and/or signed messages from Internet Post Office servers (POP).

Syntax

nsoftware.IPWorksOpenPGP.PPOP

Remarks

The PPOP component implements a standard internet post office (POP3) client, as specified in RFC 1725, and supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. You can send an OpenPGP signed and encrypted message using the PSMTP component by calling the Encrypt, Sign, and SignAndEncrypt methods.

Connect to the Server

To connect to a MailServer, first set the appropriate User and Password and then connect by calling the Connect method. Upon successful connection to the MailServer, the number of waiting messages is shown by the MessageCount property. A message is selected by setting the MessageNumber property to a number between 1 and MessageCount (inclusive). Then, the message text and/or headers are received by calling the Retrieve method.

Receive Messages

The message text is received through the Transfer event, whereas the message headers are received through the Header event. Additionally, up to MaxLines from the message body are provided in the MessageText property. The StartTransfer and EndTransfer events are fired at the beginning and end of message transmission. The PITrail event provides a trace of the interaction between the client and server (excluding message transfers).

Verify

To verify the signature of a message specify the public key to be used for signature verification by adding a key to SignerKeys. For instance: ppop.Keys.Add(new Key("c:\\my_keyring_dir", "sender@nsoftware.com")); The specified public key will be used to verify the signature when calling VerifySignature.

Decrypt

To process an encrypted or signed message first retrieve the message text and headers by calling Retrieve. To decrypt a message specify the private key to be used for decryption by adding a key to Key. For instance: ppop.Keys.Add(new Key("c:\\my_keyring_dir", "recipient@nsoftware.com")); ppop.Keys[0].Passphrase = "password"; The specified private key will be used to decrypt the message when calling Decrypt.

Decrypt and Verify

To decrypt and verify in one step, you can call DecryptAndVerifySignature. Set the public key of the sender in the Key property and the private key to be used for decryption in .

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.

AuthMechanism Property (PPOP Component)

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

Syntax

• C#
• VB.NET

public PPOPAuthMechanisms AuthMechanism { get; set; }

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

Public Property AuthMechanism As PpopAuthMechanisms

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

Default Value

0

Remarks

This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to log in to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication.

amSASLPlain (4) is also available, but most servers require a Secure Sockets Layer (SSL) connection when utilizing this authentication mechanism.

amKerberos (6) is for Kerberos authentication. Note: This functionality is available only in Windows.

Connected Property (PPOP Component)

Whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; }

Public ReadOnly 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. Use the Connect and Disconnect methods to manage the connection.

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

Firewall Property (PPOP 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.

Idle Property (PPOP 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

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.

IncludeHeaders Property (PPOP Component)

This property instructs the component to include the headers in the MessageText and LocalFile.

Syntax

• C#
• VB.NET

public bool IncludeHeaders { get; set; }

Public Property IncludeHeaders As Boolean

Default Value

False

Remarks

This property instructs the component to include the headers in the MessageText and LocalFile. If set to True, the headers for the message being retrieved will be placed before the message body in the MessageText property;. If LocalFile is set, then the headers will be written to that file before the message body. In this manner, the whole content of a MIME-encoded message can be passed to the MIME component for further message processing.

Keys Property (PPOP 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 (PPOP Component)

This property indicates the last reply received 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 also can be retrieved through the PITrail event.

This property is read-only.

LocalHost Property (PPOP 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

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 component initiate connections (or accept in the case of server components) 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 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 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.

MailPort Property (PPOP Component)

This property includes the server port for POP (default 110).

Syntax

• C#
• VB.NET

public int MailPort { get; set; }

Public Property MailPort As Integer

Default Value

110

Remarks

This property contains the server port for POP (default 110). 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 Secure Sockets Layer (SSL), use port 995 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

MailServer Property (PPOP Component)

This property includes the name or address of a mail server (internet post office server).

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 the domain name of the mail server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

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

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.

MaxLines Property (PPOP Component)

This property includes the maximum number of message lines other than headers to retrieve.

Syntax

• C#
• VB.NET

public int MaxLines { get; set; }

Public Property MaxLines As Integer

Default Value

0

Remarks

This property is used to limit the number of text lines other than headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message.

The default value of the property is 0. In this case, the entire message will be retrieved, without interruptions.

Message Property (PPOP Component)

This property provides the raw message content.

Syntax

• C#
• VB.NET

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

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

Default Value

""

Remarks

This property is populated after calling Retrieve and holds the raw message content. This can be used to access the data before any processing is done by the component.

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

MessageCc Property (PPOP Component)

This property includes the value of the CC header of the last retrieved message.

Syntax

• C#
• VB.NET

public string MessageCc { get; }

Public ReadOnly Property MessageCc As String

Default Value

""

Remarks

This property contains the value of the CC header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

MessageCount Property (PPOP Component)

This property includes the number of messages in the mailbox.

Syntax

• C#
• VB.NET

public int MessageCount { get; }

Public ReadOnly Property MessageCount As Integer

Default Value

0

Remarks

This property contains the number of messages in the mailbox. When the component is not connected to the server, the value of this property is 0. When connected, it contains the number of messages in the mailbox as reported by the POP server.

This property is read-only.

MessageDate Property (PPOP Component)

This property includes the value of the date header of the last retrieved message.

Syntax

• C#
• VB.NET

public string MessageDate { get; }

Public ReadOnly Property MessageDate As String

Default Value

""

Remarks

This property contains the value of the date header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

MessageFrom Property (PPOP Component)

This property includes the value of the from header of the last retrieved message.

Syntax

• C#
• VB.NET

public string MessageFrom { get; }

Public ReadOnly Property MessageFrom As String

Default Value

""

Remarks

This property contains the value of the from header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

MessageHeaders Property (PPOP Component)

This property includes a collection of the message headers as retrieved from the server.

Syntax

• C#
• VB.NET

public HeaderList MessageHeaders { get; }

Public ReadOnly Property MessageHeaders As HeaderList

Remarks

This property contains a collection of the message headers as retrieved from the server. If the component is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty collection. Otherwise, it contains a parsed collection of the full headers of the mail message as reported by the server.

The MailServer is asked about the headers of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the component returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

This property is read-only.

MessageHeadersString Property (PPOP Component)

This property includes a string representation of the full headers of the message as retrieved from the server.

Syntax

• C#
• VB.NET

public string MessageHeadersString { get; }

Public ReadOnly Property MessageHeadersString As String

Default Value

""

Remarks

This property contains a string representation of the full headers of the message as retrieved from the server. If the component is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the full headers of the mail message as reported by the server.

The MailServer is asked about the headers of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the component returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeadersString = POPControl.MessageHeadersString

This property is read-only.

MessageNumber Property (PPOP Component)

This property includes the current (selected) message.

Syntax

• C#
• VB.NET

public int MessageNumber { get; set; }

Public Property MessageNumber As Integer

Default Value

1

Remarks

This property indicates the current (selected) message. This property specifies a message number in between 1 and MessageCount. The various component methods related to single messages use this property as a message pointer (see method descriptions and the QueryMessageSize method).

MessageRecipients Property (PPOP Component)

This property includes a collection of recipients for the current message.

Syntax

• C#
• VB.NET

public MessageRecipientList MessageRecipients { get; }

Public ReadOnly Property MessageRecipients As MessageRecipientList

Remarks

This property contains a collection of recipients for the current message. This collection describes all of the people to whom the last retrieved message was sent. Each MessageRecipient contains information describing that recipient, and what type of recipient it is.

This collection is indexed from 0 to count -1.

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

MessageReplyTo Property (PPOP Component)

This property includes the value of the Reply-To header of the last retrieved message.

Syntax

• C#
• VB.NET

public string MessageReplyTo { get; }

Public ReadOnly Property MessageReplyTo As String

Default Value

""

Remarks

This property contains the value of the Reply-To header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

MessageSubject Property (PPOP Component)

This property includes the value of the Subject header of the last retrieved message.

Syntax

• C#
• VB.NET

public string MessageSubject { get; }

Public ReadOnly Property MessageSubject As String

Default Value

""

Remarks

This property contains the value of the Subject header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

MessageText Property (PPOP Component)

This property includes the full text of the message as retrieved from the server.

Syntax

• C#
• VB.NET

public string MessageText { get; }

Public ReadOnly Property MessageText As String

Default Value

""

Remarks

This property contains the full text of the message as retrieved from the server. If the component is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the text of the mail message as reported by the server (a maximum of MaxLines).

The MailServer is asked about the text of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the component returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

This property is read-only.

MessageTo Property (PPOP Component)

This property includes the value of the To header of the last retrieved message.

Syntax

• C#
• VB.NET

public string MessageTo { get; }

Public ReadOnly Property MessageTo As String

Default Value

""

Remarks

This property contains the value of the To header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Password Property (PPOP Component)

This property includes the password for the mailbox user.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

This property contains the password for the mailbox user. This property must be set before the component connects to the MailServer.

SignerKeys Property (PPOP Component)

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

Syntax

• C#
• VB.NET

public KeyList SignerKeys { get; }

Public Property SignerKeys As KeyList

Remarks

This property contains the keys of the message signer.

Set this property before calling VerifySignature or DecryptAndVerifySignature.

This property is not available at design time.

SSLAcceptServerCert Property (PPOP 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.

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

SSLCert Property (PPOP Component)

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

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes 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 (PPOP Component)

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

Syntax

• C#
• VB.NET

public bool SSLEnabled { get; set; }

Public Property SSLEnabled As Boolean

Default Value

False

Remarks

This property 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 (PPOP Component)

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

Syntax

• C#
• VB.NET

public PPOPSSLProviders SSLProvider { get; set; }

enum PPOPSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As PpopSSLProviders

Enum PPOPSSLProviders
  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 as follows:

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

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SSLStartMode Property (PPOP Component)

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

Syntax

• C#
• VB.NET

public PPOPSSLStartModes SSLStartMode { get; set; }

enum PPOPSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Public Property SSLStartMode As PpopSSLStartModes

Enum PPOPSSLStartModes
  sslAutomatic
  sslImplicit
  sslExplicit
  sslNone
End Enum

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Timeout Property (PPOP Component)

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

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.

User Property (PPOP Component)

This property includes the user identifier for the mailbox.

Syntax

• C#
• VB.NET

public string User { get; set; }

Public Property User As String

Default Value

""

Remarks

This property contains the user identifier for the mailbox. This property must be set before the component connects to the MailServer.

Config Method (PPOP 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 (PPOP Component)

This method connects to the mail server and attempts to log in.

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 server and attempts to log in using the current User and Password. Then it retrieves the initial statistics about the mailbox contents (MessageCount and QueryTotalSize).

Example. Connect to POP Mailbox:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve() MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

Decrypt Method (PPOP Component)

Decrypts the message.

Syntax

• C#
• VB.NET

public void Decrypt();

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

Public Sub Decrypt()

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

Remarks

This method decrypts the specified message.

The message will be decrypted using the keys specified in Keys. Before decryption begins the component will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

DecryptAndVerifySignature Method (PPOP Component)

Decrypts and verifies the signature of the message.

Syntax

• C#
• VB.NET

public void DecryptAndVerifySignature();

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

Public Sub DecryptAndVerifySignature()

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

Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.

This method may be used when the data is signed, encrypted, or signed and encrypted. For instance, if the data is encrypted but not signed you may still use this method and the component will perform the decryption without error.

The message will be decrypted using the keys specified in Keys. Before decryption begins the component will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

The message will be verified using the keys specified in SignerKeys. Before verification begins the component will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the component throws an exception. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

NOTE: This method does not attempt to check the validity of the signing key itself.

Delete Method (PPOP Component)

This method deletes a message specified by MessageNumber on the server.

Syntax

• C#
• VB.NET

public void Delete();

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

Public Sub Delete()

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

Remarks

This method asks the MailServer to delete the message specified by MessageNumber. The message will not actually be deleted from the server until the connection is closed. To cancel a previous Delete, use the Reset method.

Disconnect Method (PPOP Component)

This method disconnects from the mail 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 makes the component disconnect from the MailServer by sending the QUIT command. If successful, all changes to the mailbox are committed by the server. Otherwise, changes are rolled back to the initial state that the server was in before the connection.

DoEvents Method (PPOP Component)

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

Interrupt Method (PPOP Component)

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

ListMessageSizes Method (PPOP Component)

This method retrieves a list of all message sizes from the server.

Syntax

• C#
• VB.NET

public void ListMessageSizes();

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

Public Sub ListMessageSizes()

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

Remarks

This message retrieves a list of all message sizes from the server. For each message listed, a MessageList event will fire containing the number and size of the message.

ListMessageUIDs Method (PPOP Component)

This method retrieves a list of all message UIDs from the server.

Syntax

• C#
• VB.NET

public void ListMessageUIDs();

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

Public Sub ListMessageUIDs()

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

Remarks

This method retrieves a list of all message UIDs from the server. For each message listed, a MessageList event will fire containing the number and UID of the message.

LocalizeDate Method (PPOP Component)

This method converts a valid RFC 822 message date to a local date and time.

Syntax

• C#
• VB.NET

public string LocalizeDate(string dateTime);

Async Version
public async Task<string> LocalizeDate(string dateTime);
public async Task<string> LocalizeDate(string dateTime, CancellationToken cancellationToken);

Public Function LocalizeDate(ByVal DateTime As String) As String

Async Version
Public Function LocalizeDate(ByVal DateTime As String) As Task(Of String)
Public Function LocalizeDate(ByVal DateTime As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method can be used to convert an RFC 822 date and time string to the corresponding local date and time.

Note: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

QueryMessageSize Method (PPOP Component)

This method returns the size in bytes of the current message.

Syntax

• C#
• VB.NET

public long QueryMessageSize();

Async Version
public async Task<long> QueryMessageSize();
public async Task<long> QueryMessageSize(CancellationToken cancellationToken);

Public Function QueryMessageSize() As Long

Async Version
Public Function QueryMessageSize() As Task(Of Long)
Public Function QueryMessageSize(cancellationToken As CancellationToken) As Task(Of Long)

Remarks

This method queries the server for the size in bytes of the message specified by MessageNumber. The method returns the size (in bytes) of the message.

If the component is not connected, or MessageNumber does not contain a valid message number, the return value is 0. Otherwise, it returns the size of the mail message (including headers) as reported by the server.

The MailServer is asked about the size of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the component returns a cached value.

QueryMessageUID Method (PPOP Component)

This method returns the unique identifier (UID) of the message as specified by the server.

Syntax

• C#
• VB.NET

public string QueryMessageUID();

Async Version
public async Task<string> QueryMessageUID();
public async Task<string> QueryMessageUID(CancellationToken cancellationToken);

Public Function QueryMessageUID() As String

Async Version
Public Function QueryMessageUID() As Task(Of String)
Public Function QueryMessageUID(cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method returns the unique identifier (UID) of the message specified by MessageNumber. If the component is not connected, or MessageNumber does not contain a valid message number, the return value of this method is an empty string. Otherwise, it returns the UID of the mail message as reported by the server.

The MailServer is asked about the UID of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the component returns a cached value.

QueryTotalSize Method (PPOP Component)

This method returns the cumulative size in bytes of messages in the mailbox (including headers).

Syntax

• C#
• VB.NET

public long QueryTotalSize();

Async Version
public async Task<long> QueryTotalSize();
public async Task<long> QueryTotalSize(CancellationToken cancellationToken);

Public Function QueryTotalSize() As Long

Async Version
Public Function QueryTotalSize() As Task(Of Long)
Public Function QueryTotalSize(cancellationToken As CancellationToken) As Task(Of Long)

Remarks

This method returns the cumulative size in bytes of messages in the mailbox (including headers). When the component is not connected to the server, the return value of this method is 0. When connected, it returns the cumulative size of all the messages in the mail box as reported by the POP server.

Reset Method (PPOP Component)

This method resets all changes and revert back to the state when the user first connected.

Syntax

• C#
• VB.NET

public void Reset();

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

Public Sub Reset()

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

Remarks

This method is used to reset all changes and revert back to the state when the user first connected. Asks the MailServer to reset all changes and revert back to the state it was when connected.

Retrieve Method (PPOP Component)

This method retrieves a message specified by MessageNumber from the server.

Syntax

• C#
• VB.NET

public void Retrieve();

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

Public Sub Retrieve()

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

Remarks

This method is used to retrieve a message specified by MessageNumber from the server. It asks the MailServer to retrieve the message specified by MessageNumber. The message headers will arrive in the Header event, and the message text will arrive in the Transfer event.

The MaxLines property defines the number of lines retrieved.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve()

RetrieveHeaders Method (PPOP Component)

This method retrieves headers for a message specified by MessageNumber .

Syntax

• C#
• VB.NET

public void RetrieveHeaders();

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

Public Sub RetrieveHeaders()

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

Remarks

Calling this method will retrieve the headers for the message specified by the MessageNumber property. The message headers will be provided by the Header event and also stored in the MessageHeaders property.

Example. Connect and Retrieve Message Headers:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.RetrieveHeaders()

SendCommand Method (PPOP Component)

This method sends the exact command directly to the server.

Syntax

• C#
• VB.NET

public void SendCommand(string command);

Async Version
public async Task SendCommand(string command);
public async Task SendCommand(string command, CancellationToken cancellationToken);

Public Sub SendCommand(ByVal Command As String)

Async Version
Public Sub SendCommand(ByVal Command As String) As Task
Public Sub SendCommand(ByVal Command As String, cancellationToken As CancellationToken) As Task

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.

SetMessageStream Method (PPOP Component)

This method sets the stream to which the message downloaded from the server will be written.

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 which the message downloaded from the server will be written. If a download stream is set before the Retrieve method is called, the downloaded data will be written to the stream. 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 SetMessageStream again before calling Retrieve again. The downloaded content will be written starting at the current position in the stream.

Note: SetMessageStream and LocalFile will reset the other.

VerifySignature Method (PPOP Component)

Verifies the signature of the current message.

Syntax

• C#
• VB.NET

public void VerifySignature();

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

Public Sub VerifySignature()

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

Remarks

This method verifies the signature of the message.

The message will be verified using the keys specified in SignerKeys. Before verification begins the component will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the component throws an exception. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

ConnectionStatus Event (PPOP Component)

Fired to indicate changes in the connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

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

public class PPOPConnectionStatusEventArgs : 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 PPOPConnectionStatusEventArgs)

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

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

This event is fired when the message completes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

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

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

Public Event OnEndTransfer As OnEndTransferHandler

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

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

Remarks

The EndTransfer event is fired when the message body completes transferring from the server to the local host.

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

Error Event (PPOP Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class PPOPErrorEventArgs 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.

Header Event (PPOP Component)

This event is fired for every message header being retrieved.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, PPOPHeaderEventArgs e);

public class PPOPHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As PPOPHeaderEventArgs)

Public Class PPOPHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

Remarks

The Field parameter contains the name of the header (in the same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

KeyPassphrase Event (PPOP 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, PPOPKeyPassphraseEventArgs e);

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

Public Event OnKeyPassphrase As OnKeyPassphraseHandler

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

Public Class PPOPKeyPassphraseEventArgs Inherits EventArgs
  Public ReadOnly Property UserId As String
  Public ReadOnly Property KeyId As String
  Public ReadOnly Property Fingerprint 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

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 it's 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

MessageList Event (PPOP Component)

This event is fired for every message listed by ListMessageSizes and/or ListMessageUIDs .

Syntax

• C#
• VB.NET

public event OnMessageListHandler OnMessageList;

public delegate void OnMessageListHandler(object sender, PPOPMessageListEventArgs e);

public class PPOPMessageListEventArgs : EventArgs {
  public int MessageNumber { get; }
  public string MessageUID { get; }
  public int MessageSize { get; }
}

Public Event OnMessageList As OnMessageListHandler

Public Delegate Sub OnMessageListHandler(sender As Object, e As PPOPMessageListEventArgs)

Public Class PPOPMessageListEventArgs Inherits EventArgs
  Public ReadOnly Property MessageNumber As Integer
  Public ReadOnly Property MessageUID As String
  Public ReadOnly Property MessageSize As Integer
End Class

Remarks

When ListMessageSizes is called, MessageSize is valid, and MessageUID is always an empty string.

When ListMessageUIDs is called, MessageUID is valid, and MessageSize is 0.

PITrail Event (PPOP Component)

This event 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, PPOPPITrailEventArgs e);

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

Public Event OnPITrail As OnPITrailHandler

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

Public Class PPOPPITrailEventArgs 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 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 (PPOP Component)

Fired as progress is made.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

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

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

Public Event OnProgress As OnProgressHandler

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

Public Class PPOPProgressEventArgs 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.

RecipientInfo Event (PPOP Component)

Fired for each recipient key of the encrypted message.

Syntax

• C#
• VB.NET

public event OnRecipientInfoHandler OnRecipientInfo;

public delegate void OnRecipientInfoHandler(object sender, PPOPRecipientInfoEventArgs e);

public class PPOPRecipientInfoEventArgs : EventArgs {
  public string KeyId { get; }
  public string Fingerprint { get; }
  public string PublicKeyAlgorithm { get; }
}

Public Event OnRecipientInfo As OnRecipientInfoHandler

Public Delegate Sub OnRecipientInfoHandler(sender As Object, e As PPOPRecipientInfoEventArgs)

Public Class PPOPRecipientInfoEventArgs Inherits EventArgs
  Public ReadOnly Property KeyId As String
  Public ReadOnly Property Fingerprint As String
  Public ReadOnly Property PublicKeyAlgorithm As String
End Class

Remarks

This event fires when the Decrypt or DecryptAndVerifySignature method is called.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. 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. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in Keys. Keys can be set from within this event as this event fires directly before the decryption process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

PublicKeyAlgorithm is the algorithm of the public key used to encrypt the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)

SignatureInfo Event (PPOP Component)

Fired during verification of the signed message.

Syntax

• C#
• VB.NET

public event OnSignatureInfoHandler OnSignatureInfo;

public delegate void OnSignatureInfoHandler(object sender, PPOPSignatureInfoEventArgs e);

public class PPOPSignatureInfoEventArgs : EventArgs {
  public string KeyId { get; }
  public string Fingerprint { get; }
  public string SigningAlgorithm { get; }
  public string PublicKeyAlgorithm { get; }
}

Public Event OnSignatureInfo As OnSignatureInfoHandler

Public Delegate Sub OnSignatureInfoHandler(sender As Object, e As PPOPSignatureInfoEventArgs)

Public Class PPOPSignatureInfoEventArgs Inherits EventArgs
  Public ReadOnly Property KeyId As String
  Public ReadOnly Property Fingerprint As String
  Public ReadOnly Property SigningAlgorithm As String
  Public ReadOnly Property PublicKeyAlgorithm As String
End Class

Remarks

This event fires when the VerifySignature or DecryptAndVerifySignature method is called. It provides information about the signature of the message.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. 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. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in SignerKeys. SignerKeys can be set from within this event as this event fires directly before the verification process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

SigningAlgorithm describes the hash algorithm used when the message was originally signed. This value is applicable only to the message signature, not the key used to sign the message. Possible values are:

• SHA1
• MD5
• SHA256
• SHA384
• SHA512
• SHA224
• RIPEMD160
• SHA3-256
• SHA3-512

PublicKeyAlgorithm is the algorithm of the public key used to sign the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)

SSLServerAuthentication Event (PPOP 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, PPOPSSLServerAuthenticationEventArgs e);

public class PPOPSSLServerAuthenticationEventArgs : 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 PPOPSSLServerAuthenticationEventArgs)

Public Class PPOPSSLServerAuthenticationEventArgs 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 (PPOP Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

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

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

Public Event OnSSLStatus As OnSSLStatusHandler

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

Public Class PPOPSSLStatusEventArgs 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 (PPOP Component)

This event is fired when the message starts transferring.

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

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

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

Public Event OnStartTransfer As OnStartTransferHandler

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

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

Remarks

The StartTransfer event is fired when the message body starts transferring from the server to the local host.

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

Status Event (PPOP Component)

Shows the progress of the operation.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

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

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

Public Event OnStatus As OnStatusHandler

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

Public Class PPOPStatusEventArgs 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 (PPOP Component)

This event is fired when the message is transferred from MailServer .

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

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

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

Public Event OnTransfer As OnTransferHandler

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

Public Class PPOPTransferEventArgs 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()
  Public ReadOnly Property EOL As Boolean
End Class

Remarks

The Text parameter contains the portion of the message data to be retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e., when the last Transfer event is fired), BytesTransferred equals the value of the QueryMessageSize method.

The Transfer event is fired for every line of the message. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).

A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event to check the progress rather than to get the actual data.

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.

Note: For the PercentDone parameter value to be correct, the GetMessageSize configuration setting must be set to True.

VerificationStatus Event (PPOP Component)

Fired after verification of the signed message.

Syntax

• C#
• VB.NET

public event OnVerificationStatusHandler OnVerificationStatus;

public delegate void OnVerificationStatusHandler(object sender, PPOPVerificationStatusEventArgs e);

public class PPOPVerificationStatusEventArgs : EventArgs {
  public string KeyId { get; }
  public string Fingerprint { get; }
  public int Status { get; }
}

Public Event OnVerificationStatus As OnVerificationStatusHandler

Public Delegate Sub OnVerificationStatusHandler(sender As Object, e As PPOPVerificationStatusEventArgs)

Public Class PPOPVerificationStatusEventArgs Inherits EventArgs
  Public ReadOnly Property KeyId As String
  Public ReadOnly Property Fingerprint As String
  Public ReadOnly Property Status As Integer
End Class

Remarks

This event fires when VerifySignature or DecryptAndVerifySignature is called. It provides information about the result.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. 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. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

Status holds the result of the operation. Possible values are:

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

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

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

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

• C#
• VB.NET

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

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

• C#
• VB.NET

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

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

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

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

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

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

• C#
• VB.NET

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

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

Firewall Type

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

5E70662EA810E768

FirstName LastName (Comment) <Email>

Constructors

• C#
• VB.NET

public Key(string keyring);

Public Key(ByVal Keyring As String)

• C#
• VB.NET

public Key(byte[] encoded);

Public Key(ByVal Encoded As Byte())

• C#
• VB.NET

public Key(string keyring, string userId);

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

• C#
• VB.NET

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

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

• C#
• VB.NET

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

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

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

PPOP Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (PPOP Component)

POP 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