mirror of
https://github.com/foxcpp/maddy.git
synced 2025-04-05 22:17:39 +03:00
142 lines
4.1 KiB
Markdown
142 lines
4.1 KiB
Markdown
maddy-targets(5) "maddy mail server" "maddy reference documentation"
|
|
|
|
; TITLE Storage backends
|
|
|
|
maddy storage interface is built with IMAP in mind and directly represents
|
|
IMAP data model. That is, maddy storage does have the concept of folders,
|
|
flags, message UIDs, etc defined as in RFC 3501.
|
|
|
|
This man page lists supported storage backends along with supported
|
|
configuration directives for each.
|
|
|
|
Most likely, you are going to use modules listed here in 'storage' directive
|
|
for IMAP endpoint module (see *maddy-imap*(5)).
|
|
|
|
In most cases, local storage modules will auto-create accounts when they are
|
|
accessed via IMAP. This relies on authentication provider used by IMAP endpoint
|
|
to provide what essentially is access control. There is a caveat, however: this
|
|
auto-creation will not happen when delivering incoming messages via SMTP as
|
|
there is no authentication to confirm that this account should indeed be
|
|
created.
|
|
|
|
# SQL-based database module (storage.imapsql)
|
|
|
|
The imapsql module implements unified database for IMAP index and message
|
|
metadata using SQL-based relational database.
|
|
|
|
Message contents are stored in an "external store", currently the only
|
|
supported "external store" is a filesystem directory, used by default.
|
|
By default, all messages are stored in StateDirectory/messages under random IDs.
|
|
|
|
Supported RDBMS:
|
|
- SQLite 3.25.0
|
|
- PostgreSQL 9.6 or newer
|
|
|
|
Account names are required to have the form of a email address and are
|
|
case-insensitive. UTF-8 names are supported with restrictions defined in the
|
|
PRECIS UsernameCaseMapped profile.
|
|
|
|
```
|
|
storage.imapsql {
|
|
driver sqlite3
|
|
dsn imapsql.db
|
|
}
|
|
```
|
|
|
|
imapsql module also can be used as a lookup table (*maddy-table*(5)).
|
|
It returns empty string values for existing usernames. This might be useful
|
|
with destination_in directive (*maddy-smtp*(5)) e.g. to implement catch-all
|
|
addresses (this is a bad idea to do so, this is just an example):
|
|
```
|
|
destination_in &local_mailboxes {
|
|
deliver_to &local_mailboxes
|
|
}
|
|
destination_in example.org {
|
|
modify {
|
|
replace_rcpt regexp ".*" "catchall@example.org"
|
|
}
|
|
deliver_to &local_mailboxes
|
|
}
|
|
```
|
|
|
|
|
|
## Arguments
|
|
|
|
Specify the driver and DSN.
|
|
|
|
## Configuration directives
|
|
|
|
*Syntax*: driver _string_ ++
|
|
*Default*: not specified
|
|
|
|
REQUIRED.
|
|
|
|
Use a specified driver to communicate with the database. Supported values:
|
|
sqlite3, postgres.
|
|
|
|
Should be specified either via an argument or via this directive.
|
|
|
|
*Syntax*: dsn _string_ ++
|
|
*Default*: not specified
|
|
|
|
REQUIRED.
|
|
|
|
Data Source Name, the driver-specific value that specifies the database to use.
|
|
|
|
For SQLite3 this is just a file path.
|
|
For PostgreSQL: https://godoc.org/github.com/lib/pq#hdr-Connection_String_Parameters
|
|
|
|
Should be specified either via an argument or via this directive.
|
|
|
|
*Syntax*: fsstore _directory_ ++
|
|
*Default*: messages/
|
|
|
|
Directory to store message contents in.
|
|
|
|
*Syntax*: ++
|
|
compression off ++
|
|
compression _algorithm_ ++
|
|
compression _algorithm_ _level_ ++
|
|
*Default*: off
|
|
|
|
Apply compression to message contents.
|
|
Supported algorithms: lz4, zstd.
|
|
|
|
*Syntax*: appendlimit _size_ ++
|
|
*Default*: 32M
|
|
|
|
Don't allow users to add new messages larger than 'size'.
|
|
|
|
This does not affect messages added when using module as a delivery target.
|
|
Use 'max_message_size' directive in SMTP endpoint module to restrict it too.
|
|
|
|
*Syntax*: debug _boolean_ ++
|
|
*Default*: global directive value
|
|
|
|
Enable verbose logging.
|
|
|
|
*Syntax*: junk_mailbox _name_ ++
|
|
*Default*: Junk
|
|
|
|
The folder to put quarantined messages in. Thishis setting is not used if user
|
|
does have a folder with "Junk" special-use attribute.
|
|
|
|
*Syntax*: sqlite_exclusive_lock _boolean_ ++
|
|
*Default*: no
|
|
|
|
SQLite-specific performance tuning option. Slightly decereases ovehead of
|
|
DB locking at cost of making DB inaccessible for other processes (including
|
|
maddyctl utility).
|
|
|
|
*Syntax*: sqlite_cache_size _integer_ ++
|
|
*Default*: defined by SQLite
|
|
|
|
SQLite page cache size. If positive - specifies amount of pages (1 page - 4
|
|
KiB) to keep in cache. If negative - specifies approximate upper bound
|
|
of cache size in KiB.
|
|
|
|
*Syntax*: sqlite_busy_timeout _integer_ ++
|
|
*Default*: 5000000
|
|
|
|
SQLite-specific performance tuning option. Amount of milliseconds to wait
|
|
before giving up on DB lock.
|