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	imapbackend "github.com/emersion/go-imap/backend"
23)
24
25// Storage interface is a slightly modified go-imap's Backend interface
26// (authentication is removed).
27//
28// Modules implementing this interface should be registered with prefix
29// "storage." in name.
30type Storage interface {
31	// GetOrCreateIMAPAcct returns User associated with storage account specified by
32	// the name.
33	//
34	// If it doesn't exists - it should be created.
35	GetOrCreateIMAPAcct(username string) (imapbackend.User, error)
36	GetIMAPAcct(username string) (imapbackend.User, error)
37
38	// Extensions returns list of IMAP extensions supported by backend.
39	IMAPExtensions() []string
40}
41
42// ManageableStorage is an extended Storage interface that allows to
43// list existing accounts, create and delete them.
44type ManageableStorage interface {
45	Storage
46
47	ListIMAPAccts() ([]string, error)
48	CreateIMAPAcct(username string) error
49	DeleteIMAPAcct(username string) error
50}