+option can be used to pass additional arguments to all modules.Type: attribute set Default: { } Example: { inherit emacs-overlay; } Declared by: home-manager.sharedModulesExtra modules added to all users.
- Type: list of raw value Default: [ ] Example: [ { home.packages = [ nixpkgs-fmt ]; } ] Declared by: home-manager.sharedModulesExtra modules added to all users. Type: list of raw value Default: [ ] Example: [ { home.packages = [ nixpkgs-fmt ]; } ] Declared by: home-manager.useGlobalPkgsWhether to enable using the system configuration's pkgs
argument in Home Manager. This disables the Home Manager
@@ -19,8 +16,7 @@ options nixpkgs.*
users.users.<name>.packages option
. Type: boolean Default: false Example: true Declared by: home-manager.usersPer-user Home Manager configuration.
- Type: attribute set of (Home Manager module) Default: { } Declared by: home-manager.usersPer-user Home Manager configuration. Type: attribute set of (Home Manager module) Default: { } Declared by: home-manager.verboseWhether to enable verbose output on activation. Type: boolean Default: false Example: true Declared by: accounts.email.accounts.<name>.aerc.extraAccountsExtra config added to the configuration of this account in
$HOME/.config/aerc/accounts.conf.
-See aerc-config(5).
- Type: attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma) Default: { } Example: { source = "maildir://~/Maildir/example"; } Declared by:
+See aerc-config(5).Type: attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma) Default: { } Example: { source = "maildir://~/Maildir/example"; } Declared by: accounts.email.accounts.<name>.aerc.extraBindsExtra bindings specific to this account, added to
$HOME/.config/aerc/accounts.conf.
-See aerc-config(5).
- Type: attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma) Default: { } Example: { messages = { d = ":move ${folder.trash}<Enter>"; }; } Declared by:
+See aerc-config(5).Type: attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma) Default: { } Example: { messages = { d = ":move ${folder.trash}<Enter>"; }; } Declared by: accounts.email.accounts.<name>.aerc.extraConfigExtra config specific to this account, added to
$HOME/.config/aerc/aerc.conf.
-See aerc-config(5).
- Type: attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma) Default: { } Example: { ui = { sidebar-width = 42; }; } Declared by:
+See aerc-config(5).Type: attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma) Default: { } Example: { ui = { sidebar-width = 42; }; } Declared by: accounts.email.accounts.<name>.aerc.smtpAuthSets the authentication mechanism if smtp is used as the outgoing
method.
-See aerc-smtp(5).
- Type: null or one of "none", "plain", "login" Default: "plain" Example: "auth" Declared by: accounts.email.accounts.<name>.alot.contactCompletionContact completion configuration as expected per alot.
See alot's wiki for
-explanation about possible values.
- Type: attribute set of string Default: {
+explanation about possible values.Type: attribute set of string Default: {
command = "'\${pkgs.notmuch}/bin/notmuch address --format=json --output=recipients date:6M..'";
regexp = "'\\[?{\"name\": \"(?P<name>.*)\", \"address\": \"(?P<email>.+)\", \"name-addr\": \".*\"}[,\\]]?'";
shellcommand_external_filtering = "False";
@@ -76,25 +71,21 @@ explanation about possible values.
}
Declared by: accounts.email.accounts.<name>.alot.extraConfigExtra settings to add to this Alot account configuration.
- Type: strings concatenated with "\n" Default: "" Declared by: accounts.email.accounts.<name>.alot.extraConfigExtra settings to add to this Alot account configuration. Type: strings concatenated with "\n" Default: "" Declared by: accounts.email.accounts.<name>.alot.sendMailCommandCommand to send a mail. If msmtp is enabled for the account,
then this is set to
-msmtpq --read-envelope-from --read-recipients.
- Type: null or string Declared by: accounts.email.accounts.<name>.astroid.extraConfigExtra settings to add to this astroid account configuration. Type: attribute set of anything Default: { } Example: {
select_query = "";
}Declared by: accounts.email.accounts.<name>.astroid.sendMailCommandCommand to send a mail. If msmtp is enabled for the account,
then this is set to
-msmtpq --read-envelope-from --read-recipients.
- Type: string Declared by:
+msmtpq --read-envelope-from --read-recipients.Type: string Declared by: accounts.email.accounts.<name>.flavorSome email providers have peculiar behavior that require
special treatment. This option is therefore intended to
@@ -102,53 +93,41 @@ indicate the nature of the provider.
When this indicates a specific provider then, for example,
the IMAP, SMTP, and JMAP server configuration may be set
-automatically.
- Type: one of "plain", "gmail.com", "runbox.com", "fastmail.com", "yandex.com", "outlook.office365.com" Default: "plain" Declared by:
+automatically.Type: one of "plain", "gmail.com", "runbox.com", "fastmail.com", "yandex.com", "outlook.office365.com" Default: "plain" Declared by: accounts.email.accounts.<name>.foldersStandard email folders.
- Type: submodule Default: { } Declared by: accounts.email.accounts.<name>.foldersStandard email folders. Type: submodule Default: { } Declared by: accounts.email.accounts.<name>.folders.draftsRelative path of the drafts mail folder.
- Type: string Default: "Drafts" Declared by: accounts.email.accounts.<name>.folders.draftsRelative path of the drafts mail folder. Type: string Default: "Drafts" Declared by: accounts.email.accounts.<name>.folders.inboxRelative path of the inbox mail.
- Type: string Default: "Inbox" Declared by: accounts.email.accounts.<name>.folders.inboxRelative path of the inbox mail. Type: string Default: "Inbox" Declared by: accounts.email.accounts.<name>.folders.sentRelative path of the sent mail folder.
- Type: null or string Default: "Sent" Declared by: accounts.email.accounts.<name>.folders.sentRelative path of the sent mail folder. Type: null or string Default: "Sent" Declared by: accounts.email.accounts.<name>.folders.trashRelative path of the deleted mail folder.
- Type: string Default: "Trash" Declared by: accounts.email.accounts.<name>.folders.trashRelative path of the deleted mail folder. Type: string Default: "Trash" Declared by: accounts.email.accounts.<name>.getmail.enableWhether to enable the getmail mail retriever for this account. Type: boolean Default: false Example: true Declared by: accounts.email.accounts.<name>.getmail.deleteEnable if you want to delete read messages from the server. Most
users should either enable delete or disable
-readAll.
- Type: boolean Default: false Declared by:
+readAll.Type: boolean Default: false Declared by: accounts.email.accounts.<name>.getmail.destinationCommandSpecify a command delivering the incoming mail to your maildir.
- Type: null or string Default: null Example: "\${pkgs.maildrop}/bin/maildrop" Declared by: accounts.email.accounts.<name>.getmail.destinationCommandSpecify a command delivering the incoming mail to your maildir. Type: null or string Default: null Example: "\${pkgs.maildrop}/bin/maildrop" Declared by: accounts.email.accounts.<name>.getmail.mailboxesA non-empty list of mailboxes. To download all mail you can
-use the ALL mailbox.
- Type: non-empty (list of string) Default: [ ] Example: [
+use the ALL mailbox.Type: non-empty (list of string) Default: [ ] Example: [
"INBOX"
"INBOX.spam"
] Declared by: accounts.email.accounts.<name>.getmail.readAllEnable if you want to fetch all, even the read messages from the
server. Most users should either enable delete or
-disable readAll.
- Type: boolean Default: true Declared by:
+disable readAll.Type: boolean Default: true Declared by: accounts.email.accounts.<name>.gpgGPG configuration.
- Type: null or (submodule) Default: null Declared by: accounts.email.accounts.<name>.gpgGPG configuration. Type: null or (submodule) Default: null Declared by: accounts.email.accounts.<name>.gpg.encryptByDefaultEncrypt outgoing messages by default. Type: boolean Default: false Declared by: accounts.email.accounts.<name>.gpg.keyThe key to use as listed in gpg --list-keys.
- Type: string Declared by: accounts.email.accounts.<name>.gpg.keyThe key to use as listed in gpg --list-keys. Type: string Declared by: accounts.email.accounts.<name>.gpg.signByDefaultSign messages by default. Type: boolean Default: false Declared by:
<home-manager/modules/accounts/email.nix>
@@ -156,43 +135,33 @@ disable readAll.
.Type: boolean Default: false Example: true Declared by: accounts.email.accounts.<name>.himalaya.backendThe method for which himalaya will fetch, store,
-etc. mail.
- Type: null or one of "imap", "maildir" Declared by:
+etc. mail.Type: null or one of "imap", "maildir" Declared by: accounts.email.accounts.<name>.himalaya.senderThe method for which himalaya will send mail.
- Type: null or one of "smtp", "sendmail" Declared by: accounts.email.accounts.<name>.himalaya.senderThe method for which himalaya will send mail. Type: null or one of "smtp", "sendmail" Declared by: accounts.email.accounts.<name>.himalaya.settingsExtra settings to add to this himalaya
-account configuration.
- Type: TOML value Default: { } Example: {
+account configuration.Type: TOML value Default: { } Example: {
default-page-size = 50;
}
Declared by: accounts.email.accounts.<name>.imapThe IMAP configuration to use for this account.
- Type: null or (submodule) Default: null Declared by: accounts.email.accounts.<name>.imapThe IMAP configuration to use for this account. Type: null or (submodule) Default: null Declared by: accounts.email.accounts.<name>.imap.hostHostname of IMAP server.
- Type: string Example: "imap.example.org" Declared by: accounts.email.accounts.<name>.imap.hostHostname of IMAP server. Type: string Example: "imap.example.org" Declared by: accounts.email.accounts.<name>.imap.portThe port on which the IMAP server listens. If
-null then the default port is used.
- Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive) Default: null Example: 993 Declared by:
+null then the default port is used.Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive) Default: null Example: 993 Declared by: accounts.email.accounts.<name>.imap.tlsConfiguration for secure connections.
- Type: submodule Default: { } Declared by: accounts.email.accounts.<name>.imap.tlsConfiguration for secure connections. Type: submodule Default: { } Declared by: accounts.email.accounts.<name>.imap.tls.enableWhether to enable TLS/SSL.
- Type: boolean Default: true Declared by: accounts.email.accounts.<name>.imap.tls.enableWhether to enable TLS/SSL. Type: boolean Default: true Declared by: accounts.email.accounts.<name>.imap.tls.certificatesFilePath to file containing certificate authorities that should
be used to validate the connection authenticity. If
null then the system default is used.
-Note, if set then the system default may still be accepted.
- Type: null or path Default: "config.accounts.email.certificatesFile" Declared by:
+Note, if set then the system default may still be accepted.Type: null or path Default: "config.accounts.email.certificatesFile" Declared by: accounts.email.accounts.<name>.imap.tls.useStartTlsWhether to use STARTTLS.
- Type: boolean Default: false Declared by: accounts.email.accounts.<name>.imap.tls.useStartTlsWhether to use STARTTLS. Type: boolean Default: false Declared by: accounts.email.accounts.<name>.imapnotify.enableWhether to enable imapnotify. Type: boolean Default: false Example: true Declared by:
<home-manager/modules/services/imapnotify.nix>
@@ -211,22 +180,19 @@ Note, if set then the system default may still be accepted.
mail = "\${pkgs.notmuch}/bin/notmuch new && \${pkgs.libnotify}/bin/notify-send 'New mail arrived'";
}Declared by: accounts.email.accounts.<name>.jmapThe JMAP configuration to use for this account.
- Type: null or (submodule) Default: null Declared by: accounts.email.accounts.<name>.jmapThe JMAP configuration to use for this account. Type: null or (submodule) Default: null Declared by: 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:
+session.Type: null or string Default: null Example: "jmap.example.org" Declared by: 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:
+session.Type: null or string Default: null Example: "https://jmap.example.org:443/.well-known/jmap" Declared by: 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>
@@ -234,34 +200,28 @@ session.
This can safely be disabled if notmuch init
has been used to configure this account outside of Home
-Manager.
- Type: boolean Default: true Declared by:
+Manager.Type: boolean Default: true Declared by: accounts.email.accounts.<name>.lieer.settingsSettings which are applied to .gmailieer.json
for the account.
See the lieer manual
-for documentation of settings not explicitly covered by this module.
- Type: JSON value Default: { } Declared by:
+for documentation of settings not explicitly covered by this module.Type: JSON value Default: { } Declared by: accounts.email.accounts.<name>.lieer.settings.drop_non_existing_labelAllow missing labels on the Gmail side to be dropped.
- Type: boolean Default: false Declared by: accounts.email.accounts.<name>.lieer.settings.drop_non_existing_labelAllow missing labels on the Gmail side to be dropped. Type: boolean Default: false Declared by: accounts.email.accounts.<name>.lieer.settings.file_extensionExtension to include in local file names, which can be useful
-for indexing with third-party programs.
- Type: string Default: "" Example: "mbox" Declared by:
+for indexing with third-party programs.Type: string Default: "" Example: "mbox" Declared by: accounts.email.accounts.<name>.lieer.settings.ignore_empty_historyWork around a Gmail API quirk where an empty change history
is sometimes returned.
See this
GitHub issue
-for more details.
- Type: boolean Default: false Declared by:
+for more details.Type: boolean Default: false Declared by: accounts.email.accounts.<name>.lieer.settings.ignore_remote_labelsSet Gmail labels to ignore when syncing from remote labels to
-local tags (before translations).
- Type: list of string Default: [
+local tags (before translations).Type: list of string Default: [
"CATEGORY_FORUMS"
"CATEGORY_PROMOTIONS"
"CATEGORY_UPDATES"
@@ -270,20 +230,15 @@ local tags (before translations).
] Declared by: accounts.email.accounts.<name>.lieer.settings.ignore_tagsSet labels to ignore when syncing from local tags to
-remote labels (after translations).
- Type: list of string Default: [ ] Declared by:
+remote labels (after translations).Type: list of string Default: [ ] Declared by: accounts.email.accounts.<name>.lieer.settings.local_trash_tagLocal tag to which the remote Gmail 'TRASH' label is translated.
- Type: string Default: "trash" Declared by: accounts.email.accounts.<name>.lieer.settings.local_trash_tagLocal tag to which the remote Gmail 'TRASH' label is translated. Type: string Default: "trash" Declared by: accounts.email.accounts.<name>.lieer.settings.remove_local_messagesRemove local messages that have been deleted on the remote.
- Type: boolean Default: true Declared by: accounts.email.accounts.<name>.lieer.settings.remove_local_messagesRemove local messages that have been deleted on the remote. Type: boolean Default: true Declared by: accounts.email.accounts.<name>.lieer.settings.replace_slash_with_dotReplace '/' with '.' in Gmail labels.
- Type: boolean Default: false Declared by: accounts.email.accounts.<name>.lieer.settings.replace_slash_with_dotReplace '/' with '.' in Gmail labels. Type: boolean Default: false Declared by: accounts.email.accounts.<name>.lieer.settings.timeoutHTTP timeout in seconds. 0 means forever or system timeout.
- Type: unsigned integer, meaning >=0 Default: 600 Declared by: accounts.email.accounts.<name>.lieer.settings.timeoutHTTP timeout in seconds. 0 means forever or system timeout. Type: unsigned integer, meaning >=0 Default: 600 Declared by: accounts.email.accounts.<name>.lieer.sync.enableWhether to enable lieer synchronization service. Type: boolean Default: false Example: true Declared by:
<home-manager/modules/programs/lieer.nix>
@@ -292,50 +247,40 @@ remote labels (after translations).
This value is passed to the systemd timer configuration as the
onCalendar option. See
systemd.time(7)
-for more information about the format.
-Type: string Default: "*:0/5" Declared by:
+for more information about the format.Type: string Default: "*:0/5" Declared by: accounts.email.accounts.<name>.maildirMaildir configuration for this account.
- Type: null or (submodule) Declared by: accounts.email.accounts.<name>.maildirMaildir configuration for this account. Type: null or (submodule) Declared by: accounts.email.accounts.<name>.maildir.pathPath to maildir directory where mail for this account is
-stored. This is relative to the base maildir path.
- Type: string Declared by:
+stored. This is relative to the base maildir path.Type: string Declared by: accounts.email.accounts.<name>.mbsync.enableWhether to enable synchronization using mbsync. Type: boolean Default: false Example: true Declared by: accounts.email.accounts.<name>.mbsync.createAutomatically create missing mailboxes within the
-given mail store.
- Type: one of "none", "maildir", "imap", "both" Default: "none" Example: "maildir" Declared by: accounts.email.accounts.<name>.mbsync.extraConfig.channelPer channel extra configuration. Type: attribute set of (string or signed integer or boolean or list of string) Default: { } Example: {
MaxMessages = 10000;
MaxSize = "1m";
};
Declared by: accounts.email.accounts.<name>.mbsync.extraConfig.localLocal store extra configuration.
- Type: attribute set of (string or signed integer or boolean or list of string) Default: { } Declared by: accounts.email.accounts.<name>.mbsync.extraConfig.localLocal store extra configuration. Type: attribute set of (string or signed integer or boolean or list of string) Default: { } Declared by: accounts.email.accounts.<name>.mbsync.extraConfig.remoteRemote store extra configuration.
- Type: attribute set of (string or signed integer or boolean or list of string) Default: { } Declared by: accounts.email.accounts.<name>.mbsync.extraConfig.remoteRemote store extra configuration. Type: attribute set of (string or signed integer or boolean or list of string) Default: { } Declared by: accounts.email.accounts.<name>.mbsync.flattenIf set, flattens the hierarchy within the maildir by
substituting the canonical hierarchy delimiter
-/ with this value.
- Type: null or string Default: null Example: "." Declared by:
+/ with this value.Type: null or string Default: null Example: "." Declared by: accounts.email.accounts.<name>.mbsync.groupsSome email providers (Gmail) have a different directory hierarchy for
synchronized email messages. Namely, when using mbsync without specifying
@@ -343,20 +288,17 @@ a set of channels into a group, all synchronized directories end up beneath
the [Gmail]/ directory.
This option allows you to specify a group, and subsequently channels that
-will allow you to sync your mail into an arbitrary hierarchy.
- Type: attribute set of (submodule) Default: { } Declared by:
+will allow you to sync your mail into an arbitrary hierarchy.Type: attribute set of (submodule) Default: { } Declared by: accounts.email.accounts.<name>.mbsync.groups.<name>.channelsList of channels that should be grouped together into this group. When
performing a synchronization, the groups are synchronized, rather than
the individual channels.
Using these channels and then grouping them together allows for you to
-define the maildir hierarchy as you see fit.
- Type: attribute set of (submodule) Default: { } Declared by:
+define the maildir hierarchy as you see fit.Type: attribute set of (submodule) Default: { } Declared by: accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.extraConfigExtra configuration lines to add to THIS channel's
-configuration.
- Type: attribute set of (string or signed integer or boolean or list of string) Default: { } Example: {
+configuration.Type: attribute set of (string or signed integer or boolean or list of string) Default: { } Example: {
Create = "both";
CopyArrivalDate = "yes";
MaxMessages = 10000;
@@ -370,47 +312,39 @@ is interpreted as a prefix which is not matched against the patterns,
and is not affected by mailbox list overrides.
If this is left as the default, then mbsync will default to the pattern
-INBOX.
- Type: string Default: "" Example: "[Gmail]/Sent Mail" Declared by:
+INBOX.Type: string Default: "" Example: "[Gmail]/Sent Mail" Declared by: accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.nameThe unique name for THIS channel in THIS group. The group will refer to
this channel by this name.
In addition, you can manually sync just this channel by specifying this
-name to mbsync on the command line.
- Type: string (read only) Default: "‹name›" Declared by:
+name to mbsync on the command line.Type: string (read only) Default: "‹name›" Declared by: accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.nearPatternName for where mail coming from the remote (far) mail server will end up
locally. The mailbox specified by the far pattern will be placed in
this directory.
If this is left as the default, then mbsync will default to the pattern
-INBOX.
- Type: string Default: "" Example: "Sent" Declared by:
+INBOX.Type: string Default: "" Example: "Sent" Declared by: accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.patternsInstead of synchronizing just the mailboxes that
match the farPattern, use it as a prefix which is
not matched against the patterns, and is not affected by mailbox list
-overrides.
- Type: list of string Default: [ ] Example: [
+overrides.Type: list of string Default: [ ] Example: [
"INBOX"
] Declared by: accounts.email.accounts.<name>.mbsync.groups.<name>.nameThe name of this group for this account. These names are different than
-some others, because they will hide channel names that are the same.
- Type: string (read only) Default: "‹name›" Declared by: accounts.email.accounts.<name>.mbsync.patternsPattern of mailboxes to synchronize. Type: list of string Default: [
"*"
] Declared by: accounts.email.accounts.<name>.mbsync.removePropagate mailbox deletions to the given mail store.
- Type: one of "none", "maildir", "imap", "both" Default: "none" Example: "imap" Declared by: accounts.email.accounts.<name>.mbsync.removePropagate mailbox deletions to the given mail store. Type: one of "none", "maildir", "imap", "both" Default: "none" Example: "imap" Declared by: accounts.email.accounts.<name>.mbsync.subFoldersThe on-disk folder naming style. This option has no
-effect when flatten is used.
- Type: one of "Verbatim", "Maildir++", "Legacy" Default: "Verbatim" Example: "Maildir++" Declared by: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|