POP Component
Properties Methods Events Configuration Settings Errors
The POP Component is used to easily retrieve electronic mail from Internet Post Office servers (POP).
Syntax
nsoftware.IPWorks.Pop
Remarks
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, 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 | 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. |
| Message | Provides the raw message content. |
| MessageCc | The value of the CC header of the last retrieved message. |
| MessageCount | The number of messages 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 identifier of the message as specified by the server. |
| Password | The password for the mailbox user. |
| Timeout | A timeout for the component. |
| TotalSize | Cumulative size in bytes of messages in the mailbox (including headers). |
| User | The user identifier 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 | Deletes 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 UIDs from the server. |
| LocalizeDate | Converts a valid RFC 822 message date to local date and time. |
| Reset | Resets all changes and revert back to the state when the user first connected. |
| Retrieve | Retrieves a message specified by MessageNumber from the server. |
| RetrieveHeaders | Retrieves 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. |
| 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.
| AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
| AutoDecodeSubject | Instructs the component to automatically decode message subjects. |
| GetMessageSize | Whether to poll the server for the message size prior to retrieving it. |
| MaxLineLength | The maximum expected length for message lines. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |