maddy

 1/*
 2Maddy Mail Server - Composable all-in-one email server.
 3Copyright © 2019-2020 Max Mazurov <fox.cpp@disroot.org>, Maddy Mail Server contributors
 4
 5This program is free software: you can redistribute it and/or modify
 6it under the terms of the GNU General Public License as published by
 7the Free Software Foundation, either version 3 of the License, or
 8(at your option) any later version.
 9
10This program is distributed in the hope that it will be useful,
11but WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License
16along with this program.  If not, see <https://www.gnu.org/licenses/>.
17*/
18
19package module
20
21import (
22	"github.com/emersion/go-message/textproto"
23	"github.com/foxcpp/maddy/framework/buffer"
24)
25
26// IMAPFilter is interface used by modules that want to modify IMAP-specific message
27// attributes on delivery.
28//
29// Modules implementing this interface should be registered with namespace prefix
30// "imap.filter".
31type IMAPFilter interface {
32	// IMAPFilter is called when message is about to be stored in IMAP-compatible
33	// storage. It is called only for messages delivered over SMTP, hdr and body
34	// contain the message exactly how it will be stored.
35	//
36	// Filter can change the target directory by returning non-empty folder value.
37	// Additionally it can add additional IMAP flags to the message by returning
38	// them.
39	//
40	// Errors returned by IMAPFilter will be just logged and will not cause delivery
41	// to fail.
42	IMAPFilter(accountName string, rcptTo string, meta *MsgMetadata, hdr textproto.Header, body buffer.Buffer) (folder string, flags []string, err error)
43}