ca.desrt.dconf or dconf.service?+
ca.desrt.dconf or dconf.service?This manual will eventually describe how to install, use, and extend Home Manager.
diff --git a/options.html b/options.html index 8c7667140..4ac08aeab 100644 --- a/options.html +++ b/options.html @@ -64,6 +64,8 @@ For NixOS, the default value for this option includes at least this argument: <home-manager/modules/programs/notmuch.nix>
<home-manager/modules/programs/neomutt.nix>
+
+ <home-manager/modules/programs/mujmap.nix>
<home-manager/modules/programs/mu.nix>
@@ -140,7 +142,7 @@ special treatment. This option is therefore intended to
indicate the nature of the provider.
When this indicates a specific provider then, for example,
-the IMAP and SMTP server configuration may be set
+the IMAP, SMTP, and JMAP server configuration may be set
automatically.
Type: one of "plain", "gmail.com", "runbox.com", "fastmail.com"
Default: "plain"
Declared by:
<home-manager/modules/accounts/email.nix>
@@ -273,6 +275,23 @@ Note, if set then the system default may still be accepted.
}
Declared by:
<home-manager/modules/services/imapnotify.nix>
+
accounts.email.accounts.<name>.jmapThe JMAP configuration to use for this account.
+
Type: null or submodule
Default: null
Declared by:
+ <home-manager/modules/accounts/email.nix>
+
accounts.email.accounts.<name>.jmap.hostHostname of JMAP server.
+
+If both this option and accounts.email.accounts.<name>.jmap.sessionUrl are specified,
+host is preferred by applications when establishing a
+session.
+
Type: null or string
Default: null
Example: "jmap.example.org"
Declared by:
+ <home-manager/modules/accounts/email.nix>
+
accounts.email.accounts.<name>.jmap.sessionUrlURL for the JMAP Session resource.
+
+If both this option and accounts.email.accounts.<name>.jmap.host are specified,
+host is preferred by applications when establishing a
+session.
+
Type: null or string
Default: null
Example: "https://jmap.example.org:443/.well-known/jmap"
Declared by:
+ <home-manager/modules/accounts/email.nix>
accounts.email.accounts.<name>.lieer.enableWhether to enable lieer Gmail synchronization for notmuch.
Type: boolean
Default: false
Example: true
Declared by:
<home-manager/modules/programs/lieer.nix>
accounts.email.accounts.<name>.lieer.notmuchSetupWarningWarn if Notmuch is not also enabled for this account.
@@ -536,6 +555,126 @@ The fingerprint can be obtained by executing
<home-manager/modules/programs/msmtp.nix>
accounts.email.accounts.<name>.mu.enableWhether to enable mu indexing.
Type: boolean
Default: false
Example: true
Declared by:
<home-manager/modules/programs/mu.nix>
+
accounts.email.accounts.<name>.mujmap.enableWhether to enable mujmap JMAP synchronization for notmuch.
Type: boolean
Default: false
Example: true
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.notmuchSetupWarningWarn if Notmuch is not also enabled for this account.
+
+This can safely be disabled if mujmap.toml is managed
+outside of Home Manager.
+
Type: boolean
Default: true
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settingsSettings which are applied to mujmap.toml
+for the account.
+
+See the mujmap project
+for documentation of settings not explicitly covered by this module.
+
Type: TOML value
Default:
+ {
+
+ }
+
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.auto_create_new_mailboxesWhether to create new mailboxes automatically on the server from notmuch
+tags.
+
Type: boolean
Default: true
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.cache_dirThe cache directory in which to store mail files while they are being
+downloaded. The default is operating-system specific.
+
Type: null or string
Default: null
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.fqdnFully qualified domain name of the JMAP service.
+
+mujmap looks up the JMAP SRV record for this host to determine the JMAP session
+URL. Mutually exclusive with
+accounts.email.accounts.<name>.mujmap.settings.session_url.
+
+If null, defaults to
+accounts.email.accounts.<name>.jmap.host.
+
Type: null or string
Default: null
Example: "example.com"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.password_commandShell command which will print a password to stdout for basic HTTP
+authentication.
+
+If null, defaults to
+accounts.email.accounts.<name>.passwordCommand.
+
Type: null or string or list of string
Default: null
Example: "pass alice@example.com"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.session_urlSesion URL to connect to.
+
+Mutually exclusive with
+accounts.email.accounts.<name>.mujmap.settings.fqdn.
+
+If null, defaults to
+accounts.email.accounts.<name>.jmap.sessionUrl.
+
Type: null or string
Default: null
Example: "https://jmap.example.com/.well-known/jmap"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.tagsTag configuration.
+
+Beware that there are quirks that require manual consideration if changing the
+values of these files; please see
+https://github.com/elizagamedev/mujmap/blob/main/mujmap.toml.example
+for more details.
+
Type: TOML value
Default:
+ {
+
+ }
+
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.tags.deletedTag for notmuch to use for messages stored in the mailbox labeled with the
+Trash name attribute.
+
+If set to an empty string, this mailbox and its child
+mailboxes are not synchronized with a tag.
+
Type: string
Default: "deleted"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.tags.directory_separatorDirectory separator for mapping notmuch tags to maildirs.
+
Type: string
Default: "/"
Example: "."
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.tags.importantTag for notmuch to use for messages stored in the mailbox labeled with the
+Important name attribute and/or with the $Important
+keyword.
+
+If set to an empty string, this mailbox, its child
+mailboxes, and these keywords are not synchronized with a tag.
+
Type: string
Default: "important"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.tags.inboxTag for notmuch to use for messages stored in the mailbox labeled with the
+Inbox name attribute.
+
+If set to an empty string, this mailbox and its child
+mailboxes are not synchronized with a tag.
+
Type: string
Default: "inbox"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.tags.lowercaseIf true, translate all mailboxes to lowercase names when mapping to notmuch
+tags.
+
Type: boolean
Default: false
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.tags.phishingTag for notmuch to use for the IANA $Phishing keyword.
+
+If set to an empty string, this keyword is not synchronized with a tag.
+
Type: string
Default: "phishing"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.tags.sentTag for notmuch to use for messages stored in the mailbox labeled with the
+Sent name attribute.
+
+If set to an empty string, this mailbox and its child
+mailboxes are not synchronized with a tag.
+
Type: string
Default: "sent"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.tags.spamTag for notmuch to use for messages stored in the mailbox labeled with the
+Junk name attribute and/or with the $Junk keyword,
+except for messages with the $NotJunk keyword.
+
+If set to an empty string, this mailbox, its child
+mailboxes, and these keywords are not synchronized with a tag.
+
Type: string
Default: "spam"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
accounts.email.accounts.<name>.mujmap.settings.usernameUsername for basic HTTP authentication.
+
+If null, defaults to
+accounts.email.accounts.<name>.userName.
+
Type: null or string
Default: null
Example: "alice@example.com"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
accounts.email.accounts.<name>.nameUnique identifier of the account. This is set to the
attribute name of the account configuration.
Type: string (read only)
Declared by:
@@ -660,7 +799,7 @@ Note, if set then the system default may still be accepted.
Type: boolean
Default: false
Declared by:
<home-manager/modules/accounts/email.nix>
accounts.email.accounts.<name>.userNameThe server username of this account. This will be used as
-the SMTP and IMAP user name.
+the SMTP, IMAP, and JMAP user name.
Type: null or string
Default: null
Declared by:
<home-manager/modules/accounts/email.nix>
accounts.email.certificatesFilePath to default file containing certificate authorities that
@@ -5057,6 +5196,11 @@ Account commands should be placed in
<home-manager/modules/programs/msmtp.nix>
programs.mu.enableWhether to enable mu, a maildir indexer and searcher.
Type: boolean
Default: false
Example: true
Declared by:
<home-manager/modules/programs/mu.nix>
+
programs.mujmap.enableWhether to enable mujmap Gmail synchronization for notmuch.
Type: boolean
Default: false
Example: true
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
+
programs.mujmap.packagemujmap package to use.
+
Type: package
Default: "pkgs.mujmap"
Declared by:
+ <home-manager/modules/programs/mujmap.nix>
programs.navi.enableWhether to enable Navi.
Type: boolean
Default: false
Example: true
Declared by:
<home-manager/modules/programs/navi.nix>
programs.navi.enableBashIntegrationWhether to enable Bash integration.
Type: boolean
Default: true
Example: true
Declared by: