|
E-MailRelay
|
An interface used by the ServerProtocol class to assemble and process an incoming message. More...
#include <gprotocolmessage.h>
Inheritance diagram for GSmtp::ProtocolMessage:Public Member Functions | |
| virtual | ~ProtocolMessage () |
| Destructor. | |
| virtual G::Slot::Signal4< bool, unsigned long, std::string, std::string > & | doneSignal ()=0 |
| Returns a signal which is raised once process() has completed. More... | |
| virtual void | reset ()=0 |
| Resets the object state as if just constructed. | |
| virtual void | clear ()=0 |
| Clears the message state and terminates any asynchronous message processing. More... | |
| virtual bool | setFrom (const std::string &from_user, const std::string &from_auth)=0 |
| Sets the message envelope 'from'. More... | |
| virtual bool | addTo (const std::string &to_user, VerifierStatus to_status)=0 |
| Adds an envelope 'to'. More... | |
| virtual void | addReceived (const std::string &)=0 |
| Adds a 'received' line to the start of the content. More... | |
| virtual bool | addText (const char *, size_t)=0 |
| Adds text. More... | |
| bool | addTextLine (const std::string &) |
| A convenience function that calls addText() taking a string parameter. More... | |
| virtual std::string | from () const =0 |
| Returns the setFrom() string. | |
| virtual void | process (const std::string &session_auth_id, const std::string &peer_socket_address, const std::string &peer_certificate)=0 |
| Starts asynchronous processing of the message. More... | |
An interface used by the ServerProtocol class to assemble and process an incoming message.
It implements the three 'buffers' mentioned in RFC-2821 (esp. section 4.1.1).
This interface serves to decouple the protocol class from the downstream message processing – hence the name. Derived classes implement different types of downstream processing. For store-and-forward behaviour the ProtocolMessageStore class uses GSmtp::MessageStore to store messages; for proxying behaviour the ProtocolMessageForward class uses GSmtp::Client to do immediate forwarding.
The interface is used by the protocol class in the following sequence:
The process() method is asynchronous, but note that the completion signal may be emitted before the initiating call returns.
Definition at line 63 of file gprotocolmessage.h.
|
pure virtual |
Adds a 'received' line to the start of the content.
Precondition: at least one successful addTo() call
Implemented in GSmtp::ProtocolMessageForward, and GSmtp::ProtocolMessageStore.
|
pure virtual |
Adds text.
Returns false on error, typically because a size limit is reached.
Precondition: at least one successful addTo() call
Implemented in GSmtp::ProtocolMessageForward, and GSmtp::ProtocolMessageStore.
| bool GSmtp::ProtocolMessage::addTextLine | ( | const std::string & | line | ) |
A convenience function that calls addText() taking a string parameter.
Definition at line 29 of file gprotocolmessage.cpp.
|
pure virtual |
Adds an envelope 'to'.
The 'to_status' parameter comes from GSmtp::Verifier.verify(). Returns false if an invalid user.
Precondition: setFrom() called since clear() or process().
Implemented in GSmtp::ProtocolMessageForward, and GSmtp::ProtocolMessageStore.
|
pure virtual |
Clears the message state and terminates any asynchronous message processing.
Implemented in GSmtp::ProtocolMessageForward, and GSmtp::ProtocolMessageStore.
|
pure virtual |
Returns a signal which is raised once process() has completed.
The signal parameters are 'success', 'id', 'short-reason' and 'full-reason'. As a special case, if success is true and id is zero then the message processing was abandoned.
Implemented in GSmtp::ProtocolMessageForward, and GSmtp::ProtocolMessageStore.
|
pure virtual |
Starts asynchronous processing of the message.
Once processing is complete the message state is cleared and the doneSignal() is raised. The signal may be raised before process() returns.
The session-auth-id parameter is used to propagate authentication information from the SMTP AUTH command into individual messages. It is the empty string for unauthenticated clients. See also GAuth::SaslServer::id().
Implemented in GSmtp::ProtocolMessageForward, and GSmtp::ProtocolMessageStore.
|
pure virtual |
Sets the message envelope 'from'.
Returns false if an invalid user.
Implemented in GSmtp::ProtocolMessageForward, and GSmtp::ProtocolMessageStore.
1.8.9.1