.\" 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-JMAP" "5" "2024-07-30" .PP .SH NAME .PP aerc-jmap - JMAP configuration for \fBaerc\fR(1) .PP .SH SYNOPSIS .PP aerc implements the JMAP protocol as specified by RFCs 8620 and 8621.\& .PP .SH CONFIGURATION .PP Basic JMAP configuration may be done interactively with the \fB:new-account\fR command.\& .PP In \fIaccounts.\&conf\fR (see \fBaerc-accounts\fR(5)), the following JMAP-specific options are available: .PP \fBsource\fR = \fI\fR://[\fI\fR][\fI:@\fR]\fI\fR[\fI:\fR]/\fI\fR .RS 4 Remember that all fields must be URL encoded.\& The \fI@\fR symbol, when URL encoded, is \fI%40\fR.\& .PP \fI\fR[\fI:\fR]/\fI\fR is the HTTPS JMAP session resource as specified in RFC 8620 section 2 without the leading \fIhttps://\fR scheme.\& .PP Possible values of \fI\fR are: .PP \fIjmap\fR .RS 4 JMAP over HTTPS using Basic authentication.\& .PP .RE \fIjmap+oauthbearer\fR .RS 4 JMAP over HTTPS using OAUTHBEARER authentication .PP The username is ignored and may be left empty.\& If specifying the password, make sure to prefix it with \fI:\fR to make it explicit that the username is empty.\& Or set the username to any random value.\& E.\&g.\&: .PP .nf .RS 4 source = jmap+oauthbearer://:s3cr3t@example\&.com/jmap/session source = jmap+oauthbearer://me:s3cr3t@example\&.com/jmap/session .fi .RE .PP .RE Your source credentials must have the \fIurn:ietf:params:jmap:mail\fR capability.\& .PP .RE \fBsource-cred-cmd\fR = \fI\fR .RS 4 Specifies the command to run to get the password for the JMAP account.\& This command will be run using \fIsh -c command\fR.\& If a password is specified in the \fBsource\fR option, the password will take precedence over this command.\& .PP Example: .RS 4 source-cred-cmd = pass hostname/username .PP .RE .RE \fBoutgoing\fR = \fIjmap://\fR .RS 4 The JMAP connection can also be used to send emails.\& No need to repeat the URL nor any credentials.\& Just the URL scheme will be enough.\& .PP Your source credentials must have the \fIurn:ietf:params:jmap:submission\fR capability.\& .PP .RE \fBcache-state\fR = \fItrue\fR|\fIfalse\fR .RS 4 Cache all email state (mailboxes, email headers, mailbox contents, email flags, etc.\&) on disk in a levelDB database located in folder \fI~/.\&cache/aerc//state\fR.\& .PP The cached data should remain small, in the order of a few megabytes, even for very large email stores.\& Aerc will make its best to purge deleted/outdated information.\& It is safe to delete that folder when aerc is not running and it will be recreated from scratch on next startup.\& .PP Default: \fIfalse\fR .PP .RE \fBcache-blobs\fR = \fItrue\fR|\fIfalse\fR .RS 4 Cache all downloaded email bodies and attachments on disk as individual files in \fI~/.\&cache/aerc//blobs//\fR (where \fI\fR is a subfolder named after the last two characters of \fI\fR).\& .PP Aerc will not purge the cached blobs automatically.\& Even when their related emails are destroyed permanently from the server.\& If required, you may want to run some periodic cleanup based on file creation date in a crontab, e.\&g.\&: .PP .RS 4 @daily find ~/.\&cache/aerc/foo/blobs -type f -mtime +30 -delete .PP .RE Default: \fIfalse\fR .PP .RE \fBuse-labels\fR = \fItrue\fR|\fIfalse\fR .RS 4 If set to \fItrue\fR, mailboxes with the \fIarchive\fR role (usually \fIArchive\fR) will be hidden from the directory list and replaced by an \fBall-mail\fR virtual folder.\& The name of that folder can be configured via the \fBall-mail\fR setting.\& .PP \fB:archive\fR \fIflat\fR may still be used to effectively "tag" messages with the hidden \fIArchive\fR mailbox so that they appear in the \fBall-mail\fR virtual folder.\& When the \fBall-mail\fR virtual folder is selected, \fB:archive\fR \fIflat\fR should not be used and will have no effect.\& The messages will be grayed out but will never be refreshed until aerc is restarted.\& .PP Also, this enables support for the \fB:modify-labels\fR (alias \fB:tag\fR) command.\& .PP Default: \fIfalse\fR .PP .RE \fBall-mail\fR = \fI\fR .RS 4 Name of the virtual folder that replaces the role=\fIarchive\fR mailbox when \fBuse-labels\fR = \fItrue\fR.\& .PP Default: \fIAll mail\fR .PP .RE \fBserver-ping\fR = \fI\fR .RS 4 Interval the server should ping the client at when monitoring for email changes.\& The server may choose to ignore this value.\& By default, no ping will be requested from the server.\& .PP See https://pkg.\&go.\&dev/time#ParseDuration.\& .PP .RE .SH NOTES .PP JMAP messages can be seen as "labels" or "tags".\& Every message must belong to one or more mailboxes (folders in aerc).\& Each mailbox has a "role" as described in \fIhttps://www.\&iana.\&org/assignments/imap-mailbox-name-attributes/\fR.\& .PP When deleting messages that belong only to the selected mailbox, aerc will attempt to "move" these messages to a mailbox with the \fItrash\fR role.\& If it cannot find such mailbox or if the selected mailbox is the \fItrash\fR mailbox, it will effectively destroy the messages from the server.\& .PP \fB:delete\fR removes messages from the selected mailbox and effectively does the same thing than \fB:tag -\fR.\& .PP \fB:cp \fR is an alias for \fB:tag \fR or \fB:tag +\fR.\& .PP \fB:mv \fR is a compound of \fB:delete\fR and \fB:mv\fR and can be seen as an alias of \fB:tag - +\fR.\& .PP \fB:archive\fR \fIflat\fR is an alias for \fB:tag - +\fR.\& .PP .SH SEE ALSO .PP \fBaerc\fR(1) \fBaerc-accounts\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.\&