E-MailRelay
Public Member Functions | List of all members
GSmtp::ProtocolMessageStore Class Reference

A concrete implementation of the ProtocolMessage interface that stores incoming messages in the message store. More...

#include <gprotocolmessagestore.h>

+ Inheritance diagram for GSmtp::ProtocolMessageStore:

Public Member Functions

 ProtocolMessageStore (MessageStore &store, std::unique_ptr< Filter >)
 Constructor. More...
 
 ~ProtocolMessageStore () override
 Destructor. More...
 
ProtocolMessage::DoneSignaldoneSignal () override
 Override from GSmtp::ProtocolMessage. More...
 
void reset () override
 Override from GSmtp::ProtocolMessage. More...
 
void clear () override
 Override from GSmtp::ProtocolMessage. More...
 
MessageId setFrom (const std::string &from_user, const std::string &) override
 Override from GSmtp::ProtocolMessage. More...
 
bool addTo (VerifierStatus to_status) override
 Override from GSmtp::ProtocolMessage. More...
 
void addReceived (const std::string &) override
 Override from GSmtp::ProtocolMessage. More...
 
bool addText (const char *, std::size_t) override
 Override from GSmtp::ProtocolMessage. More...
 
std::string from () const override
 Override from GSmtp::ProtocolMessage. More...
 
void process (const std::string &auth_id, const std::string &peer_socket_address, const std::string &peer_certificate) override
 Override from GSmtp::ProtocolMessage. More...
 
 ProtocolMessageStore (const ProtocolMessageStore &)=delete
 
 ProtocolMessageStore (ProtocolMessageStore &&)=delete
 
void operator= (const ProtocolMessageStore &)=delete
 
void operator= (ProtocolMessageStore &&)=delete
 
- Public Member Functions inherited from GSmtp::ProtocolMessage
virtual ~ProtocolMessage ()=default
 Destructor.
 
virtual DoneSignaldoneSignal ()=0
 Returns a signal which is raised once process() has completed. More...
 
virtual void reset ()=0
 Resets the object state as if just constructed. More...
 
virtual void clear ()=0
 Clears the message state and terminates any asynchronous message processing. More...
 
virtual MessageId setFrom (const std::string &from_user, const std::string &from_auth)=0
 Sets the message envelope 'from'. More...
 
virtual bool addTo (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 *, std::size_t)=0
 Adds text. More...
 
bool addTextLine (const std::string &)
 A convenience function that calls addText() taking a string parameter and adding CR-LF. More...
 
virtual std::string from () const =0
 Returns the setFrom() string. More...
 
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...
 

Additional Inherited Members

- Public Types inherited from GSmtp::ProtocolMessage
using DoneSignal = G::Slot::Signal< bool, const MessageId &, const std::string &, const std::string & >
 

Detailed Description

A concrete implementation of the ProtocolMessage interface that stores incoming messages in the message store.

See also
GSmtp::ProtocolMessageForward

Definition at line 43 of file gprotocolmessagestore.h.

Constructor & Destructor Documentation

◆ ProtocolMessageStore()

GSmtp::ProtocolMessageStore::ProtocolMessageStore ( MessageStore store,
std::unique_ptr< Filter filter 
)

Constructor.

Definition at line 28 of file gprotocolmessagestore.cpp.

◆ ~ProtocolMessageStore()

GSmtp::ProtocolMessageStore::~ProtocolMessageStore ( )
override

Destructor.

Definition at line 35 of file gprotocolmessagestore.cpp.

Member Function Documentation

◆ addReceived()

void GSmtp::ProtocolMessageStore::addReceived ( const std::string &  received_line)
overridevirtual

Override from GSmtp::ProtocolMessage.

Implements GSmtp::ProtocolMessage.

Definition at line 91 of file gprotocolmessagestore.cpp.

◆ addText()

bool GSmtp::ProtocolMessageStore::addText ( const char *  line_data,
std::size_t  line_size 
)
overridevirtual

Override from GSmtp::ProtocolMessage.

Implements GSmtp::ProtocolMessage.

Definition at line 98 of file gprotocolmessagestore.cpp.

◆ addTo()

bool GSmtp::ProtocolMessageStore::addTo ( VerifierStatus  to_status)
overridevirtual

Override from GSmtp::ProtocolMessage.

Implements GSmtp::ProtocolMessage.

Definition at line 70 of file gprotocolmessagestore.cpp.

◆ clear()

void GSmtp::ProtocolMessageStore::clear ( )
overridevirtual

Override from GSmtp::ProtocolMessage.

Implements GSmtp::ProtocolMessage.

Definition at line 46 of file gprotocolmessagestore.cpp.

◆ doneSignal()

GSmtp::ProtocolMessage::DoneSignal & GSmtp::ProtocolMessageStore::doneSignal ( )
overridevirtual

Override from GSmtp::ProtocolMessage.

Implements GSmtp::ProtocolMessage.

Definition at line 202 of file gprotocolmessagestore.cpp.

◆ from()

std::string GSmtp::ProtocolMessageStore::from ( ) const
overridevirtual

Override from GSmtp::ProtocolMessage.

Implements GSmtp::ProtocolMessage.

Definition at line 106 of file gprotocolmessagestore.cpp.

◆ process()

void GSmtp::ProtocolMessageStore::process ( const std::string &  auth_id,
const std::string &  peer_socket_address,
const std::string &  peer_certificate 
)
overridevirtual

Override from GSmtp::ProtocolMessage.

Implements GSmtp::ProtocolMessage.

Definition at line 111 of file gprotocolmessagestore.cpp.

◆ reset()

void GSmtp::ProtocolMessageStore::reset ( )
overridevirtual

Override from GSmtp::ProtocolMessage.

Implements GSmtp::ProtocolMessage.

Definition at line 40 of file gprotocolmessagestore.cpp.

◆ setFrom()

GSmtp::MessageId GSmtp::ProtocolMessageStore::setFrom ( const std::string &  from_user,
const std::string &  from_auth 
)
overridevirtual

Override from GSmtp::ProtocolMessage.

Implements GSmtp::ProtocolMessage.

Definition at line 54 of file gprotocolmessagestore.cpp.


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