E-MailRelay

gcopyfilter.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 gcopyfilter.h
19///
20
21#ifndef G_COPY_FILTER_H
22#define G_COPY_FILTER_H
23
24#include "gdef.h"
25#include "gsimplefilterbase.h"
26#include "gfilestore.h"
27#include "genvelope.h"
28#include "gexception.h"
29
30 namespace GFilters
31{
32 class CopyFilter ;
33}
34
35//| \class GFilters::CopyFilter
36/// A concrete GSmtp::Filter class that copies the message to all
37/// pre-existing sub-directories of the spool directory. This is
38/// similar to the 'emailrelay-filter-copy' utility.
39///
40 class GFilters::CopyFilter : public SimpleFilterBase
41{
42 public:
43 G_EXCEPTION( Error , tx("copy filter failed to copy message files into sub-directory") )
44
45 CopyFilter( GNet::EventState es , GStore::FileStore & ,
46 Filter::Type , const Filter::Config & , const std::string & spec ) ;
47 ///< Constructor.
48
49 private: // overrides
50 Result run( const GStore::MessageId & , bool & , GStore::FileStore::State ) override ;
51
52 private:
53 using FileOp = GStore::FileStore::FileOp ;
54 GStore::FileStore & m_store ;
55 Filter::Config m_filter_config ;
56 std::string m_spec ;
57 bool m_pop_by_name {false} ;
58 bool m_hardlink {false} ;
59 bool m_no_delete {false} ;
60} ;
61
62#endif
GFilters::CopyFilter
A concrete GSmtp::Filter class that copies the message to all pre-existing sub-directories of the spo...
Definition: gcopyfilter.h:41
GFilters::CopyFilter::CopyFilter
CopyFilter(GNet::EventState es, GStore::FileStore &, Filter::Type, const Filter::Config &, const std::string &spec)
Constructor.
Definition: gcopyfilter.cpp:30
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
genvelope.h
gexception.h
gfilestore.h
gsimplefilterbase.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
GStore::FileStore::FileOp
Low-level file-system operations for GStore::FileStore.
Definition: gfilestore.h:76