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

#include <inetmail.h>

Inheritance diagram for PPOP3Client:

Collaboration diagram for PPOP3Client:

Public Types
enum	LoginOptions { AllowUserPass = 1, UseSASL = 2, AllowClearTextSASL = 4 }

Public Types inherited from PPOP3
enum	Commands { USER, PASS, QUIT, RSET, NOOP, STATcmd, LIST, RETR, DELE, APOP, TOP, UIDL, AUTH, NumCommands }

Public Types inherited from PChannel
enum	PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }

enum	Errors { NoError, NotFound, FileExists, DiskFull, AccessDenied, DeviceInUse, BadParameter, NoMemory, NotOpen, Timeout, Interrupted, BufferTooSmall, Miscellaneous, ProtocolFailure, Unavailable, NumNormalisedErrors }
	Normalised error codes. More...

enum	ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
	Error groups. More...

typedef PNotifierTemplate < PChannel::AsyncContext & >	AsyncNotifier

enum	ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Public Member Functions
	PPOP3Client ()
	Create a TCP/IP POP3 protocol socket channel. More...

	~PPOP3Client ()
	Destroy the channel object. More...

virtual PBoolean	Close ()
	Close the socket, and if connected as a client, QUITs from server. More...

PBoolean	LogIn (const PString &username, const PString &password, int options=AllowUserPass)
	Log into the POP server using the mailbox and access codes specified. More...

int	GetMessageCount ()
	Get a count of the number of messages in the mail box. More...

PUnsignedArray	GetMessageSizes ()
	Get an array of a integers representing the sizes of each of the messages in the mail box. More...

PStringArray	GetMessageHeaders ()
	Get an array of a strings representing the standard internet message headers of each of the messages in the mail box. More...

PBoolean	BeginMessage (PINDEX messageNumber)

PBoolean	DeleteMessage (PINDEX messageNumber)
	Delete the message specified from the mail box. More...

Public Member Functions inherited from PInternetProtocol
virtual PBoolean	Read (void *buf, PINDEX len)
	Low level read from the channel. More...

virtual int	ReadChar ()
	Read a single 8 bit byte from the channel. More...

virtual PBoolean	Write (const void *buf, PINDEX len)
	Low level write to the channel. More...

void	SetReadLineTimeout (const PTimeInterval &t)
	Set the maximum timeout between characters within a line. More...

virtual PBoolean	Connect (const PString &address, WORD port=0)
	Connect a socket to a remote host for the internet protocol. More...

virtual PBoolean	Connect (const PString &address, const PString &service)

virtual PBoolean	Accept (PSocket &listener)
	Accept a server socket to a remote host for the internet protocol. More...

const PString &	GetDefaultService () const
	Get the default service name or port number to use in socket connections. More...

PIPSocket *	GetSocket () const
	Get the eventual socket for the series of indirect channels that may be between the current protocol and the actual I/O channel. More...

virtual PBoolean	WriteLine (const PString &line)
	Write a string to the socket channel followed by a CR/LF pair. More...

virtual PBoolean	ReadLine (PString &line, PBoolean allowContinuation=false)
	Read a string from the socket channel up to a CR/LF pair. More...

virtual void	UnRead (int ch)
	Put back the characters into the data stream so that the next Read() function call will return them first. More...

virtual void	UnRead (const PString &str)

virtual void	UnRead (const void *buffer, PINDEX len)

virtual bool	WriteCommand (PINDEX cmdNumber, const PString &param=PString::Empty())
	Write a single line for a command. More...

virtual bool	WriteCommand (PINDEX cmdNumber, const PString &param, const PMIMEInfo &mime)

virtual PBoolean	ReadCommand (PINDEX &num, PString &args)
	Read a single line of a command which ends with a CR/LF pair. More...

virtual PBoolean	ReadCommand (PINDEX &num, PString &args, PMIMEInfo &mime)

virtual PBoolean	WriteResponse (unsigned numericCode, const PString &info)
	Write a response code followed by a text string describing the response to a command. More...

virtual PBoolean	WriteResponse (const PString &code, const PString &info)

