E-MailRelay
Public Member Functions | Static Public Member Functions | List of all members
GFilters::MessageIdFilter Class Reference

A filter that adds a RFC-822 Message-ID to the message content if it does not have one already. More...

#include <gmessageidfilter.h>

+ Inheritance diagram for GFilters::MessageIdFilter:
+ Collaboration diagram for GFilters::MessageIdFilter:

Public Member Functions

 MessageIdFilter (GNet::EventState, GStore::FileStore &, Filter::Type, const Filter::Config &, const std::string &spec)
 Constructor. More...
 
- Public Member Functions inherited from GFilters::SimpleFilterBase
 SimpleFilterBase (GNet::EventState, Filter::Type, std::string_view id)
 Constructor. More...
 
virtual Result run (const GStore::MessageId &, bool &special_out, GStore::FileStore::State)=0
 Runs the filter synchronously and returns the result.
 
std::string prefix () const
 Returns a logging prefix derived from Filter::Type and filter id. More...
 
- 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 quiet () const =0
 Returns true if there is no need for logging.
 
virtual void start (const GStore::MessageId &)=0
 Starts the filter for the given message. More...
 
virtual G::Slot::Signal< int > & doneSignal () noexcept=0
 Returns a signal which is raised once start() has completed or failed. More...
 
virtual void cancel ()=0
 Aborts any incomplete filtering.
 
virtual Result result () const =0
 Returns the filter result, after the doneSignal() has been emitted.
 
virtual std::string response () const =0
 Returns a non-empty SMTP response string iff the filter failed, or an empty response if successful or abandoned.
 
virtual int responseCode () const =0
 An override for the SMTP response code for when the filter has failed. More...
 
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 (Type type) const
 Returns a diagnostic string for logging, including the filter result. More...
 

Static Public Member Functions

static std::string process (const G::Path &, const std::string &domain)
 Edits a content file by adding a message-id if necessary. More...
 
- Static Public Member Functions inherited from GSmtp::Filter
static std::string_view strtype (Type type) noexcept
 Returns a type string for logging: "filter", "client-filter" or "routing-filter". More...
 

Additional Inherited Members

- Public Types inherited from GSmtp::Filter
enum class  Result { ok = 0 , abandon = 1 , fail = 2 }
 
enum class  Type { server , client , routing }
 

Detailed Description

A filter that adds a RFC-822 Message-ID to the message content if it does not have one already.

Definition at line 39 of file gmessageidfilter.h.

Constructor & Destructor Documentation

◆ MessageIdFilter()

GFilters::MessageIdFilter::MessageIdFilter ( GNet::EventState  es,
GStore::FileStore store,
Filter::Type  filter_type,
const Filter::Config &  config,
const std::string &  spec 
)

Constructor.

Definition at line 32 of file gmessageidfilter.cpp.

Member Function Documentation

◆ process()

std::string GFilters::MessageIdFilter::process ( const G::Path path_in,
const std::string &  domain 
)
static

Edits a content file by adding a message-id if necessary.

Returns an error message on error.

Definition at line 49 of file gmessageidfilter.cpp.


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