POP Component

Properties   Methods   Events   Config Settings   Errors  

The POP Component is used to easily retrieve electronic mail from internet post office servers (POP).

Syntax

IPWorks.Pop

Remarks

The POP Component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2595). When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The POP Component implements a standard internet post office (POP3) client as specified in RFC 1725.

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 headers are received by calling the Retrieve method.

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 body of the message is also saved in the file specified by the LocalFile property. 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).

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

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

Syntax

public int getAuthMechanism();


public void setAuthMechanism(int authMechanism);

Enumerated values:
  public final static int amUserPassword = 0;

  public final static int amCRAMMD5 = 1;

  public final static int amNTLM = 2;

  public final static int amAPOP = 3;

  public final static int amSASLPlain = 4;

  public final static int amSASLDigestMD5 = 5;

  public final static int amKerberos = 6;

  public final static int amXOAUTH2 = 7;

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

This shows whether the component is connected.

Syntax

public boolean isConnected();


public void setConnected(boolean connected);

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.

Firewall Property (POP Component)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();


public void setFirewall(Firewall firewall);

Remarks

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

Idle Property (POP Component)

The current status of the component.

Syntax

public boolean isIdle();

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.

IncludeHeaders Property (POP Component)

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

Syntax

public boolean isIncludeHeaders();


public void setIncludeHeaders(boolean includeHeaders);

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.

LastReply Property (POP Component)

The last reply from the server.

Syntax

public String getLastReply();

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.

LocalFile Property (POP Component)

This property includes the path to a local file to download the message body. If the file exists, it is overwritten (optional).

Syntax

public String getLocalFile();


public void setLocalFile(String localFile);

Default Value

""

Remarks

This property is used when retrieving a message. If this property is empty, then the received data are provided through the parameters of the Transfer event.

LocalHost Property (POP Component)

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

Syntax

public String getLocalHost();


public void setLocalHost(String localHost);

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

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

Syntax

public int getMailPort();


public void setMailPort(int mailPort);

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

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

Syntax

public String getMailServer();


public void setMailServer(String mailServer);

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

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

Syntax

public int getMaxLines();


public void setMaxLines(int maxLines);

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

This property provides the raw message content.

Syntax

public byte[] getMessage();

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

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

Syntax

public String getMessageCc();

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

This property includes the number of messages in the mailbox.

Syntax

public int getMessageCount();

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

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

Syntax

public String getMessageDate();

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

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

Syntax

public String getMessageFrom();

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

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

Syntax

public HeaderList getMessageHeaders();

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

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

Syntax

public String getMessageHeadersString();

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

This property includes the current (selected) message.

Syntax

public int getMessageNumber();


public void setMessageNumber(int messageNumber);

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

MessageRecipients Property (POP Component)

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

Syntax

public MessageRecipientList getMessageRecipients();

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

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

MessageReplyTo Property (POP Component)

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

Syntax

public String getMessageReplyTo();

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

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

Syntax

public String getMessageSubject();

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

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

Syntax

public String getMessageText();

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

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

Syntax

public String getMessageTo();

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

This property includes the password for the mailbox user.

Syntax

public String getPassword();


public void setPassword(String password);

Default Value

""

Remarks

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

SSLAcceptServerCert Property (POP Component)

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

Syntax

public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

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

The certificate to be used during SSL negotiation.

Syntax

public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

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

Whether TLS/SSL is enabled.

Syntax

public boolean isSSLEnabled();


public void setSSLEnabled(boolean SSLEnabled);

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

This specifies the SSL/TLS implementation to use.

Syntax

public int getSSLProvider();


public void setSSLProvider(int SSLProvider);

Enumerated values:
  public final static int sslpAutomatic = 0;

  public final static int sslpPlatform = 1;

  public final static int sslpInternal = 2;

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 the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

SSLServerCert Property (POP Component)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

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

Determines how the component starts the SSL negotiation.

Syntax

public int getSSLStartMode();


public void setSSLStartMode(int SSLStartMode);

Enumerated values:
  public final static int sslAutomatic = 0;

  public final static int sslImplicit = 1;

  public final static int sslExplicit = 2;

  public final static int sslNone = 3;

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Timeout Property (POP Component)

