Logo Search packages:      
Sourcecode: pwlib version File versions  Download package

PSMTPServer Class Reference

#include <inetmail.h>

Inheritance diagram for PSMTPServer:

PSMTP PInternetProtocol PIndirectChannel PChannel PObject

List of all members.

Detailed Description

A TCP/IP socket for the Simple Mail Transfer Protocol.

When acting as a client, the procedure is to make the connection to a remote server, then to send a message using the following procedure:

      PSMTPSocket mail("mailserver");
      if (mail.IsOpen()) {
        mail.BeginMessage("Me@here.com.au", "Fred@somwhere.com");
        if (!mail.EndMessage())
          PError << "Mail send failed." << endl;
         PError << "Mail conection failed." << endl;

    When acting as a server, a descendant class would be created to override
    at least the LookUpName() and HandleMessage() functions.
    Other functions may be overridden for further enhancement to the sockets
    capabilities, but these two will give a basic SMTP server functionality.

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

Definition at line 286 of file inetmail.h.

Comparison functions

enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
bool operator!= (const PObject &obj) const
bool operator< (const PObject &obj) const
bool operator<= (const PObject &obj) const
bool operator== (const PObject &obj) const
bool operator> (const PObject &obj) const
bool operator>= (const PObject &obj) const

Error functions

enum  ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
enum  Errors {
  NoError, NotFound, FileExists, DiskFull,
  AccessDenied, DeviceInUse, BadParameter, NoMemory,
  NotOpen, Timeout, Interrupted, BufferTooSmall,
  Miscellaneous, ProtocolFailure, NumNormalisedErrors
Errors GetErrorCode (ErrorGroup group=NumErrorGroups) const
int GetErrorNumber (ErrorGroup group=NumErrorGroups) const
static PString GetErrorText (Errors lastError, int osError=0)

Miscellaneous functions

enum  ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }
void AbortCommandString ()
BOOL SendCommandString (const PString &command)
BOOL SetBufferSize (PINDEX newSize)

Scattered read/write functions

typedef std::vector< SliceVectorOfSlice
virtual BOOL Read (const VectorOfSlice &slices)
virtual BOOL Write (const VectorOfSlice &slices)

Run Time Type functions

virtual const char * GetClass (unsigned=0) const
virtual BOOL InternalIsDescendant (const char *clsName) const
BOOL IsClass (const char *cls) const
static const char * Class ()

I/O functions

virtual void PrintOn (ostream &strm) const
virtual void ReadFrom (istream &strm)
ostream & operator<< (ostream &strm, const PObject &obj)
istream & operator>> (istream &strm, PObject &obj)

Public Types

enum  Commands {
enum  ForwardResult { LocalDomain, WillForward, CannotForward }
enum  LookUpResult { ValidUser, AmbiguousUser, UnknownUser, LookUpError }
enum  PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }

Public Member Functions

virtual BOOL Accept (PSocket &listener)
virtual BOOL Connect (const PString &address, const PString &service)
virtual BOOL Connect (const PString &address, WORD port=0)
virtual int ExecuteCommand (PINDEX cmdNumber, const PString &param)
virtual int ExecuteCommand (PINDEX cmdNumber)
virtual ForwardResult ForwardDomain (PCaselessString &userDomain, PCaselessString &forwardDomainList)
const PStringGetDefaultService () const
int GetLastResponseCode () const
PString GetLastResponseInfo () const
PIPSocketGetSocket () const
virtual BOOL HandleMessage (PCharArray &buffer, BOOL starting, BOOL completed)
virtual LookUpResult LookUpName (const PCaselessString &name, PString &expandedName)
BOOL ProcessCommand ()
 PSMTPServer ()
virtual BOOL Read (void *buf, PINDEX len)
virtual BOOL ReadCommand (PINDEX &num, PString &args)
virtual BOOL ReadLine (PString &line, BOOL allowContinuation=FALSE)
virtual BOOL ReadResponse (int &code, PString &info)
virtual BOOL ReadResponse ()
void ServerReset ()
void SetReadLineTimeout (const PTimeInterval &t)
virtual void UnRead (const void *buffer, PINDEX len)
virtual void UnRead (const PString &str)
virtual void UnRead (int ch)
virtual BOOL Write (const void *buf, PINDEX len)
virtual BOOL WriteCommand (PINDEX cmdNumber, const PString &param)
virtual BOOL WriteCommand (PINDEX cmdNumber)
virtual BOOL WriteLine (const PString &line)
virtual BOOL WriteResponse (const PString &code, const PString &info)
virtual BOOL WriteResponse (unsigned numericCode, const PString &info)
Miscellaneous functions
virtual PObjectClone () const
Overrides from class PChannel
virtual BOOL Close ()
virtual PChannelGetBaseReadChannel () const
virtual PChannelGetBaseWriteChannel () const
virtual PString GetErrorText (ErrorGroup group=NumErrorGroups) const
virtual PString GetName () const
virtual BOOL IsOpen () const
virtual BOOL Shutdown (ShutdownValue option)
Overrides from class PObject
Comparison Compare (const PObject &obj) const
Information functions
int GetHandle () const
Reading functions
virtual PINDEX GetLastReadCount () const
PTimeInterval GetReadTimeout () const
virtual void OnReadComplete (void *buf, PINDEX len)
virtual BOOL ReadAsync (void *buf, PINDEX len)
BOOL ReadBlock (void *buf, PINDEX len)
virtual int ReadChar ()
PString ReadString (PINDEX len)
void SetReadTimeout (const PTimeInterval &time)
Writing functions
virtual PINDEX GetLastWriteCount () const
PTimeInterval GetWriteTimeout () const
virtual void OnWriteComplete (const void *buf, PINDEX len)
void SetWriteTimeout (const PTimeInterval &time)
virtual BOOL WriteAsync (const void *buf, PINDEX len)
BOOL WriteChar (int c)
BOOL WriteString (const PString &str)
Channel establish functions
PChannelGetReadChannel () const
PChannelGetWriteChannel () const
BOOL Open (PChannel *readChannel, PChannel *writeChannel, BOOL autoDeleteRead=TRUE, BOOL autoDeleteWrite=TRUE)
BOOL Open (PChannel *channel, BOOL autoDelete=TRUE)
BOOL Open (PChannel &channel)
BOOL SetReadChannel (PChannel *channel, BOOL autoDelete=TRUE)
BOOL SetWriteChannel (PChannel *channel, BOOL autoDelete=TRUE)
Overrides from class PObject
virtual PINDEX HashFunction () const

Static Public Member Functions

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

Protected Types

enum  { WasMAIL, WasSEND, WasSAML, WasSOML }
enum  StuffState {
  DontStuff, StuffIdle, StuffCR, StuffCRLF,
  StuffCRLFdot, StuffCRLFdotCR

Protected Member Functions

virtual BOOL ConvertOSError (int libcReturnValue, ErrorGroup group=LastGeneralError)
virtual void OnDATA ()
virtual void OnEHLO (const PCaselessString &remoteHost)
virtual void OnEXPN (const PCaselessString &name)
virtual void OnHELO (const PCaselessString &remoteHost)
virtual void OnHELP ()
virtual void OnMAIL (const PCaselessString &sender)
virtual BOOL OnMIMEData (PCharArray &buffer, BOOL &completed)
virtual void OnNOOP ()
BOOL OnOpen ()
virtual void OnQUIT ()
virtual void OnRCPT (const PCaselessString &recipient)
virtual void OnRSET ()
virtual void OnSAML (const PCaselessString &sender)
virtual void OnSEND (const PCaselessString &sender)
virtual void OnSendMail (const PCaselessString &sender)
virtual void OnSOML (const PCaselessString &sender)
virtual BOOL OnTextData (PCharArray &buffer, BOOL &completed)
virtual void OnTURN ()
virtual BOOL OnUnknown (const PCaselessString &command)
virtual void OnVRFY (const PCaselessString &name)
virtual PINDEX ParseResponse (const PString &line)
int PXClose ()
BOOL PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)
int ReadCharWithTimeout (PTimeInterval &timeout)
BOOL ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)
BOOL SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)

Protected Attributes

PString channelName
PReadWriteMutex channelPointerMutex
 Race condition prevention on closing channel.
PStringArray commandNames
PString defaultServiceName
StuffState endMIMEDetectState
BOOL extendedHello
PString fromAddress
PString fromPath
Errors lastErrorCode [NumErrorGroups+1]
 The platform independant error code.
int lastErrorNumber [NumErrorGroups+1]
 The operating system error number (eg as returned by errno).
PINDEX lastReadCount
 Number of byte last read by the Read() function.
int lastResponseCode
PString lastResponseInfo
PINDEX lastWriteCount
 Number of byte last written by the Write() function.
PINDEX messageBufferSize
int os_handle
 The operating system file handle return by standard open() function.
PXBlockType px_lastBlockType
PMutex px_selectMutex
PMutex px_threadMutex
PMutex px_writeMutex
BOOL readAutoDelete
 Automatically delete read channel on destruction.
 Channel for read operations.
PTimeInterval readLineTimeout
PTimeInterval readTimeout
 Timeout for read operations.
enum PSMTPServer:: { ... }  sendCommand
enum PInternetProtocol::StuffState stuffingState
PStringList toDomains
PStringList toNames
PCharArray unReadBuffer
PINDEX unReadCount
BOOL writeAutoDelete
 Automatically delete write channel on destruction.
 Channel for write operations.
PTimeInterval writeTimeout
 Timeout for write operations.

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

Generated by  Doxygen 1.6.0   Back to index