E-MailRelay

gmessageidfilter.h
Go to the documentation of this file.
1//
2// Copyright (C) 2001-2024 Graeme Walker <graeme_walker@users.sourceforge.net>
3//
4// This program is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with this program. If not, see <http://www.gnu.org/licenses/>.
16// ===
17///
18/// \file gmessageidfilter.h
19///
20
21#ifndef G_MESSAGE_ID_FILTER_H
22#define G_MESSAGE_ID_FILTER_H
23
24#include "gdef.h"
25#include "gsimplefilterbase.h"
26#include "gfilestore.h"
27#include "gstringview.h"
28#include "gexception.h"
29
30 namespace GFilters
31{
32 class MessageIdFilter ;
33}
34
35//| \class GFilters::MessageIdFilter
36/// A filter that adds a RFC-822 Message-ID to the message content if
37/// it does not have one already.
38///
39 class GFilters::MessageIdFilter : public SimpleFilterBase
40{
41 public:
42 G_EXCEPTION( Error , tx("failed to add message id to content file") )
43
44 MessageIdFilter( GNet::EventState , GStore::FileStore & ,
45 Filter::Type , const Filter::Config & , const std::string & spec ) ;
46 ///< Constructor.
47
48 static std::string process( const G::Path & , const std::string & domain ) ;
49 ///< Edits a content file by adding a message-id if necessary.
50 ///< Returns an error message on error.
51
52 private: // overrides
53 Result run( const GStore::MessageId & , bool & , GStore::FileStore::State ) override ;
54
55 private:
56 static bool isId( std::string_view ) noexcept ;
57 static std::string newId( const std::string & ) ;
58
59 private:
60 GStore::FileStore & m_store ;
61 std::string m_domain ;
62} ;
63
64#endif
GFilters::MessageIdFilter
A filter that adds a RFC-822 Message-ID to the message content if it does not have one already.
Definition: gmessageidfilter.h:40
GFilters::MessageIdFilter::process
static std::string process(const G::Path &, const std::string &domain)
Edits a content file by adding a message-id if necessary.
Definition: gmessageidfilter.cpp:49
GFilters::MessageIdFilter::MessageIdFilter
MessageIdFilter(GNet::EventState, GStore::FileStore &, Filter::Type, const Filter::Config &, const std::string &spec)
Constructor.
Definition: gmessageidfilter.cpp:32
GFilters::SimpleFilterBase
A GSmtp::Filter base class for filters that run synchronously.
Definition: gsimplefilterbase.h:43
GNet::EventState
A lightweight object containing an ExceptionHandler pointer, optional ExceptionSource pointer and opt...
Definition: geventstate.h:131
GStore::FileStore
A concrete implementation of the MessageStore interface dealing in paired flat files.
Definition: gfilestore.h:56
GStore::MessageId
A somewhat opaque identifer for a GStore::MessageStore message id.
Definition: gmessagestore.h:43
G::Path
A Path object represents a file system path.
Definition: gpath.h:82
gexception.h
gfilestore.h
gsimplefilterbase.h
gstringview.h
GFilters
Message filter classes.
Definition: gcopyfilter.h:31
G::tx
constexpr const char * tx(const char *p) noexcept
A briefer alternative to G::gettext_noop().
Definition: ggettext.h:84