Class TPOP3Send

DescriptionHierarchyFieldsMethodsProperties

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

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

Description

Public function Capability: Boolean;

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

Public constructor Create;

 

Public function Dele(Value: Integer): Boolean;

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

Public destructor Destroy; override;

 

Public function FindCap(const Value: string): string;

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

Public 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.

Public function Login: Boolean;

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

Public function Logout: Boolean;

Disconnects from POP3 server.

Public function NoOp: Boolean;

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

Public function Reset: Boolean;

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

Public function Retr(Value: Integer): Boolean;

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

Public function StartTLS: Boolean;

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

Public function Stat: Boolean;

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

Public 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.

Public 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

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

Description

Published 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.

Published property AutoTLS: Boolean;

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

Published 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.

Published 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!

Published property ResultCode: Integer;

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

Published property ResultString: string;

Result string of last POP3 operation.

Published property Sock: TTCPBlockSocket;

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

Published property StatCount: Integer;

After STAT command is there count of messages in inbox.

Published property StatSize: Integer;

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

Published 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