virtual PBoolean	ReadResponse ()
	Read a response code followed by a text string describing the response to a command. More...

virtual PBoolean	ReadResponse (int &code, PString &info)

virtual PBoolean	ReadResponse (int &code, PString &info, PMIMEInfo &mime)

virtual int	ExecuteCommand (PINDEX cmdNumber)
	Write a command to the socket, using `WriteCommand()` and await a response using `ReadResponse()`. More...

virtual int	ExecuteCommand (PINDEX cmdNumber, const PString &param)

int	GetLastResponseCode () const
	Return the code associated with the last response received by the socket. More...

PString	GetLastResponseInfo () const
	Return the last response received by the socket. More...

Public Member Functions inherited from PIndirectChannel
	PIndirectChannel ()
	Create a new indirect channel without any channels to redirect to. More...

	~PIndirectChannel ()
	Close the indirect channel, deleting read/write channels if desired. More...

Comparison	Compare (const PObject &obj) const
	Determine if the two objects refer to the same indirect channel. More...

virtual PString	GetName () const
	Get the name of the channel. More...

virtual P_INT_PTR	GetHandle () const
	Get the OS specific handle for the PSoundChannel. More...

virtual PBoolean	IsOpen () const
	Determine if the channel is currently open and read and write operations can be executed on it. More...

virtual PBoolean	Shutdown (ShutdownValue option)
	Close one or both of the data streams associated with a channel. More...

virtual bool	SetLocalEcho (bool localEcho)
	Set local echo mode. More...

virtual PChannel *	GetBaseReadChannel () const
	This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of `PIndirectChannel`. More...

virtual PChannel *	GetBaseWriteChannel () const
	This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of `PIndirectChannel`. More...

virtual bool	CloseBaseReadChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

virtual bool	CloseBaseWriteChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

virtual PString	GetErrorText (ErrorGroup group=NumErrorGroups) const
	Get error message description. More...

PBoolean	Open (PChannel &channel)
	Set the channel for both read and write operations. More...

PBoolean	Open (PChannel *channel, PBoolean autoDelete=true)
	Set the channel for both read and write operations. More...

PBoolean	Open (PChannel readChannel, PChannel writeChannel, PBoolean autoDeleteRead=true, PBoolean autoDeleteWrite=true)
	Set the channel for both read and write operations. More...

PChannel *	Detach (ShutdownValue option=ShutdownReadAndWrite)
	Detach without closing the read/write channel. More...

PChannel *	GetReadChannel () const
	Get the channel used for read operations. More...

bool	SetReadChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
	Set the channel for read operations. More...

PChannel *	GetWriteChannel () const
	Get the channel used for write operations. More...

PBoolean	SetWriteChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
	Set the channel for read operations. More...

template<class ChannelClass >
ChannelClass *	FindChannel ()
	Locate a channel of a specific class in the indirect chain. More...

Public Member Functions inherited from PChannel
PBoolean	SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
	Set error values to those specified. More...

virtual PINDEX	HashFunction () const
	Calculate a hash value for use in sets and dictionaries. More...

FILE *	FDOpen (const char *mode)
	Re-open the device using the stdio library. More...

void	SetReadTimeout (const PTimeInterval &time)
	Set the timeout for read operations. More...

PTimeInterval	GetReadTimeout () const
	Get the timeout for read operations. More...

virtual PINDEX	GetLastReadCount () const
	Get the number of bytes read by the last Read() call. More...

virtual PINDEX	SetLastReadCount (PINDEX count)

PBoolean	ReadBlock (void *buf, PINDEX len)
	Read len bytes into the buffer from the channel. More...

PString	ReadString (PINDEX len)
	Read `len` character into a string from the channel. More...

void	SetWriteTimeout (const PTimeInterval &time)
	Set the timeout for write operations to complete. More...

PTimeInterval	GetWriteTimeout () const
	Get the timeout for write operations to complete. More...

virtual PBoolean	Write (const void buf, PINDEX len, const void )
	Low level write to the channel with marker. More...

virtual PINDEX	GetLastWriteCount () const
	Get the number of bytes written by the last Write() call. More...

virtual PINDEX	SetLastWriteCount (PINDEX count)

PBoolean	WriteChar (int c)
	Write a single character to the channel. More...

PBoolean	WriteString (const PString &str)
	Write a string to the channel. More...

	~PChannel ()
	Close down the channel. More...

Errors	GetErrorCode (ErrorGroup group=NumErrorGroups) const
	Get normalised error code. More...

int	GetErrorNumber (ErrorGroup group=NumErrorGroups) const
	Get OS errro code. More...

virtual bool	ReadAsync (AsyncContext &context)
	Begin an asynchronous read from channel. More...

virtual void	OnReadComplete (AsyncContext &context)
	User callback function for when a `ReadAsync()` call has completed or timed out. More...

virtual bool	WriteAsync (AsyncContext &context)
	Begin an asynchronous write from channel. More...

virtual void	OnWriteComplete (AsyncContext &context)
	User callback function for when a WriteAsync() call has completed or timed out. More...

virtual bool	FlowControl (const void *flowData)
	Flow Control information Pass data to the channel for flowControl determination. More...

PBoolean	SetBufferSize (PINDEX newSize)
	Set the iostream buffer size for reads and writes. More...

PBoolean	SendCommandString (const PString &command)
	Send a command meta-string. More...

void	AbortCommandString ()
	Abort a command string that is in progress. More...

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
PBoolean	OnOpen ()
	This callback is executed when the Open() function is called with open channels. More...

Protected Member Functions inherited from PPOP3
	PPOP3 ()

virtual PINDEX	ParseResponse (const PString &line)
	Parse a response line string into a response code and any extra info on the line. More...

Protected Member Functions inherited from PInternetProtocol
	PInternetProtocol (const char defaultServiceName, PINDEX cmdCount, char const const *cmdNames)

bool	SetLastResponse (int code, const PString &info, ErrorGroup group=LastGeneralError)

Protected Member Functions inherited from PIndirectChannel
	PDECLARE_READ_WRITE_MUTEX (channelPointerMutex)
	Race condition prevention on closing channel. More...

Protected Member Functions inherited from PChannel
	PChannel (const PChannel &)

PChannel &	operator= (const PChannel &)

virtual PBoolean	ConvertOSError (P_INT_PTR libcReturnValue, ErrorGroup group=LastGeneralError)
	Convert an operating system error into platform independent error. More...

int	ReadCharWithTimeout (PTimeInterval &timeout)
	Read a character with specified timeout. More...

PBoolean	ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)

bool	CheckNotOpen ()

virtual int	os_errno () const

PBoolean	PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)

P_INT_PTR	GetOSHandleAsInt () const

int	PXClose ()

	PDECLARE_MUTEX (px_threadMutex)

	PDECLARE_MUTEX (px_writeMutex)

	PChannel ()
	Create the channel. More...

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PBoolean	loggedIn

PString	apopBanner

Protected Attributes inherited from PInternetProtocol
PString	defaultServiceName

PStringArray	commandNames

PCharArray	unReadBuffer

PINDEX	unReadCount

PTimeInterval	readLineTimeout

enum PInternetProtocol::StuffState	stuffingState

PBoolean	newLineToCRLF

int	m_lastResponseCode

PString	m_lastResponseInfo

Protected Attributes inherited from PIndirectChannel
PChannel *	readChannel
	Channel for read operations. More...

PBoolean	readAutoDelete
	Automatically delete read channel on destruction. More...

PChannel *	writeChannel
	Channel for write operations. More...

PBoolean	writeAutoDelete
	Automatically delete write channel on destruction. More...

Protected Attributes inherited from PChannel
PTimeInterval	readTimeout
	Timeout for read operations. More...

PTimeInterval	writeTimeout
	Timeout for write operations. More...

atomic< P_INT_PTR >	os_handle
	The operating system file handle return by standard open() function. More...

PThreadLocalStorage< Status >	m_status [NumErrorGroups+1]

PXBlockType	px_lastBlockType

PThread *	px_readThread