A timeout for the component.

Syntax

public int getTimeout();


public void setTimeout(int timeout);

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

This property includes the user identifier for the mailbox.

Syntax

public String getUser();


public void setUser(String user);

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

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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

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

Syntax

public void connect();

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

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

Delete Method (Pop Component)

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

Syntax

public void delete();

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

This method disconnects from the mail server.

Syntax

public void disconnect();

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

Processes events from the internal message queue.

Syntax

public void doEvents();

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

Interrupt the current method.

Syntax

public void interrupt();

Remarks

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

ListMessageSizes Method (Pop Component)

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

Syntax

public void listMessageSizes();

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

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

Syntax

public void listMessageUIDs();

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

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

Syntax

public String localizeDate(String dateTime);

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

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

Syntax

public long queryMessageSize();

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

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

Syntax

public String queryMessageUID();

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

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

Syntax

public long queryTotalSize();

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

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

Syntax

public void reset();

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

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

Syntax

public void retrieve();

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

This method retrieves headers for a message specified by MessageNumber .

Syntax

public void retrieveHeaders();

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

Sends the exact command directly to the server.

Syntax

public void sendCommand(String command);

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 and/or monitor the PITrail event to obtain the server's response.

SetMessageStream Method (Pop Component)

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

Syntax

public void setMessageStream(java.io.OutputStream messageStream);

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.

ConnectionStatus Event (Pop Component)

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

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void connectionStatus(PopConnectionStatusEvent e) {}
  ...
}

public class PopConnectionStatusEvent {
  public String connectionEvent;

  public int statusCode;

  public String description;

}

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

This event is fired when the message completes transferring.

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void endTransfer(PopEndTransferEvent e) {}
  ...
}

public class PopEndTransferEvent {
  public int direction;

}

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

Fired when information is available about errors during data delivery.

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void error(PopErrorEvent e) {}
  ...
}

public class PopErrorEvent {
  public int errorCode;

  public String description;

}

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

This event is fired for every message header being retrieved.

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void header(PopHeaderEvent e) {}
  ...
}

public class PopHeaderEvent {
  public String field;

  public String value;

}

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

MessageList Event (Pop Component)

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

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void messageList(PopMessageListEvent e) {}
  ...
}

public class PopMessageListEvent {
  public int messageNumber;

  public String messageUID;

  public int messageSize;

}

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

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

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void PITrail(PopPITrailEvent e) {}
  ...
}

public class PopPITrailEvent {
  public int direction;

  public String message;

}

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:

SSLServerAuthentication Event (Pop Component)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void SSLServerAuthentication(PopSSLServerAuthenticationEvent e) {}
  ...
}

public class PopSSLServerAuthenticationEvent {
  public byte[] certEncoded;

  public String certSubject;

  public String certIssuer;

  public String status;

  public boolean accept;

}

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

Fired when secure connection progress messages are available.

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void SSLStatus(PopSSLStatusEvent e) {}
  ...
}

public class PopSSLStatusEvent {
  public String message;

}

Remarks

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

StartTransfer Event (Pop Component)

This event is fired when the message starts transferring.

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void startTransfer(PopStartTransferEvent e) {}
  ...
}

public class PopStartTransferEvent {
  public int direction;

}

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.

Transfer Event (Pop Component)

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

Syntax

public class DefaultPopEventListener implements PopEventListener {
  ...
  public void transfer(PopTransferEvent e) {}
  ...
}

public class PopTransferEvent {
  public int direction;

  public long bytesTransferred;

  public int percentDone;

  public byte[] text;

  public boolean EOL;

}

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

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.

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

public Certificate();

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

public Certificate( certificateFile);

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

public Certificate( certificateData);

Parses CertificateData as an X.509 public key.

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

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 X.509 certificate's subject Distinguished Name (DN).

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

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 CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to 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 X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

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 X.509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

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 X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

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 X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

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 X.509 certificate and search the opened store for a corresponding private key.

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

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

public Header();

public Header( field,  value);

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

public MessageRecipient();

public MessageRecipient( address);

public MessageRecipient( address,  recipientType);

Config Settings (Pop Component)

POP 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 (Pop Component)

POP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors