.\" Generated by scdoc 1.11.3 .\" Complete documentation for this program is not available as a GNU info page .ie \n(.g .ds Aq \(aq .el .ds Aq ' .nh .ad l .\" Begin generated content: .TH "AERC-ACCOUNTS" "5" "2024-07-30" .PP .SH NAME .PP aerc-accounts - account configuration file format for \fBaerc\fR(1) .PP .SH SYNOPSIS .PP The \fIaccounts.\&conf\fR file is used for configuring each mail account used for aerc.\& It is expected to be in your XDG config home plus \fIaerc\fR, which defaults to \fI~/.\&config/aerc/accounts.\&conf\fR.\& This file must be kept secret, as it may include your account credentials.\& An alternate file can be specified via the \fI--accounts-conf\fR command line argument, see \fBaerc\fR(1).\& .PP If \fIaccounts.\&conf\fR does not exist, the \fB:new-account\fR configuration wizard will be executed automatically on first startup.\& .PP This file is written in the ini format where each \fB[section]\fR is the name of an account you want to configure, and the keys & values in that section specify details of that account'\&s configuration.\& Global options may be configured by placing them at the top of the file, before any account-specific sections.\& These can be overridden for an account by specifying them again in the account section.\& In addition to the options documented here, specific transports for incoming and outgoing emails may have additional configuration parameters, documented on their respective man pages.\& .PP .SH CONFIGURATION .PP Note that many of these configuration options are written for you, such as \fBsource\fR and \fBoutgoing\fR, when you run the account configuration wizard (\fB:new-account\fR).\& .PP \fBarchive\fR = \fI\fR .RS 4 Specifies a folder to use as the destination of the \fB:archive\fR command.\& .PP Default: \fIArchive\fR .PP .RE \fBcheck-mail\fR = \fI\fR .RS 4 Specifies an interval to check for new mail.\& Mail will be checked at startup, and every interval.\& IMAP accounts will check for mail in all unselected folders, and the selected folder will continue to receive PUSH mail notifications.\& Maildir/Notmuch folders must use \fBcheck-mail-cmd\fR in conjunction with this option.\& See \fBaerc-maildir\fR(5) and \fBaerc-notmuch\fR(5) for more information.\& .PP Setting this option to \fI0\fR will disable \fBcheck-mail\fR .PP Example: .RS 4 \fBcheck-mail\fR = \fI5m\fR .PP .RE Default: \fI0\fR .PP .RE \fBcopy-to\fR = \fI\fR .RS 4 Specifies a folder to copy sent mails to, usually \fISent\fR.\& .PP .RE \fBdefault\fR = \fI\fR .RS 4 Specifies the default folder to open in the message list when aerc configures this account.\& .PP Default: \fIINBOX\fR .PP .RE \fBfolders\fR = \fI\fR .RS 4 Specifies the comma separated list of folders to display in the sidebar.\& Names prefixed with \fI~\fR are interpreted as regular expressions.\& .PP By default, all folders are displayed.\& .PP .RE \fBfolders-exclude\fR = \fI\fR .RS 4 Specifies the comma separated list of folders to exclude from the sidebar.\& Names prefixed with \fI~\fR are interpreted as regular expressions.\& Note that this overrides anything from \fBfolders\fR.\& .PP By default, no folders are excluded.\& .PP .RE \fBenable-folders-sort\fR = \fItrue\fR|\fIfalse\fR .RS 4 If \fItrue\fR, folders are sorted, first by specified folders (see \fBfolders-sort\fR), then alphabetically.\& .PP Default: \fItrue\fR .PP .RE \fBfolders-sort\fR = \fI\fR .RS 4 Specifies a comma separated list of folders to be shown at the top of the list in the provided order.\& Remaining folders will be sorted alphabetically.\& .PP .RE \fBfolder-map\fR = \fI\fR .RS 4 The folder map contains a one-to-one mapping of server folders to displayed folder names.\& The \fBfolder-map\fR file expects a \fI\fR=\fI\fR[*] mapping per line (similar key=value syntax as for the \fBquery-map\fR in notmuch).\& The mappings are applied as they appear in the \fBfolder-map\fR.\& Supported backends: imap, maildir.\& .PP Note that other account options such as \fBarchive\fR, \fBdefault\fR, \fBcopy-to\fR, \fBpostpone\fR, \fBfolders\fR, \fBfolders-exclude\fR, \fBfolders-sort\fR need to be adjusted if one of those folders is affected by a folder mapping.\& .PP To apply the mapping to subfolders or folders with a similar prefix, append '\&*'\& to the server folder name.\& .PP Examples: .PP Remap a single folder: .nf .RS 4 Spam = [Gmail]/Spam .fi .RE .PP Remap the folder and all of its subfolders: .nf .RS 4 G = [Gmail]* .fi .RE .PP Remove a prefix for all subfolders: .nf .RS 4 * = [Gmail]/* .fi .RE .PP Remap all subfolders and avoid a folder collision: .nf .RS 4 Archive/existing = Archive* Archive = OldArchive* .fi .RE .PP .RE \fBfrom\fR = \fI
\fR .RS 4 The default value to use for the From header in new emails.\& This should be an RFC 5322-compatible string, such as \fIYour Name \fR.\& .PP .RE \fBaliases\fR = \fI\fR .RS 4 All aliases of the current account.\& These will be used to fill in the From: field.\& Make sure that your email server accepts this value, or for example use \fBaerc-sendmail\fR(5) in combination with \fBmsmtp\fR(1) and \fB--read-envelope-from\fR.\& .PP An alias can also use fnmatch-style wildcards in the address portion.\& These wildcards can be useful for catch-all addresses.\& For example, the alias \fI"Your Name" <*@you.\&com>\fR would ensure that when replying to emails addressed to \fIhi@you.\&com\fR and \fIcontact@you.\&com\fR, the From: field is set to \fIhi@you.\&com\fR and \fIcontact@you.\&com\fR, respectively.\& The name from the alias, not from the matching address, is used.\& .PP .RE \fBheaders\fR = \fI\fR .RS 4 Specifies the comma separated list of headers to fetch with the message.\& .PP By default, all headers are fetched.\& If any headers are specified in this list, aerc will append it to the following list of required headers: .PP .PD 0 .IP \(bu 4 date .IP \(bu 4 subject .IP \(bu 4 from .IP \(bu 4 sender .IP \(bu 4 reply-to .IP \(bu 4 to .IP \(bu 4 cc .IP \(bu 4 bcc .IP \(bu 4 in-reply-to .IP \(bu 4 message-id .IP \(bu 4 references .PD .PP .RE \fBheaders-exclude\fR = \fI\fR .RS 4 Specifies the comma separated list of headers to exclude from fetching.\& Note that this overrides anything from \fBheaders\fR.\& .PP By default, no headers are excluded.\& .PP .RE \fBoutgoing\fR = \fI\fR .RS 4 Specifies the transport for sending outgoing emails on this account.\& It should be a connection string, and the specific meaning of each component varies depending on the protocol in use.\& See each protocol'\&s man page for more details: .PP .PD 0 .IP \(bu 4 \fBaerc-sendmail\fR(5) .IP \(bu 4 \fBaerc-smtp\fR(5) .PD .PP .RE \fBoutgoing-cred-cmd\fR = \fI\fR .RS 4 Specifies an optional command that is run to get the outgoing account'\&s password.\& See each protocol'\&s man page for more details.\& .PP .RE \fBoutgoing-cred-cmd-cache\fR = \fItrue\fR|\fIfalse\fR .RS 4 By default, the credentials returned by the command will be cached until aerc is shut down.\& If set to \fIfalse\fR, \fBoutgoing-cred-cmd\fR will be executed every time an email is to be sent.\& .PP Default: \fItrue\fR .PP .RE \fBpgp-auto-sign\fR = \fItrue\fR|\fIfalse\fR .RS 4 If \fItrue\fR, all outgoing emails from this account will be signed (if a signing key is available).\& .PP Default: \fIfalse\fR .PP .RE \fBpgp-attach-key\fR = \fItrue\fR|\fIfalse\fR .RS 4 If \fItrue\fR, attach the public signing key to signed outgoing emails.\& .PP Default: \fIfalse\fR .PP .RE \fBpgp-self-encrypt\fR = \fItrue\fR|\fIfalse\fR .RS 4 If \fItrue\fR, any outgoing encrypted email will be also encrypted for the sender or the key specified in \fBpgp-key-id\fR.\& .PP Default: \fIfalse\fR .PP .RE \fBpgp-error-level\fR = \fInone\fR|\fIwarn\fR|\fIerror\fR .RS 4 The level of error to display when opportunistic encryption cannot be performed.\& See \fBpgp-opportunistic-encryption\fR.\& .PP Default: \fIwarn\fR .PP .RE \fBpgp-key-id\fR = \fI\fR .RS 4 Specify the key id to use when signing a message.\& Can be either short or long key id.\& If unset, aerc will look up the key by email.\& .PP .RE \fBpgp-opportunistic-encrypt\fR = \fItrue\fR|\fIfalse\fR .RS 4 If \fItrue\fR, any outgoing email from this account will be encrypted when all recipients (including Cc and Bcc field) have a public key available in the keyring.\& The level of error to display when a message can'\&t be encrypted can be configured with \fBpgp-error-level\fR.\& .PP Default: \fIfalse\fR .PP .RE \fBpostpone\fR = \fI\fR .RS 4 Specifies the folder to save postponed messages to.\& .PP Default: \fIDrafts\fR .PP .RE \fBsend-as-utc\fR = \fItrue\fR|\fIfalse\fR .RS 4 Converts the timestamp of the Date header to UTC.\& .PP Default: \fIfalse\fR .PP .RE \fBsend-with-hostname\fR = \fItrue\fR|\fIfalse\fR .RS 4 Uses the local hostname in outgoing Message-Id headers instead of your email address domain name.\& .PP Default: \fIfalse\fR .PP .RE \fBsource\fR = \fI\fR .RS 4 Specifies the source for reading incoming emails on this account.\& This key is required for all accounts.\& It should be a connection string, and the specific meaning of each component varies depending on the protocol in use.\& See each protocol'\&s man page for more details: .PP .PD 0 .IP \(bu 4 \fBaerc-imap\fR(5) .IP \(bu 4 \fBaerc-jmap\fR(5) .IP \(bu 4 \fBaerc-maildir\fR(5) .IP \(bu 4 \fBaerc-notmuch\fR(5) .PD .PP .RE \fBsource-cred-cmd\fR = \fI\fR .RS 4 Specifies an optional command that is run to get the source account'\&s password.\& See each protocol'\&s man page for more details.\& .PP .RE \fBsignature-file\fR = \fI\fR .RS 4 Specifies the file to read in order to obtain the signature to be added to emails sent from this account.\& .PP Please note that by convention the Usenet signature style of two dashes, followed by a space ("-- ") should be placed at the top of the signature to separate content and signature.\& Aerc will add that delimiter if it is not already present.\& .PP .RE \fBsignature-cmd\fR = \fI\fR .RS 4 Specifies the command to execute with \fIsh -c\fR in order to obtain the signature to be added to emails sent from this account.\& If the command fails then \fBsignature-file\fR is used instead.\& .PP .RE \fBtrusted-authres\fR = \fI\fR .RS 4 Comma-separated list of trustworthy hostnames from which the Authentication Results header will be displayed.\& Entries can be regular expressions.\& If you want to trust any host (e.\&g.\& for debugging), use the wildcard \fI*\fR.\& .PP .RE \fBsubject-re-pattern\fR = \fI\fR .RS 4 When replying to a message, this is the regular expression that will be used to match the prefix of the original message'\&s subject that has to be removed, to create the subject line of the new message.\& Typically, this will be used to avoid a repetition of the Re: prefix in the subject header.\& The default will match known translations for the common Re:.\& .PP Default: \fI(?\&i)^((AW|RE|SV|VS|ODP|R): ?\&)+\fR .PP .RE .SH SEE ALSO .PP \fBaerc\fR(1) \fBaerc-config\fR(5) \fBaerc-imap\fR(5) \fBaerc-jmap\fR(5) \fBaerc-maildir\fR(5) \fBaerc-notmuch\fR(5) \fBaerc-sendmail\fR(5) \fBaerc-smtp\fR(5) .PP .SH AUTHORS .PP Originally created by Drew DeVault and maintained by Robin Jarry who is assisted by other open source contributors.\& For more information about aerc development, see \fIhttps://sr.\&ht/~rjarry/aerc/\fR.\&