# Class TPOP3Send

Description | Hierarchy | Fields | Methods | Properties

## Unit

pop3send

## Declaration

`type TPOP3Send = class(TSynaClient)`

## Description

Implementation of POP3 client protocol.

Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object!

Are you missing properties for specify server address and port? Look to parent TSynaClient too!

## Hierarchy

TPOP3Send > TSynaClient > TObject

## Methods

### Overview

| `constructor Create;`
| `destructor Destroy; override;`
| `function Capability: Boolean;`
| `function Dele(Value: Integer): Boolean;`
| `function FindCap(const Value: string): string;`
| `function List(Value: Integer): Boolean;`
| `function Login: Boolean;`
| `function Logout: Boolean;`
| `function NoOp: Boolean;`
| `function Reset: Boolean;`
| `function Retr(Value: Integer): Boolean;`
| `function StartTLS: Boolean;`
| `function Stat: Boolean;`
| `function Top(Value, Maxlines: Integer): Boolean;`
| `function Uidl(Value: Integer): Boolean;`

### Description

| `function Capability: Boolean;`

Call CAPA command for get POP3 server capabilites. note: not all servers support this command!

| `constructor Create;`

| `function Dele(Value: Integer): Boolean;`

Send DELE command for delete specified message. If all OK, result is `True`.

| `destructor Destroy; override;`

| `function FindCap(const Value: string): string;`

Try to find given capabily in capabilty string returned from POP3 server by CAPA command.

| `function List(Value: Integer): Boolean;`

Send LIST command. If Value is 0, LIST is for all messages. After successful operation is listing in FullResult. If all OK, result is `True`.

| `function Login: Boolean;`

Connect to remote POP3 host. If all OK, result is `True`.

| `function Logout: Boolean;`

Disconnects from POP3 server.

| `function NoOp: Boolean;`

Send NOOP command. If all OK, result is `True`.

| `function Reset: Boolean;`

Send RSET command. If all OK, result is `True`.

| `function Retr(Value: Integer): Boolean;`

Send RETR command. After successful operation dowloaded message in FullResult. If all OK, result is `True`.

| `function StartTLS: Boolean;`

Call STLS command for upgrade connection to SSL/TLS mode.

| `function Stat: Boolean;`

Send STAT command and fill StatCount and StatSize property. If all OK, result is `True`.

| `function Top(Value, Maxlines: Integer): Boolean;`

Send TOP command. After successful operation dowloaded headers of message and maxlines count of message in FullResult. If all OK, result is `True`.

| `function Uidl(Value: Integer): Boolean;`

Send UIDL command. If Value is 0, UIDL is for all messages. After successful operation is listing in FullResult. If all OK, result is `True`.

## Properties

### Overview

| `property AuthType: TPOP3AuthType;`
| `property AutoTLS: Boolean;`
| `property FullResult: TStringList;`
| `property FullSSL: Boolean;`
| `property ResultCode: Integer;`
| `property ResultString: string;`
| `property Sock: TTCPBlockSocket;`
| `property StatCount: Integer;`
| `property StatSize: Integer;`
| `property TimeStamp: string;`

### Description

| `property AuthType: TPOP3AuthType;`

Type of authorisation for login to POP3 server. Dafault is autodetect one of possible authorisation. Autodetect do this:

If remote POP3 server support APOP, try login by APOP method. If APOP is not supported, or if APOP login failed, try classic USER+PASS login method.

| `property AutoTLS: Boolean;`

If is set to `True`, then upgrade to SSL/TLS mode if remote server support it.

| `property FullResult: TStringList;`

Stringlist with full lines returned as result of POP3 operation. I.e. if operation is LIST, this property is filled by list of messages. If operation is RETR, this property have downloaded message.

| `property FullSSL: Boolean;`

SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port!

| `property ResultCode: Integer;`

Result code of last POP3 operation. 0 - error, 1 - OK.

| `property ResultString: string;`

Result string of last POP3 operation.

| `property Sock: TTCPBlockSocket;`

Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

| `property StatCount: Integer;`

After STAT command is there count of messages in inbox.

| `property StatSize: Integer;`

After STAT command is there size of all messages in inbox.

| `property TimeStamp: string;`

If server support this, after comnnect is in this property timestamp of remote server.

Generated by PasDoc 0.8.8.2 on 2005-01-19 20:01:19