Mirrors/go-inbucket
1
0
Fork 0
mirror of https://github.com/jhillyerd/inbucket.git synced 2025-12-17 09:37:02 +00:00
Code Issues Releases Wiki Activity

config: Document MailboxNaming for #33

Browse Source
This commit is contained in:
James Hillyerd
2018-04-07 15:53:44 -07:00
parent a40c92d221
commit 7a783efd5d
2 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
doc/config.md
View File

@@ -9,6 +9,7 @@ variables it supports:
KEY DEFAULT DESCRIPTION KEY DEFAULT DESCRIPTION
INBUCKET_LOGLEVEL info debug, info, warn, or error INBUCKET_LOGLEVEL info debug, info, warn, or error
INBUCKET_MAILBOXNAMING local Use local or full addressing
INBUCKET_SMTP_ADDR 0.0.0.0:2500 SMTP server IP4 host:port INBUCKET_SMTP_ADDR 0.0.0.0:2500 SMTP server IP4 host:port
INBUCKET_SMTP_DOMAIN inbucket HELO domain INBUCKET_SMTP_DOMAIN inbucket HELO domain
INBUCKET_SMTP_MAXRECIPIENTS 200 Maximum RCPT TO per message INBUCKET_SMTP_MAXRECIPIENTS 200 Maximum RCPT TO per message
@@ -53,6 +54,30 @@ off with `warn` or `error`.
- Default: `info` - Default: `info`
- Values: one of `debug`, `info`, `warn`, or `error` - Values: one of `debug`, `info`, `warn`, or `error`
### Mailbox Naming
`INBUCKET_MAILBOXNAMING`
The mailbox naming setting determines the name of a mailbox for an incoming
message, and thus where it must be retrieved from later.
#### `local` ensures the domain is removed, such that:
- `james@inbucket.org` is stored in `james`
- `james+spam@inbucket.org` is stored in `james`
#### `full` retains the domain as part of the name, such that:
- `james@inbucket.org` is stored in `james@inbucket.org`
- `james+spam@inbucket.org` is stored in `james@inbucket.org`
Prior to the addition of the mailbox naming setting, Inbucket always operated in
local mode. Regardless of this setting, the `+` wildcard/extension is not
incorporated into the mailbox name.
- Default: `local`
- Values: one of `local` or `full`
## SMTP ## SMTP
@@ -350,12 +375,12 @@ separated list of key:value pairs.
- Default: None - Default: None
- Examples: `maxkb=10240` or `path=/tmp/inbucket` - Examples: `maxkb=10240` or `path=/tmp/inbucket`
#### file parameters #### `file` type parameters
- `path`: Operating system specific path to the directory where mail should be - `path`: Operating system specific path to the directory where mail should be
stored. stored.
#### memory parameters #### `memory` type parameters
- `maxkb`: Maximum size of the mail store in kilobytes. The oldest messages in - `maxkb`: Maximum size of the mail store in kilobytes. The oldest messages in
the store will be deleted to enforce the limit. In-memory storage has some the store will be deleted to enforce the limit. In-memory storage has some

2
pkg/config/config.go
View File

@@ -56,7 +56,7 @@ func (n *mbNaming) Decode(v string) error {
// Root contains global configuration, and structs with for specific sub-systems. // Root contains global configuration, and structs with for specific sub-systems.
type Root struct { type Root struct {
LogLevel string `required:"true" default:"info" desc:"debug, info, warn, or error"` LogLevel string `required:"true" default:"info" desc:"debug, info, warn, or error"`
MailboxNaming mbNaming `required:"true" default:"local" desc:"local or full"` MailboxNaming mbNaming `required:"true" default:"local" desc:"Use local or full addressing"`
SMTP SMTP SMTP SMTP
POP3 POP3 POP3 POP3
Web Web Web Web