config.toml: accounts

This page lists every key of the [[accounts.mail]] and [[accounts.chat]] tables, and the settings that each protocol reads.

Check a file after every change: tcli check names a key that does not exist, a value of the wrong type and a missing key, with its line.

tcli check

Every string can be expanded: ${NAME} reads an environment variable and #{command} runs a command and uses what it prints. Write a password as #{command}, never in the clear. How to write the accounts is on Mail accounts and Chat accounts.

[[accounts.mail]]

Key	Type	Default	Meaning
id	text	required	The id of the account, used by --account. Used once among the mail accounts.
name	text	required	The label of the account.
address	text	required	The address the account sends from.
display_name	text	empty	The name shown with the address.
gpg_key	text	the key of address	The OpenPGP key that signs: a fingerprint, a long key id (0xFE67774DF63A2BB6) or an address.
store	table	required	How the account reads mail.
transport	table	required	How the account sends mail.

[[accounts.chat]]

Key	Type	Default	Meaning
id	text	required	The id of the account. Used once among the chat accounts.
name	text	required	The label of the account.
connection	table	required	How the account connects.

store, transport and connection

The three tables have the same keys.

Key	Type	Default	Meaning
protocol	text	required	The plugin that handles it: imap or maildir for a store, smtp for a transport, irc or xmpp for a connection.
username	text	none	The user name of the login. A password needs a user name.
password	text	none	The password, as #{command} or ${NAME}.
settings	table	empty	The settings of the protocol, in the tables below.

Settings of imap and smtp

Key	Type	Default	Meaning
host	text	required	The name or address of the server.
port	number	imap: 143, or 993 with tls; smtp: 587, or 465 with tls	The TCP port, 1 to 65535.
security	text	auto	auto, none, starttls or tls. auto follows the port (TLS on 993 and 465, STARTTLS otherwise) and never falls back to clear text.

Both need username.

Settings of maildir

Key	Type	Default	Meaning
path	text	required	The folder of the mailbox; a leading ~ is the home folder.
layout	text	nested	nested or maildir++.

The mbox plugin of the repository reads path too, but tcli and tt do not load it: see Mail accounts.

Settings of every mail store

Key	Type	Default	Meaning
cache	text or boolean	on	false, no, off or 0 keeps the account out of the mail cache. See config.toml: cache, pgp.

Settings of irc

username is the nick.

Key	Type	Default	Meaning
host	text	required	The server.
port	number	6697, or 6667 with none	The TCP port, 1 to 65535.
security	text	auto	auto, none or tls. auto always encrypts.
auth	text	sasl with a password, none without	none, sasl or pass. sasl and pass need a password.
account	text	the nick	The account of the SASL login.
reconnect	boolean	true	Connects again after a lost connection.
channels	text	none	Channels to join after every connect, separated by commas, at most 100.
user	text	the nick	The user name of the registration.
realname	text	the nick	The real name of the registration.

Settings of xmpp

username is the bare JID (user@domain) and password is required.

Key	Type	Default	Meaning
host	text	the domain of the JID	The server.
port	number	5222, or 5223 with tls	The TCP port, 1 to 65535.
security	text	auto	auto, none, starttls or tls. auto always encrypts.
resource	text	tilde	The name of this client among the ones of the same account.
nick	text	the user part of the JID	The nick in group chats.

The code of each table is in MailAccountConfig.cs, ProtocolConfig.cs and the Data folder of each plugin, such as IrcSettings.cs.