TPop3Cli
Jump to navigation
Jump to search
Main page -> ICS components reference -> TPop3Cli
Overview
- unit Pop3Cli.pas
- inheritance TPop3Cli - TComponent
The TPop3Client is a WinSock based component, that allows the user to connect to a POP3 server, retrieve or delete messages by just defining some Properties, using some Events and calling some Methods. It is as easy as it seems.
Properties
| ErrorMessage | Use this property to view the error generated by the last command issued by the TPop3Client component. This property does not include wrong password or wrong username. | |
| Host | Set the Host property to your pop3 host, so that the TPop3Client component knows which server you want to connect to. If no host is defined, the Connect method will generate an error. | |
| LastResponse | Use this property to check what was the last response of the server, based on your last command. It can be used to show the error, if any, that occurred during the last method issued. It is more effective than the ErrorMessage property because it include the responses from the server that can be errors on all Methods issued. | |
| MsgCount | Use this property to check the number of messages on the server. Note that messages marked as deleted are not counted in either total. Use the Stat method to update the number of messages in the mail server. | |
| MsgLines | Use this property with MsgNum and Top to define the lines of the message to be displayed. It is also updated by the Last method. Set to zero if you want the default value. | |
| MsgNum | Use this property to define the ID of the message and, defining the MsgLines property and using the Top method, the client can display information of the message. | |
| MsgSize | MsgSize is the total bytes occupied by the messages on the server. Use this after the Stat method. | |
| MsgUidl | This is a unique string given by the server to the message. This string does not change as the ID of the message, and the messages can be indentified by it. Define the ID of the message with the MsgNum property and then call the Uidl method to retreive the information. | |
| PassWord | Set this property with the password of the UserName used to connect to the Host. | |
| Port | Set this property with the Port (usually 110 or pop3, on this component) used to connect to the Host. If you are not sure about the port, contact your ISP (Intenet Service Provider). | |
| ProtocolState | This property can be either pop3Disconnected, pop3WaitingUser, pop3WaitingPass, pop3Transaction or pop3Update. | |
| Tag | The Tag property is not used at all. It can be used for user-defined integer variable. | |
| TimeOut | Set this property to set the TimeOut of the connection, in seconds. The pop3client component will try to connect until the TimeOut seconds is reached. | |
| UserName | Set this property with the Username used to connect to the Host. | |
| Wait | The Pop3Client component uses the TWait component so it can show the TimeOut of the connection with the Host. It cannot be nil. |
