vomit(5)

# NAME

vomit - The vomit configuration file

# DESCRIPTION

The configuration file contains all the necessary configuration for vmt to work
properly. It is written in the TOML file format.

Defining at least one *account* is necessary for knowing where the directory
that stores mail is located.

# ACCOUNT SECTION

This section can be specified multiple times, each corresponding to a single
account. The name of the section is the name used for the account.

Each account section of the configuration file defines 5 attributes:

*local* _String_
	The local path to the mailbox. A shorthand *~* in the path can be used for
	a user's home directory.

	The path shall be a directory that has mail stored in the Maildir++ format.

*remote* _String_
	The remote address of the IMAP account. This is given in the format
	"*domain*:*port*"

*user* _String_
	The username to login to the IMAP account.

*password* _String_
	The password to login to the IMAP account.

	Use either this or the *pass-cmd* attribute.

*pass-cmd* _String_
	Get the password for the account by providing a command that outputs the
	password to stdout.
	Use either this or the *password* attribute.

The attributes *remote*, *user*, and *password*/*pass-cmd* are only needed if
*vmt-sync*(1) is intended to be used.

# EXAMPLE CONFIGURATION FILE

```
[foo]
local = ~/.maildir
# Everything below is only needed if you intend to use `vmt sync`
remote = "imap.example.com:993"
user = "myusername"
pass-cmd = "pass show mail/myaccount"
# or use this:
#password = "s3cr34"
```

# SEE ALSO

*vmt*(1), *vmt-att*(1), *vmt-cat*(1), *vmt-hdr*(1), *vmt-ls*(1), *vmt-mime*(1),
*vmt-pick*(1), *vmt-show*(1), *vmt-sync*(1)

## TOML
https://toml.io/en/

## Maildir++
http://www.courier-mta.org/imap/README.maildirquota.html

# AUTHORS

Maintained by Conrad Hoffmann <ch@bitfehler.net>. vmt is part of the Vomit
project. You can find more information and source code at
https://sr.ht/~bitfehler/vomit. Bugs/patches can be submitted by email to the
vomit mailing list at ~bitfehler/vomit@lists.sr.ht (see
https://lists.sr.ht/~bitfehler/vomit for more information).