PThread *	px_writeThread

PThread *	px_selectThread [3]

PCriticalSection	px_selectMutex [3]

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Static Public Member Functions inherited from PChannel
static PString	GetErrorText (Errors lastError, int osError=0)
	Get error message description. More...

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Protected Types inherited from PInternetProtocol
enum	StuffState { DontStuff, StuffIdle, StuffCR, StuffCRLF, StuffCRLFdot, StuffCRLFdotCR }

Static Protected Member Functions inherited from PPOP3
static const PString &	okResponse ()

static const PString &	errResponse ()

Detailed Description

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

When acting as a client, the procedure is to make the connection to a remote server, then to retrieve a message using the following procedure: PPOP3Client mail; if (mail.Connect("popserver")) { if (mail.LogIn("Me", "password")) { if (mail.GetMessageCount() > 0) { PUnsignedArray sizes = mail.GetMessageSizes(); for (PINDEX i = 0; i < sizes.GetSize(); i++) { if (mail.BeginMessage(i+1)) mail.Read(myMessage, sizes[i]); else PError << "Error getting mail message." << endl; } } else PError << "No mail messages." << endl; } else PError << "Mail log in failed." << endl; } else PError << "Mail conection failed." << endl;

Member Enumeration Documentation

enum PPOP3Client::LoginOptions

Enumerator
AllowUserPass	Allow the use of the plain old USER/PASS if APOP or SASL are not available.
UseSASL	Use SASL if the AUTH command is supported by the server.
AllowClearTextSASL	Allow LOGIN and PLAIN mechanisms to be used.

Constructor & Destructor Documentation

PPOP3Client::PPOP3Client ( )

Create a TCP/IP POP3 protocol socket channel.

The parameterless form creates an unopened socket, the form with the address parameter makes a connection to a remote system, opening the socket. The form with the socket parameter opens the socket to an incoming call from a "listening" socket.

PPOP3Client::~PPOP3Client ( )

Destroy the channel object.

This will close the channel and as a client, QUIT from remote POP3 server.

Member Function Documentation

PBoolean PPOP3Client::BeginMessage ( PINDEX messageNumber )

Parameters

messageNumber Number of message to retrieve. This is an integer from 1 to the maximum number of messages available.

virtual PBoolean PPOP3Client::Close ( )

virtual

Close the socket, and if connected as a client, QUITs from server.

Returns: true if the channel was closed and the QUIT accepted by the server.

Reimplemented from PIndirectChannel.

PBoolean PPOP3Client::DeleteMessage ( PINDEX messageNumber )

Delete the message specified from the mail box.

Returns: Array of strings continaing message headers.

int PPOP3Client::GetMessageCount ( )

Get a count of the number of messages in the mail box.

Returns: Number of messages in mailbox or -1 if an error occurred.

PStringArray PPOP3Client::GetMessageHeaders ( )

Get an array of a strings representing the standard internet message headers of each of the messages in the mail box.

Note that the remote server may not support this function, in which case an empty array will be returned.

Returns: Array of strings continaing message headers.

PUnsignedArray PPOP3Client::GetMessageSizes ( )

Get an array of a integers representing the sizes of each of the messages in the mail box.

Returns: Array of integers representing the size of each message.

PBoolean PPOP3Client::LogIn	(	const PString &	username,
		const PString &	password,
		int	options = `AllowUserPass`
	)

Log into the POP server using the mailbox and access codes specified.

Returns: true if logged in.

Parameters

username	User name on remote system.
password	Password for user name.
options	See LoginOptions above

PBoolean PPOP3Client::OnOpen ( )

protectedvirtual

This callback is executed when the Open() function is called with open channels.

It may be used by descendent channels to do any handshaking required by the protocol that channel embodies.

The default behaviour is to simply return true.

Returns: Returns true if the protocol handshaking is successful.

Reimplemented from PIndirectChannel.

Member Data Documentation

PString PPOP3Client::apopBanner

protected

PBoolean PPOP3Client::loggedIn

protected

The documentation for this class was generated from the following file:

inetmail.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation