PSMTPServer Class Reference
#include <inetmail.h>
List of all members.
Public Types |
enum | ForwardResult { LocalDomain,
WillForward,
CannotForward
} |
enum | LookUpResult { ValidUser,
AmbiguousUser,
UnknownUser,
LookUpError
} |
Public Member Functions |
| PSMTPServer () |
BOOL | ProcessCommand () |
void | ServerReset () |
virtual ForwardResult | ForwardDomain (PCaselessString &userDomain, PCaselessString &forwardDomainList) |
virtual LookUpResult | LookUpName (const PCaselessString &name, PString &expandedName) |
virtual BOOL | HandleMessage (PCharArray &buffer, BOOL starting, BOOL completed) |
Protected Types |
enum | { WasMAIL,
WasSEND,
WasSAML,
WasSOML
} |
Protected Member Functions |
BOOL | OnOpen () |
virtual void | OnHELO (const PCaselessString &remoteHost) |
virtual void | OnEHLO (const PCaselessString &remoteHost) |
virtual void | OnQUIT () |
virtual void | OnHELP () |
virtual void | OnNOOP () |
virtual void | OnTURN () |
virtual void | OnRSET () |
virtual void | OnVRFY (const PCaselessString &name) |
virtual void | OnEXPN (const PCaselessString &name) |
virtual void | OnRCPT (const PCaselessString &recipient) |
virtual void | OnMAIL (const PCaselessString &sender) |
virtual void | OnSEND (const PCaselessString &sender) |
virtual void | OnSAML (const PCaselessString &sender) |
virtual void | OnSOML (const PCaselessString &sender) |
virtual void | OnDATA () |
virtual BOOL | OnUnknown (const PCaselessString &command) |
virtual void | OnSendMail (const PCaselessString &sender) |
virtual BOOL | OnTextData (PCharArray &buffer, BOOL &completed) |
virtual BOOL | OnMIMEData (PCharArray &buffer, BOOL &completed) |
Protected Attributes |
BOOL | extendedHello |
BOOL | eightBitMIME |
PString | fromAddress |
PString | fromPath |
PStringList | toNames |
PStringList | toDomains |
PINDEX | messageBufferSize |
enum PSMTPServer:: { ... } | sendCommand |
StuffState | endMIMEDetectState |
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");
mail.Write(myMessage);
if (!mail.EndMessage())
PError << "Mail send failed." << endl;
}
else
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.
Member Enumeration Documentation
anonymous enum [protected] |
- Enumerator:
WasMAIL |
|
WasSEND |
|
WasSAML |
|
WasSOML |
|
- Enumerator:
LocalDomain |
User may be on local machine, do LookUpName().
|
WillForward |
User may be forwarded to another SMTP host.
|
CannotForward |
User cannot be forwarded.
|
- Enumerator:
ValidUser |
User name was valid and unique.
|
AmbiguousUser |
User name was valid but ambiguous.
|
UnknownUser |
User name was invalid.
|
LookUpError |
Some other error occurred in look up.
|
Constructor & Destructor Documentation
PSMTPServer::PSMTPServer |
( |
|
) |
|
Create a TCP/IP SMPTP 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.
Member Function Documentation
Determine if a user for this domain may be on the local system, or should be forwarded.
- Returns:
- Result of forward check operation.
- Parameters:
-
| userDomain | Domain for user |
| forwardDomainList | Domains forwarding to |
virtual BOOL PSMTPServer::HandleMessage |
( |
PCharArray & |
buffer, |
|
|
BOOL |
starting, |
|
|
BOOL |
completed | |
|
) |
| | [virtual] |
Handle a received message. The buffer
parameter contains the partial or complete message received, depending on the completed
parameter.
The default behaviour is to simply return FALSE;
- Returns:
- TRUE if message was handled, FALSE if an error occurs.
- Parameters:
-
| buffer | Buffer containing message data received. |
| starting | This is the first call for the message. |
| completed | This is the last call for the message. Indication that the entire message has been received. |
Look up a name in the context of the SMTP server.
The default bahaviour simply returns FALSE.
- Returns:
- Result of name look up operation.
- Parameters:
-
| name | Name to look up. |
| expandedName | Expanded form of name (if found). |
virtual void PSMTPServer::OnDATA |
( |
|
) |
[protected, virtual] |
virtual void PSMTPServer::OnEHLO |
( |
const PCaselessString & |
remoteHost |
) |
[protected, virtual] |
- Parameters:
-
| remoteHost | Name of remote host. |
virtual void PSMTPServer::OnEXPN |
( |
const PCaselessString & |
name |
) |
[protected, virtual] |
virtual void PSMTPServer::OnHELO |
( |
const PCaselessString & |
remoteHost |
) |
[protected, virtual] |
- Parameters:
-
| remoteHost | Name of remote host. |
virtual void PSMTPServer::OnHELP |
( |
|
) |
[protected, virtual] |
virtual void PSMTPServer::OnMAIL |
( |
const PCaselessString & |
sender |
) |
[protected, virtual] |
virtual BOOL PSMTPServer::OnMIMEData |
( |
PCharArray & |
buffer, |
|
|
BOOL & |
completed | |
|
) |
| | [protected, virtual] |
Read an eight bit MIME message that is being received by the socket. The MIME message is terminated by the CR/LF/./CR/LF sequence.
The default behaviour is to read the data into the buffer
parameter until either the end of the message or when the messageBufferSize
bytes have been read.
- Returns:
- TRUE if partial message received, FALSE if the end of the data was received.
virtual void PSMTPServer::OnNOOP |
( |
|
) |
[protected, virtual] |
BOOL PSMTPServer::OnOpen |
( |
|
) |
[protected, virtual] |
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.
virtual void PSMTPServer::OnQUIT |
( |
|
) |
[protected, virtual] |
virtual void PSMTPServer::OnRCPT |
( |
const PCaselessString & |
recipient |
) |
[protected, virtual] |
- Parameters:
-
| recipient | Name of recipient. |
virtual void PSMTPServer::OnRSET |
( |
|
) |
[protected, virtual] |
virtual void PSMTPServer::OnSAML |
( |
const PCaselessString & |
sender |
) |
[protected, virtual] |
virtual void PSMTPServer::OnSEND |
( |
const PCaselessString & |
sender |
) |
[protected, virtual] |
virtual void PSMTPServer::OnSendMail |
( |
const PCaselessString & |
sender |
) |
[protected, virtual] |
virtual void PSMTPServer::OnSOML |
( |
const PCaselessString & |
sender |
) |
[protected, virtual] |
virtual BOOL PSMTPServer::OnTextData |
( |
PCharArray & |
buffer, |
|
|
BOOL & |
completed | |
|
) |
| | [protected, virtual] |
Read a standard text message that is being received by the socket. The text message is terminated by a line with a '.' character alone.
The default behaviour is to read the data into the buffer
parameter until either the end of the message or when the messageBufferSize
bytes have been read.
- Returns:
- TRUE if partial message received, FALSE if the end of the data was received.
virtual void PSMTPServer::OnTURN |
( |
|
) |
[protected, virtual] |
virtual BOOL PSMTPServer::OnUnknown |
( |
const PCaselessString & |
command |
) |
[protected, virtual] |
Handle an unknown command.
- Returns:
- TRUE if more processing may be done, FALSE if the ProcessCommand() function is to return FALSE.
- Parameters:
-
| command | Complete command line received. |
virtual void PSMTPServer::OnVRFY |
( |
const PCaselessString & |
name |
) |
[protected, virtual] |
BOOL PSMTPServer::ProcessCommand |
( |
|
) |
|
Process commands, dispatching to the appropriate virtual function. This is used when the socket is acting as a server.
- Returns:
- TRUE if more processing may be done, FALSE if the QUIT command was received or the OnUnknown() function returns FALSE.
void PSMTPServer::ServerReset |
( |
|
) |
|
Member Data Documentation
The documentation for this class was generated from the following file: