IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

POP Control

Properties   Methods   Events   Configuration Settings   Errors  

The POP Component is used to easily retrieve electronic mail from Internet Post Office servers (POP).

Syntax

POP

Remarks

The POP Control 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 control with short descriptions. Click on the links for further details.

AuthMechanismThe authentication mechanism to be used when connecting to the mail server.
CommandUsed to send additional commands directly to the server.
ConnectedShows whether the component is connected.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
IncludeHeadersInstructs the component to include the headers in the MessageText and LocalFile.
LastReplyThe last reply from the server.
LocalFileThe path to a local file for downloading the message body. If the file exists, it is overwritten (optional).
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPortThe server port for POP (default 110).
MailServerThe name or address of a mail server (internet post office server).
MaxLinesThe maximum number of message lines besides headers to retrieve.
MessageProvides the raw message content.
MessageCcThe value of the CC header of the last retrieved message.
MessageCountThe number of messages in the mailbox.
MessageDateThe value of the date header of the last retrieved message.
MessageFromThe value of the from header of the last retrieved message.
MessageHeaderCountThe number of records in the MessageHeader arrays.
MessageHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
MessageHeaderValueThis property contains the header contents.
MessageHeadersStringA string representation of the full headers of the message as retrieved from the server.
MessageNumberCurrent (selected) message.
MessageRecipientCountThe number of records in the MessageRecipient arrays.
MessageRecipientAddressThis property contains the email address of the recipient.
MessageRecipientNameThis property contains name of the recipient.
MessageRecipientOptionsThis property contains the recipient sending options (used only by SMTP).
MessageRecipientTypeThis property contains the recipient type: To, Cc, or BCc.
MessageReplyToThe value of the Reply-To header of the last retrieved message.
MessageSizeThe size in bytes of the current message.
MessageSubjectThe value of the Subject header of the last retrieved message.
MessageTextThe full text of the message as retrieved from the server.
MessageToThe value of the To header of the last retrieved message.
MessageUIDThe unique identifier of the message as specified by the server.
PasswordThe password for the mailbox user.
TimeoutA timeout for the component.
TotalSizeCumulative size in bytes of messages in the mailbox (including headers).
UserThe user identifier for the mailbox.

Method List


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

ConfigSets or retrieves a configuration setting .
ConnectConnects to the mail server and attempts to login.
DeleteDeletes a message specified by MessageNumber on the server.
DisconnectDisconnects from the mail server.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
ListMessageSizesRetrieves a list of all message sizes from the server.
ListMessageUIDsRetrieves a list of all message UIDs from the server.
LocalizeDateConverts a valid RFC 822 message date to local date and time.
ResetResets all changes and revert back to the state when the user first connected.
RetrieveRetrieves a message specified by MessageNumber from the server.
RetrieveHeadersRetrieves headers for a message specified by MessageNumber .

Event List


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

ConnectionStatusFired to indicate changes in connection state.
EndTransferFired when the message completes transferring.
ErrorInformation about errors during data delivery.
HeaderFired for every message header being retrieved.
MessageListFired for every message listed by ListMessageSizes and/or ListMessageUIDs .
PITrailTraces the commands sent to the mail server, and the respective replies.
StartTransferFired when the message starts transferring.
TransferFired while the message gets transferred from MailServer .

Configuration Settings


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

AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
AutoDecodeSubjectInstructs the component to automatically decode message subjects.
GetMessageSizeWhether to poll the server for the message size prior to retrieving it.
MaxLineLengthThe maximum expected length for message lines.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0