class PPOP3Server: public PPOP3

A TCP/IP socket for the Post Office Protocol version 3.

Inheritance:


Protected Methods

[more]virtual void OnLIST ( PINDEX msg )
Get the size of a message in mailbox.
[more]virtual void OnUIDL ( PINDEX msg )
Get unique ID for message in mailbox.
[more]virtual BOOL OnUnknown ( const PCaselessString & command )
Handle an unknown command.


Inherited from PPOP3:

Protected Methods

ovirtual PINDEX ParseResponse( const PString & line )


Inherited from PInternetProtocol:

Public Methods

ovirtual BOOL Read( void * buf, PINDEX len )
ovirtual BOOL Write( const void * buf, PINDEX len )
ovoid SetReadLineTimeout( const PTimeInterval & t )
ovirtual BOOL Connect( const PString & address, WORD port = 0 )
ovirtual BOOL Accept( PSocket & listener )
oconst PString& GetDefaultService() const
oPIPSocket* GetSocket() const
ovirtual BOOL WriteLine( const PString & line )
ovirtual BOOL ReadLine( PString & line, BOOL allowContinuation = FALSE )
ovirtual void UnRead( int ch )
ovirtual BOOL WriteCommand( PINDEX cmdNumber )
ovirtual BOOL ReadCommand( PINDEX & num, PString & args )
ovirtual BOOL WriteResponse( unsigned numericCode, const PString & info )
ovirtual BOOL ReadResponse()
ovirtual int ExecuteCommand( PINDEX cmdNumber )
oint GetLastResponseCode() const
oPString GetLastResponseInfo() const


Inherited from PIndirectChannel:

Public

Construction

Overrides from class PObject

Overrides from class PChannel

Channel establish functions

Protected Fields

oPChannel* readChannel
oBOOL readAutoDelete
oPChannel* writeChannel
oBOOL writeAutoDelete
oPReadWriteMutex channelPointerMutex

Protected Methods

ovirtual BOOL OnOpen()


Inherited from PChannel:

Public Methods

ostatic BOOL ConvertOSError( int libcReturnValue, Errors & lastError, int & osError )

Public

Information functions

Reading functions

Writing functions

Miscellaneous functions

Error functions

Protected Fields

oint os_handle
oErrors lastErrorCode[NumErrorGroups+1]
oint lastErrorNumber[NumErrorGroups+1]
oPINDEX lastReadCount
oPINDEX lastWriteCount
oPTimeInterval readTimeout
oPTimeInterval writeTimeout

Protected Methods

ovirtual BOOL ConvertOSError( int libcReturnValue, ErrorGroup group = LastGeneralError )
oBOOL SetErrorValues( Errors errorCode, int osError, ErrorGroup group = LastGeneralError )
oint ReadCharWithTimeout( PTimeInterval & timeout )


Inherited from PObject:

Public

Run Time Type functions

Comparison functions

I/O functions


Documentation

A TCP/IP socket for the Post Office Protocol version 3.

When acting as a server, a descendant class would be created to override at least the <A>HandleOpenMailbox()</A>, <A>HandleSendMessage()</A> and <A>HandleDeleteMessage()</A> functions. Other functions may be overridden for further enhancement to the sockets capabilities, but these will give a basic POP3 server functionality.

The server socket thread would continuously call the <A>ProcessMessage()</A> function until it returns FALSE. This will then call the appropriate virtual function on parsing the POP3 protocol.

ovirtual void OnLIST( PINDEX msg )
Get the size of a message in mailbox. If <CODE>msg</CODE> is 0 then get sizes of all messages in mailbox.

ovirtual void OnUIDL( PINDEX msg )
Get unique ID for message in mailbox. If <CODE>msg</CODE> is 0 then get all IDs for all messages in mailbox.

ovirtual BOOL OnUnknown( const PCaselessString & command )
Handle an unknown command.

Returns:
TRUE if more processing may be done, FALSE if the <A>ProcessCommand()</A> function is to return FALSE.


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.