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	"context"
23
24	"github.com/emersion/go-message/textproto"
25	"github.com/foxcpp/maddy/framework/buffer"
26)
27
28// StatusCollector is an object that is passed by message source
29// that is interested in intermediate status reports about partial
30// delivery failures.
31type StatusCollector interface {
32	// SetStatus sets the error associated with the recipient.
33	//
34	// rcptTo should match exactly the value that was passed to the
35	// AddRcpt, i.e. if any translations was made by the target,
36	// they should not affect the rcptTo argument here.
37	//
38	// It should not be called multiple times for the same
39	// value of rcptTo. It also should not be called
40	// after BodyNonAtomic returns.
41	//
42	// SetStatus is goroutine-safe. Implementations
43	// provide necessary serialization.
44	SetStatus(rcptTo string, err error)
45}
46
47// PartialDelivery is an optional interface that may be implemented
48// by the object returned by DeliveryTarget.Start. See PartialDelivery.BodyNonAtomic
49// documentation for details.
50type PartialDelivery interface {
51	// BodyNonAtomic is similar to Body method of the regular Delivery interface
52	// with the except that it allows target to reject the body only for some
53	// recipients by setting statuses using passed collector object.
54	//
55	// This interface is preferred by the LMTP endpoint and queue implementation
56	// to ensure correct handling of partial failures.
57	BodyNonAtomic(ctx context.Context, c StatusCollector, header textproto.Header, body buffer.Buffer)
58}