IP*Works! SSL pops Component : pops OCX, pops .NET Component, pops Class, pops Bean, pops Object

Available in: SSH | SSL

POPS Component [IP*Works! SSL V8]

Properties Methods Events Configuration Settings

The POPS component is used retrieve electronic mail from Internet Post Office servers (POP).

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The POPS component is the SSL-enabled equivalent (RFC 2595) of the IP*Works! POP component. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The SSLProvider configuration setting chooses a security provider subsystem. The SSLEnabledProtocols and SSLCipherStrength configuration settings determine which protocols are enabled and at what security level. The SSLCert property is used to select a client certificate if the server is requesting client authentication. The SSLSecurityFlags configuration setting, together with the SSLServerAuthentication event allow you to check the server identity and other security attributes. Finally, the SSLStatus event provides information about the SSL handshake.

The POPS 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, message text and/or 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.


AuthMechanism	The authentication mechanism to be used when connecting to the mail server.
Command	Can be used to send additional commands directly to the server.
Connected	Shows whether the component is connected.
Firewall	A set of properties related to firewall access.
Idle	The current status of the component.
IncludeHeaders	Instructs the component to include the headers in the MessageText and LocalFile .
LastReply	The last reply from the server.
LocalFile	The path to a local file for downloading the message body. If the file exists, it is overwritten. (optional)
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPort	The server port for POP (default 110).
MailServer	The name or address of a mail server (internet post office server).
MaxLines	The maximum number of message lines besides headers to retrieve.
MessageCc	The value of the Cc header of the last retrieved message.
MessageCount	The number of messages waiting in the mailbox.
MessageDate	The value of the Date: header of the last retrieved message.
MessageFrom	The value of the From header of the last retrieved message.
MessageHeaders	Collection of the message headers as retrieved from the server.
MessageHeadersString	A string representation of the full headers of the message as retrieved from the server.
MessageNumber	Current (selected) message.
MessageRecipients	A collection of recipients for the current message.
MessageReplyTo	The value of the Reply-To header of the last retrieved message.
MessageSize	The size in bytes of the current message.
MessageSubject	The value of the Subject header of the last retrieved message.
MessageText	The full text of the message as retrieved from the server.
MessageTo	The value of the To header of the last retrieved message.
MessageUID	The unique id of the message as specified by the server.
Password	The password for the mailbox user.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during ssl negotiation.
SSLServerCert	The server certificate for the last established connection.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A timeout for the component.
TotalSize	Cumulative size in bytes of messages in the mailbox (including headers).
User	The user id for the mailbox.

Method List

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


Config	Sets or retrieves a configuration setting.
Connect	Connects to the mail server and attempts to login.
Delete	Delete a message specified by MessageNumber on the server.
Disconnect	Disconnects from the mail server.
DoEvents	Processes events from the internal message queue.
Interrupt	Interrupt the current method.
ListMessageSizes	Retrieves a list of all message sizes from the server.
ListMessageUIDs	Retrieves a list of all message UID-s from the server.
LocalizeDate	Converts a valid RFC 822 message date to local date and time.
Reset	Reset all changes and revert back to the state when the user first connected.
Retrieve	Retrieve a message specified by MessageNumber from the server.
RetrieveHeaders	Retrieve headers for a message specified by MessageNumber .
SetMessageStream	Sets the stream to which the message downloaded from the server will be written.

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.


ConnectionStatus	Fired to indicate changes in connection state.
EndTransfer	Fired when the message completes transferring.
Error	Information about errors during data delivery.
Header	Fired for every message header being retrieved.
MessageList	Fired for every message listed by ListMessageSizes and/or ListMessageUIDs .
PITrail	Traces the commands sent to the mail server, and the respective replies.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when the message starts transferring.
Transfer	Fired while the message gets transferred from MailServer .

Configuration Settings

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


GetMessageSize	Whether to poll the server for the message size prior to retrieving it.
IncludeHeaders	Whether to include message headers in the .
MaxLineLength	The maximum expected length for message lines
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
AutoDecodeSubject	Instructs the component to automatically decode message subjects.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
TcpNoDelay	Whether or not to delay when sending packets
AcceptAnyServerCert	If set the component will accept any certificate presented by the server
SSLProvider	The name of the security provider to use.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLSecurityFlags	Flags that control certificate verification
ReuseSSLSession	Determines if the SSL session is reused.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCADir	The path to a directory containing CA certificates.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).