E-MailRelay
|
A concrete GSmtp::Filter class for message routing: if the message has recipients for multiple domains then it is split up into a separate message for each domain, with the forward-to envelope field containing the domain name. More...
#include <gsplitfilter.h>
Public Member Functions | |
SplitFilter (GNet::EventState es, GStore::FileStore &, Filter::Type, const Filter::Config &, const std::string &spec) | |
Constructor. More... | |
![]() | |
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... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
enum class | Result { ok = 0 , abandon = 1 , fail = 2 } |
enum class | Type { server , client , routing } |
![]() | |
static std::string_view | strtype (Type type) noexcept |
Returns a type string for logging: "filter", "client-filter" or "routing-filter". More... | |
A concrete GSmtp::Filter class for message routing: if the message has recipients for multiple domains then it is split up into a separate message for each domain, with the forward-to envelope field containing the domain name.
Definition at line 38 of file gsplitfilter.h.
GFilters::SplitFilter::SplitFilter | ( | GNet::EventState | es, |
GStore::FileStore & | store, | ||
Filter::Type | filter_type, | ||
const Filter::Config & | filter_config, | ||
const std::string & | spec | ||
) |
Constructor.
Definition at line 34 of file gsplitfilter.cpp.