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

A Filter class that runs an external helper program. More...

#include <gexecutablefilter.h>

+ Inheritance diagram for GSmtp::ExecutableFilter:

Public Member Functions

 ExecutableFilter (GNet::ExceptionSink, FileStore &, bool server_side, const std::string &path, unsigned int timeout)
 Constructor. More...
 
 ~ExecutableFilter () override
 Destructor.
 
 ExecutableFilter (const ExecutableFilter &)=delete
 
 ExecutableFilter (ExecutableFilter &&)=delete
 
void operator= (const ExecutableFilter &)=delete
 
void operator= (ExecutableFilter &&)=delete
 
- Public Member Functions inherited from GSmtp::Filter
virtual ~Filter ()=default
 Destructor.
 
virtual std::string id () const =0
 Returns the id passed to the derived-class constructor. More...
 
virtual bool simple () const =0
 Returns true if the concrete filter class is one that can never change the file (eg. More...
 
virtual void start (const MessageId &)=0
 Starts the filter for the given message. More...
 
virtual G::Slot::Signal< int > & doneSignal ()=0
 Returns a signal which is raised once start() has completed or failed. More...
 
virtual void cancel ()=0
 Aborts any incomplete filtering.
 
virtual bool abandoned () const =0
 Returns true if the filter result was 'abandoned'.
 
virtual std::string response () const =0
 Returns a non-empty response string iff the filter failed, or an empty response if successful or abandoned.
 
virtual std::string reason () const =0
 Returns a non-empty reason string iff the filter failed, or an empty reason if successful or abandoned.
 
virtual bool special () const =0
 Returns true if the filter indicated special handling is required.
 
std::string str (bool server_side) const
 Returns a diagnostic string for logging. More...
 

Additional Inherited Members

- Public Types inherited from GSmtp::Filter
enum class  Result { f_ok = 0 , f_abandon = 1 , f_fail = 2 }
 

Detailed Description

A Filter class that runs an external helper program.

Definition at line 42 of file gexecutablefilter.h.

Constructor & Destructor Documentation

◆ ExecutableFilter()

GSmtp::ExecutableFilter::ExecutableFilter ( GNet::ExceptionSink  es,
FileStore file_store,
bool  server_side,
const std::string &  path,
unsigned int  timeout 
)

Constructor.

Definition at line 32 of file gexecutablefilter.cpp.


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