Appendix A. Configuration Options

Additional arguments passed to each module in addition to ones like lib, config, and pkgs, modulesPath.

This option is also available to all submodules. Submodules do not inherit args from their parent module, nor do they provide args to their parent module or sibling submodules. The sole exception to this is the argument name which is provided by parent modules to a submodule and contains the attribute name the submodule is bound to, or a unique generated name if it is not bound to an attribute.

Some arguments are already passed by default, of which the following cannot be changed with this option:

For NixOS, the default value for this option includes at least this argument:

Type: lazy attribute set of raw value

Declared by:

List of calendars.

Type: attribute set of (submodule)

Default: { }

Declared by:

Whether to enable khal access.

Type: boolean

Default: false

Example: true

Declared by:

Color in which events in this calendar are displayed.

Type: null or one of “black”, “white”, “brown”, “yellow”, “dark gray”, “dark green”, “dark blue”, “light gray”, “light green”, “light blue”, “dark magenta”, “dark cyan”, “dark red”, “light magenta”, “light cyan”, “light red”

Default: null

Example: "light green"

Declared by:

The glob expansion to be searched for events or birthdays when type is set to discover.

Type: string

Default: "*"

Declared by:

Priority of a calendar used for coloring.

Type: signed integer

Default: 10

Declared by:

Keep khal from making any changes to this account.

Type: boolean

Default: false

Declared by:

Either a single calendar (calendar which is the default) or a directory with multiple calendars (discover).

Type: null or one of “calendar”, “discover”

Default: null

Declared by:

Local configuration for the calendar.

Type: null or (submodule)

Default: null

Declared by:

File encoding for items, both content and file name. Defaults to UTF-8.

Type: null or string

Default: null

Declared by:

The file extension to use.

Type: null or string

Default: null

Declared by:

The path of the storage.

Type: string

Default: "‹accounts.calendar.basePath›/‹name›"

Declared by:

The type of the storage.

Type: one of “filesystem”, “singlefile”

Declared by:

Unique identifier of the calendar. This is set to the attribute name of the calendar configuration.

Type: string (read only)

Declared by:

Whether this is the primary account. Only one account may be set as primary.

Type: boolean

Default: false

Declared by:

The primary collection of the account. Required when an account has multiple collections.

Type: string

Declared by:

Whether to enable qcal access.

Type: boolean

Default: false

Example: true

Declared by:

Remote configuration for the calendar.

Type: null or (submodule)

Default: null

Declared by:

A command that prints the password to standard output.

Type: null or (list of string)

Default: null

Example:

[
  "pass"
  "caldav"
]

Declared by:

The type of the storage.

Type: one of “caldav”, “http”, “google_calendar”

Declared by:

The URL of the storage.

Type: null or string

Default: null

Declared by:

User name for authentication.

Type: null or string

Default: null

Declared by:

Whether to enable synchronization using vdirsyncer.

Type: boolean

Default: false

Example: true

Declared by:

Authentication settings. The default is basic.

Type: null or one of “basic”, “digest”, “guess”

Default: null

Declared by:

Either a path to a certificate with a client certificate and the key or a list of paths to the files with them.

Type: null or string or list of string

Default: null

Declared by:

A command that prints the OAuth credentials to standard output.

See https://vdirsyncer.pimutils.org/en/stable/config.html#google for more information.

Type: null or (list of string)

Default: null

Example:

[
  "pass"
  "client_id"
]

Declared by:

A command that prints the OAuth credentials to standard output.

See https://vdirsyncer.pimutils.org/en/stable/config.html#google for more information.

Type: null or (list of string)

Default: null

Example:

[
  "pass"
  "client_secret"
]

Declared by:

The collections to synchronize between the storages.

Type: null or (list of (string or list of string))

Default: null

Declared by:

What to do in case of a conflict between the storages. Either remote wins or local wins or a list that contains a command to run. By default, an error message is printed.

Type: null or one of “remote wins”, “local wins” or list of string

Default: null

Declared by:

Kinds of items to show. The default is to show everything. This depends on particular features of the server, the results are not validated.

Type: null or (list of string)

Default: null

Declared by:

Metadata keys that should be synchronized when vdirsyncer metasync is executed.

Type: list of string

Default: [ ]

Example:

[
  "color"
  "displayname"
]

Declared by:

What should happen if synchronization in one direction is impossible due to one storage being read-only. Defaults to revert.

See https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section for more information.

Type: null or one of “revert”, “error”, “ignore”

Default: null

Declared by:

Command to call for each item creation and modification. The command will be called with the path of the new/updated file.

Type: strings concatenated with “\n”

Default: ""

Declared by:

A time range to synchronize. start and end can be any Python expression that returns a datetime.datetime object.

Type: null or (submodule)

Default: null

Example:

{
  end = "datetime.now() + timedelta(days=365)";
  start = "datetime.now() - timedelta(days=365)";
}

Declared by:

End of time range to show.

Type: string

Declared by:

Start of time range to show.

Type: string

Declared by:

A file path where access tokens are stored.

Type: null or string

Default: null

Declared by:

The user agent to report to the server. Defaults to vdirsyncer.

Type: null or string

Default: null

Declared by:

Verify SSL certificate.

Type: null or boolean

Default: null

Declared by:

Optional. SHA1 or MD5 fingerprint of the expected server certificate.

See https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial for more information.

Type: null or string

Default: null

Declared by:

The base directory in which to save calendars. May be a relative path, in which case it is relative the home directory.

Type: string

Declared by:

List of contacts.

Type: attribute set of (submodule)

Default: { }

Declared by:

Whether to enable khal access.

Type: boolean

Default: false

Example: true

Declared by:

Keep khal from making any changes to this account.

Type: boolean

Default: false

Declared by:

Whether to enable khard access.

Type: boolean

Default: false

Example: true

Declared by:

Local configuration for the contacts.

Type: null or (submodule)

Default: null

Declared by:

File encoding for items, both content and file name. Defaults to UTF-8.

Type: null or string

Default: null

Declared by:

The file extension to use.

Type: null or string

Default: null

Declared by:

The path of the storage.

Type: string

Default: "‹accounts.contact.basePath›/‹name›"

Declared by:

The type of the storage.

Type: one of “filesystem”, “singlefile”

Declared by:

Unique identifier of the contact account. This is set to the attribute name of the contact configuration.

Type: string (read only)

Declared by:

Remote configuration for the contacts.

Type: null or (submodule)

Default: null

Declared by:

A command that prints the password to standard output.

Type: null or (list of string)

Default: null

Example:

[
  "pass"
  "caldav"
]

Declared by:

The type of the storage.

Type: one of “carddav”, “http”, “google_contacts”

Declared by:

The URL of the storage.

Type: null or string

Default: null

Declared by:

User name for authentication.

Type: null or string

Default: null

Declared by:

Whether to enable synchronization using vdirsyncer.

Type: boolean

Default: false

Example: true

Declared by:

Authentication settings. The default is basic.

Type: null or one of “basic”, “digest”, “guess”

Default: null

Declared by:

Either a path to a certificate with a client certificate and the key or a list of paths to the files with them.

Type: null or string or list of string

Default: null

Declared by:

A command that prints the OAuth credentials to standard output.

See https://vdirsyncer.pimutils.org/en/stable/config.html#google for more information.

Type: null or (list of string)

Default: null

Example:

[
  "pass"
  "client_id"
]

Declared by:

A command that prints the OAuth credentials to standard output.

See https://vdirsyncer.pimutils.org/en/stable/config.html#google for more information.

Type: null or (list of string)

Default: null

Example:

[
  "pass"
  "client_secret"
]

Declared by:

The collections to synchronize between the storages.

Type: null or (list of (string or list of string))

Default: null

Declared by:

What to do in case of a conflict between the storages. Either remote wins or local wins or a list that contains a command to run. By default, an error message is printed.

Type: null or one of “remote wins”, “local wins” or list of string

Default: null

Declared by:

Kinds of items to show. The default is to show everything. This depends on particular features of the server, the results are not validated.

Type: null or (list of string)

Default: null

Declared by:

Metadata keys that should be synchronized when vdirsyncer metasync is executed.

Type: list of string

Default: [ ]

Example:

[
  "color"
  "displayname"
]

Declared by:

What should happen if synchronization in one direction is impossible due to one storage being read-only. Defaults to revert.

See https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section for more information.

Type: null or one of “revert”, “error”, “ignore”

Default: null

Declared by:

Command to call for each item creation and modification. The command will be called with the path of the new/updated file.

Type: strings concatenated with “\n”

Default: ""

Declared by:

A time range to synchronize. start and end can be any Python expression that returns a datetime.datetime object.

Type: null or (submodule)

Default: null

Example:

{
  end = "datetime.now() + timedelta(days=365)";
  start = "datetime.now() - timedelta(days=365)";
}

Declared by:

End of time range to show.

Type: string

Declared by:

Start of time range to show.

Type: string

Declared by:

A file path where access tokens are stored.

Type: null or string

Default: null

Declared by:

The user agent to report to the server. Defaults to vdirsyncer.

Type: null or string

Default: null

Declared by:

Verify SSL certificate.

Type: null or boolean

Default: null

Declared by:

Optional. SHA1 or MD5 fingerprint of the expected server certificate.

See https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial for more information.

Type: null or string

Default: null

Declared by:

The base directory in which to save contacts. May be a relative path, in which case it is relative the home directory.

Type: string

Declared by:

List of email accounts.

Type: attribute set of (submodule)

Default: { }

Declared by:

The email address of this account.

Type: string matching the pattern .*@.*

Example: "jane.doe@example.org"

Declared by:

Whether to enable aerc.

Type: boolean

Default: false

Example: true

Declared by:

Extra config added to the configuration section for this account in $HOME/.config/aerc/accounts.conf. See aerc-accounts(5).

Type: attribute set of (values (null, bool, int, string, or float) or a list of values, that will be joined with a comma)

Default: { }

Example: { source = "maildir://~/Maildir/example"; }

Declared by:

Extra bindings specific to this account, added to $HOME/.config/aerc/binds.conf. See aerc-binds(5).

Type: attribute set of attribute set of (values (null, bool, int, string, or float) or a list of values, that will be joined with a comma)

Default: { }

Example: { messages = { d = ":move ${folder.trash}<Enter>"; }; }

Declared by:

Config specific to this account, added to $HOME/.config/aerc/aerc.conf. Aerc only supports per-account UI configuration. For other sections of $HOME/.config/aerc/aerc.conf, use programs.aerc.extraConfig. See aerc-config(5).

Type: attribute set of attribute set of (values (null, bool, int, string, or float) or a list of values, that will be joined with a comma)

Default: { }

Example: { ui = { sidebar-width = 25; }; }

Declared by:

Sets the authentication mechanism if imap is used as the incoming method. See aerc-imap(5).

Type: null or one of “oauthbearer”, “xoauth2”

Default: null

Example: "auth"

Declared by:

Sets the oauth2 params if authentication mechanism oauthbearer or xoauth2 is used. See aerc-imap(5).

Type: null or (submodule)

Default: null

Example:

{
  token_endpoint = "<token_endpoint>";
}

Declared by:

The OAuth2 client identifier.

Type: null or string

Default: null

Declared by:

The OAuth2 client secret.

Type: null or string

Default: null

Declared by:

The OAuth2 requested scope.

Type: null or string

Default: null

Declared by:

The OAuth2 token endpoint.

Type: null or string

Default: null

Declared by:

Sets the authentication mechanism if smtp is used as the outgoing method. See aerc-smtp(5).

Type: null or one of “none”, “plain”, “login”, “oauthbearer”, “xoauth2”

Default: "plain"

Example: "auth"

Declared by:

Sets the oauth2 params if authentication mechanism oauthbearer or xoauth2 is used. See aerc-imap(5).

Type: null or (submodule)

Default: null

Example:

{
  token_endpoint = "<token_endpoint>";
}

Declared by:

The OAuth2 client identifier.

Type: null or string

Default: null

Declared by:

The OAuth2 client secret.

Type: null or string

Default: null

Declared by:

The OAuth2 requested scope.

Type: null or string

Default: null

Declared by:

The OAuth2 token endpoint.

Type: null or string

Default: null

Declared by:

Alternative email addresses of this account.

Type: list of string matching the pattern .*@.*

Default: [ ]

Example:

[
  "webmaster@example.org"
  "admin@example.org"
]

Declared by:

Contact completion configuration as expected per alot. See alot’s wiki for 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";
  type = "shellcommand";
}

Example:

{
  type = "shellcommand";
  command = "abook --mutt-query";
  regexp = "'^(?P<email>[^@]+@[^\t]+)\t+(?P<name>[^\t]+)'";
  ignorecase = "True";
}

Declared by:

Extra settings to add to this Alot account configuration.

Type: strings concatenated with “\n”

Default: ""

Declared by:

Command 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:

Whether to enable Astroid.

Type: boolean

Default: false

Example: true

Declared by:

Extra settings to add to this astroid account configuration.

Type: attribute set of anything

Default: { }

Example:

{
  select_query = "";
}

Declared by:

Command 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:

Some email providers have peculiar behavior that require 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, 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:

Standard email folders.

Type: submodule

Default: { }

Declared by:

Relative path of the drafts mail folder.

Type: null or string

Default: "Drafts"

Declared by:

Relative path of the inbox mail.

Type: string

Default: "Inbox"

Declared by:

Relative path of the sent mail folder.

Type: null or string

Default: "Sent"

Declared by:

Relative path of the deleted mail folder.

Type: string

Default: "Trash"

Declared by:

Whether to enable the getmail mail retriever for this account.

Type: boolean

Default: false

Example: true

Declared by:

Enable 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:

Specify a command delivering the incoming mail to your maildir.

Type: null or string

Default: null

Example: "\${pkgs.maildrop}/bin/maildrop"

Declared by:

A non-empty list of mailboxes. To download all mail you can use the ALL mailbox.

Type: non-empty (list of string)

Default: [ ]

Example:

[
  "INBOX"
  "INBOX.spam"
]

Declared by:

Enable 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:

GPG configuration.

Type: null or (submodule)

Default: null

Declared by:

Encrypt outgoing messages by default.

Type: boolean

Default: false

Declared by:

The key to use as listed in gpg --list-keys.

Type: string

Declared by:

Sign messages by default.

Type: boolean

Default: false

Declared by:

Whether to enable Himalaya for this email account.

Type: boolean

Default: false

Example: true

Declared by:

Specifying accounts.email.accounts.*.himalaya.backend is deprecated, set accounts.email.accounts.*.himalaya.settings.backend instead.

Type: null or string

Default: null

Declared by:

Specifying accounts.email.accounts.*.himalaya.sender is deprecated, set {option}‘accounts.email.accounts.*.himalaya.settings.sender’ instead.

Type: null or string

Declared by:

Himalaya configuration for this email account. See https://pimalaya.org/himalaya/cli/configuration/account.html for supported values.

Type: TOML value

Default: { }

Declared by:

The IMAP configuration to use for this account.

Type: null or (submodule)

Default: null

Declared by:

Hostname of IMAP server.

Type: string

Example: "imap.example.org"

Declared by:

The 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:

Configuration for secure connections.

Type: submodule

Default: { }

Declared by:

Whether to enable TLS/SSL.

Type: boolean

Default: true

Declared by:

Path 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:

Whether to use STARTTLS.

Type: boolean

Default: false

Declared by:

Whether to enable imapnotify.

Type: boolean

Default: false

Example: true

Declared by:

IMAP folders to watch.

Type: list of string

Default: [ ]

Example:

[
  "Inbox"
  "[Gmail]/MyLabel"
]

Declared by:

Additional configuration to add for this account.

Type: JSON value

Default: { }

Example:

{
  wait = 10;
}

Declared by:

Shell commands to run on any event.

Type: string or attribute set of string

Default: ""

Example: "\${pkgs.isync}/bin/mbsync test-%s"

Declared by:

Shell commands to run after onNotify event.

Type: string or attribute set of string

Default: ""

Example:

{
  mail = "\${pkgs.notmuch}/bin/notmuch new && \${pkgs.libnotify}/bin/notify-send 'New mail arrived'";
}

Declared by:

The JMAP configuration to use for this account.

Type: null or (submodule)

Default: null

Declared by:

Hostname 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:

URL 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:

Whether to enable lieer Gmail synchronization for notmuch.

Type: boolean

Default: false

Example: true

Declared by:

Warn if Notmuch is not also enabled for this account.

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:

Settings 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:

Allow missing labels on the Gmail side to be dropped.

Type: boolean

Default: false

Declared by:

Extension to include in local file names, which can be useful for indexing with third-party programs.

Type: string

Default: ""

Example: "mbox"

Declared by:

Work 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:

Set Gmail labels to ignore when syncing from remote labels to local tags (before translations).

Type: list of string

Default:

[
  "CATEGORY_FORUMS"
  "CATEGORY_PROMOTIONS"
  "CATEGORY_UPDATES"
  "CATEGORY_SOCIAL"
  "CATEGORY_PERSONAL"
]

Declared by:

Set labels to ignore when syncing from local tags to remote labels (after translations).

Type: list of string

Default: [ ]

Declared by:

Local tag to which the remote Gmail ‘TRASH’ label is translated.

Type: string

Default: "trash"

Declared by:

Remove local messages that have been deleted on the remote.

Type: boolean

Default: true

Declared by:

Replace ‘/’ with ‘.’ in Gmail labels.

Type: boolean

Default: false

Declared by:

HTTP timeout in seconds. 0 means forever or system timeout.

Type: unsigned integer, meaning >=0

Default: 600

Declared by:

Whether to enable lieer synchronization service.

Type: boolean

Default: false

Example: true

Declared by:

How often to synchronize the account.

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:

Maildir configuration for this account.

Type: null or (submodule)

Default:

{
  path = "\${name}";
}

Declared by:

Path to maildir directory where mail for this account is stored. This is relative to the base maildir path.

Type: string

Declared by:

Whether to enable synchronization using mbsync.

Type: boolean

Default: false

Example: true

Declared by:

Automatically create missing mailboxes within the given mail store.

Type: one of “none”, “maildir”, “imap”, “both”

Default: "none"

Example: "maildir"

Declared by:

Permanently remove messages marked for deletion from the given mail store.

Type: one of “none”, “maildir”, “imap”, “both”

Default: "none"

Example: "both"

Declared by:

Account section extra configuration.

Type: attribute set of (string or signed integer or boolean or list of string)

Default: { }

Example:

{
  PipelineDepth = 10;
  Timeout = 60;
};

Declared by:

Per 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:

Local store extra configuration.

Type: attribute set of (string or signed integer or boolean or list of string)

Default: { }

Declared by:

Remote store extra configuration.

Type: attribute set of (string or signed integer or boolean or list of string)

Default: { }

Declared by:

If 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:

Some email providers (Gmail) have a different directory hierarchy for synchronized email messages. Namely, when using mbsync without specifying 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:

List 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:

Extra 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:

{
  Create = "both";
  CopyArrivalDate = "yes";
  MaxMessages = 10000;
  MaxSize = "1m";
}

Declared by:

IMAP4 patterns for which mailboxes on the remote mail server to sync. If Patterns are specified, farPattern 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:

The 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 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:

Instead 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:

[
  "INBOX"
]

Declared by:

The 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:

Pattern of mailboxes to synchronize.

Type: list of string

Default:

[
  "*"
]

Declared by:

Propagate mailbox deletions to the given mail store.

Type: one of “none”, “maildir”, “imap”, “both”

Default: "none"

Example: "imap"

Declared by:

The 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:

Whether to enable msmtp.

If enabled then it is possible to use the --account command line option to send a message for a given account using the msmtp or msmtpq tool. For example, msmtp --account=private would send using the account defined in accounts.email.accounts.private. If the --account option is not given then the primary account will be used.

Type: boolean

Default: false

Declared by:

Extra configuration options to add to ~/.msmtprc. See https://marlam.de/msmtp/msmtprc.txt for examples.

Type: attribute set of string

Default: { }

Example:

{
  auth = "login";
}

Declared by:

Fingerprint of a trusted TLS certificate. The fingerprint can be obtained by executing msmtp --serverinfo --tls --tls-certcheck=off.

Type: null or string matching the pattern ([[:alnum:]]{2}:)+[[:alnum:]]{2}

Default: null

Example: "my:SH:a2:56:ha:sh"

Declared by:

Whether to enable mu indexing.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable mujmap JMAP synchronization for notmuch.

Type: boolean

Default: false

Example: true

Declared by:

Warn 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:

Settings 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:

Whether to create new mailboxes automatically on the server from notmuch tags.

Type: boolean

Default: true

Declared by:

The 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:

Fully 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:

Shell 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:

Session 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:

Tag 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:

Tag 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:

Directory separator for mapping notmuch tags to maildirs.

Type: string

Default: "/"

Example: "."

Declared by:

Tag 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:

Tag 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:

If true, translate all mailboxes to lowercase names when mapping to notmuch tags.

Type: boolean

Default: false

Declared by:

Tag 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:

Tag 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:

Tag 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:

Username 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:

Unique identifier of the account. This is set to the attribute name of the account configuration.

Type: string (read only)

Declared by:

Whether to enable NeoMutt.

Type: boolean

Default: false

Example: true

Declared by:

Extra lines to add to the folder hook for this account.

Type: strings concatenated with “\n”

Default: ""

Example: "color status cyan default"

Declared by:

List of extra mailboxes

Type: list of (string or (submodule))

Default: [ ]

Declared by:

Use a different name as mailbox name

Type: null or string

Default: null

Example: "==== <mailbox-name> ==="

Declared by:

Command to send a mail. If not set, neomutt will be in charge of sending mails.

Type: null or string

Default:

if config.msmtp.enable then
  "msmtpq --read-envelope-from --read-recipients"
else
  null

Example: "msmtpq --read-envelope-from --read-recipients"

Declared by:

Whether to enable notmuch indexing.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Notmuch support in NeoMutt.

Type: boolean

Default: true

Example: true

Declared by:

List of virtual mailboxes using Notmuch queries

Type: list of (submodule)

Default:

[
  {
    name = "My INBOX";
    query = "tag:inbox";
  }
]

Example:

[
  {
    name = "My INBOX";
    query = "tag:inbox";
  }
]

Declared by:

Restricts number of messages/threads in the result.

Type: null or signed integer

Default: null

Example: 10

Declared by:

Name to display

Type: string

Default: "My INBOX"

Example: "My INBOX"

Declared by:

Notmuch query

Type: string

Default: "tag:inbox"

Example: "tag:inbox"

Declared by:

Reads all matching messages or whole-threads. The default is ‘messages’ or nm_query_type.

Type: null or one of “threads”, “messages”

Default: null

Example: "threads"

Declared by:

Whether to enable OfflineIMAP.

Type: boolean

Default: false

Example: true

Declared by:

Extra configuration options to add to the account section.

Type: attribute set of (string or signed integer or boolean)

Default: { }

Example:

{
  autorefresh = 20;
}

Declared by:

Extra configuration options to add to the local account section.

Type: attribute set of (string or signed integer or boolean)

Default: { }

Example:

{
  sync_deletes = true;
}

Declared by:

Extra configuration options to add to the remote account section.

Type: attribute set of (string or signed integer or boolean)

Default: { }

Example:

{
  expunge = false;
  maxconnections = 2;
}

Declared by:

Command to run after fetching new mails.

Type: strings concatenated with “\n”

Default: ""

Declared by:

A command, which when run writes the account password on standard output.

Type: null or string or list of string

Default: null

Example: "secret-tool lookup email me@example.org"

Declared by:

Whether this is the primary account. Only one account may be set as primary.

Type: boolean

Default: false

Declared by:

Name displayed when sending mails.

Type: string

Example: "Jane Doe"

Declared by:

Signature configuration.

Type: submodule

Default: { }

Declared by:

A command that generates a signature.

Type: null or path

Default: null

Example:

pkgs.writeScript "signature" "echo This is my signature"

Declared by:

The delimiter used between the document and the signature.

Type: string

Default:

''
  --
''

Example:

~*~*~*~*~*~*~*~*~*~*~*~

Declared by:

Method to communicate the signature.

Type: one of “append”, “attach”, “none”

Default: "none"

Declared by:

Signature content.

Type: string

Default: ""

Example:

''
  --
  Luke Skywalker
  May the force be with you.
''

Declared by:

The SMTP configuration to use for this account.

Type: null or (submodule)

Default: null

Declared by:

Hostname of SMTP server.

Type: string

Example: "smtp.example.org"

Declared by:

The port on which the SMTP 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: 465

Declared by:

Configuration for secure connections.

Type: submodule

Default: { }

Declared by:

Whether to enable TLS/SSL.

Type: boolean

Default: true

Declared by:

Path 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:

Whether to use STARTTLS.

Type: boolean

Default: false

Declared by:

Whether to enable the Thunderbird mail client for this account.

Type: boolean

Default: false

Example: true

Declared by:

Extra settings to add to each identity of this Thunderbird account configuration. The id given as argument is an automatically generated identifier.

Type: function that evaluates to a(n) attribute set of (boolean or signed integer or string)

Default: _: { }

Example:

id: {
  "mail.identity.id_${id}.protectSubject" = false;
  "mail.identity.id_${id}.autoEncryptDrafts" = false;
};

Declared by:

List of Thunderbird profiles for which this account should be enabled. If this list is empty (the default), this account will be enabled for all declared profiles.

Type: list of string

Default: [ ]

Example:

[ "profile1" "profile2" ]

Declared by:

Extra settings to add to this Thunderbird account configuration. The id given as argument is an automatically generated account identifier.

Type: function that evaluates to a(n) attribute set of (boolean or signed integer or string)

Default: _: { }

Example:

id: {
  "mail.server.server_${id}.check_new_mail" = false;
};

Declared by:

The server username of this account. This will be used as the SMTP, IMAP, and JMAP user name.

Type: null or string

Default: null

Declared by:

Path to default file containing certificate authorities that should be used to validate the connection authenticity. This path may be overridden on a per-account basis.

Type: null or path

Default: "/etc/ssl/certs/ca-certificates.crt"

Declared by:

The base directory for account maildir directories. May be a relative path, in which case it is relative the home directory.

Type: string

Default: "$HOME/Maildir"

Declared by:

Settings to write to the dconf configuration system.

Note that the database is strongly-typed so you need to use the same types as described in the GSettings schema. For example, if an option is of type uint32 (u), you need to wrap the number using the lib.hm.gvariant.mkUint32 constructor. Otherwise, since Nix integers are implicitly coerced to int32 (i), it would get stored in the database as such, and GSettings might be confused when loading the setting.

You might want to use dconf2nix to convert dconf database dumps into compatible Nix expression.

Type: attribute set of attribute set of (GVariant value)

Default: { }

Example:

{
  "org/gnome/calculator" = {
    button-mode = "programming";
    show-thousands = true;
    base = 10;
    word-size = 64;
    window-position = lib.hm.gvariant.mkTuple [100 100];
  };
}

Declared by:

Whether to enable EditorConfig home configuration file.

Type: boolean

Default: false

Example: true

Declared by:

Configuration written to $HOME/.editorconfig. root = true is automatically added to the file, it must not be added here. See https://editorconfig.org for documentation.

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
  "*" = {
    charset = "utf-8";
    end_of_line = "lf";
    trim_trailing_whitespace = true;
    insert_final_newline = true;
    max_line_width = 78;
    indent_style = "space";
    indent_size = 4;
  };
};

Declared by:

Whether to enable fontconfig configuration. This will, for example, allow fontconfig to discover fonts and configurations installed through home.packages and nix-env.

Type: boolean

Default: false

Declared by:

Whether to enable GTK 2/3 configuration.

Type: boolean

Default: false

Example: true

Declared by:

The cursor theme to use.

Type: null or (submodule)

Default: null

Declared by:

Package providing the cursor theme. This package will be installed to your profile. If null then the theme is assumed to already be available in your profile.

Type: null or package

Default: null

Example: pkgs.vanilla-dmz

Declared by:

The name of the cursor theme within the package.

Type: string

Example: "Vanilla-DMZ"

Declared by:

The size of the cursor.

Type: null or signed integer

Default: null

Example: 16

Declared by:

The font to use in GTK+ 2/3 applications.

Type: null or (submodule)

Default: null

Declared by:

Package providing the font. This package will be installed to your profile. If null then the font is assumed to already be available in your profile.

Type: null or package

Default: null

Example: pkgs.dejavu_fonts

Declared by:

The family name of the font within the package.

Type: string

Example: "DejaVu Sans"

Declared by:

The size of the font.

Type: null or signed integer or floating point number

Default: null

Example: "8"

Declared by:

The location to put the GTK configuration file.

Type: path

Default: "${config.home.homeDirectory}/.gtkrc-2.0"

Example: "${config.xdg.configHome}/gtk-2.0/gtkrc"

Declared by:

Extra configuration lines to add verbatim to ~/.gtkrc-2.0.

Type: strings concatenated with “\n”

Default: ""

Example: "gtk-can-change-accels = 1"

Declared by:

Bookmarks in the sidebar of the GTK file browser

Type: list of string

Default: [ ]

Example:

[
  "file:///home/jane/Documents"
]

Declared by:

Extra configuration options to add to $XDG_CONFIG_HOME/gtk-3.0/settings.ini.

Type: attribute set of (boolean or signed integer or string)

Default: { }

Example:

{
  gtk-cursor-blink = false;
  gtk-recent-files-limit = 20;
}

Declared by:

Extra configuration lines to add verbatim to $XDG_CONFIG_HOME/gtk-3.0/gtk.css.

Type: strings concatenated with “\n”

Default: ""

Declared by:

Extra configuration options to add to $XDG_CONFIG_HOME/gtk-4.0/settings.ini.

Type: attribute set of (boolean or signed integer or string)

Default: { }

Example:

{
  gtk-cursor-blink = false;
  gtk-recent-files-limit = 20;
}

Declared by:

Extra configuration lines to add verbatim to $XDG_CONFIG_HOME/gtk-4.0/gtk.css.

Type: strings concatenated with “\n”

Default: ""

Declared by:

The icon theme to use.

Type: null or (submodule)

Default: null

Declared by:

Package providing the icon theme. This package will be installed to your profile. If null then the theme is assumed to already be available in your profile.

Type: null or package

Default: null

Example: pkgs.gnome.adwaita-icon-theme

Declared by:

The name of the icon theme within the package.

Type: string

Example: "Adwaita"

Declared by:

The GTK+2/3 theme to use.

Type: null or (submodule)

Default: null

Declared by:

Package providing the theme. This package will be installed to your profile. If null then the theme is assumed to already be available in your profile.

Type: null or package

Default: null

Example: pkgs.gnome.gnome-themes-extra

Declared by:

The name of the theme within the package.

Type: string

Example: "Adwaita"

Declared by:

Some Nix packages provide debug symbols for gdb in the debug output. This option ensures that those are automatically fetched from the binary cache if available and gdb is configured to find those symbols.

Type: boolean

Default: false

Example: true

Declared by:

Determines whether to check for release version mismatch between Home Manager and Nixpkgs. Using mismatched versions is likely to cause errors and unexpected behavior. It is therefore highly recommended to use a release of Home Manager that corresponds with your chosen release of Nixpkgs.

When this option is enabled and a mismatch is detected then a warning will be printed when the user configuration is being built.

Type: boolean

Default: true

Declared by:

The set of packages to appear in the user environment.

Type: list of package

Default: [ ]

Declared by:

The activation scripts blocks to run when activating a Home Manager generation. Any entry here should be idempotent, meaning running twice or more times produces the same result as running it once.

If the script block produces any observable side effect, such as writing or deleting files, then it must be placed after the special writeBoundary script block. Prior to the write boundary one can place script blocks that verifies, but does not modify, the state of the system and exits if an unexpected state is found. For example, the checkLinkTargets script block checks for collisions between non-managed files and files defined in home.file.

A script block should respect the DRY_RUN variable, if it is set then the actions taken by the script should be logged to standard out and not actually performed. The variable DRY_RUN_CMD is set to echo if dry run is enabled.

A script block should also respect the VERBOSE variable, and if set print information on standard out that may be useful for debugging any issue that may arise. The variable VERBOSE_ARG is set to --verbose if verbose output is enabled.

Type: DAG of string

Default: { }

Example:

{
  myActivationAction = lib.hm.dag.entryAfter ["writeBoundary"] ''
    $DRY_RUN_CMD ln -s $VERBOSE_ARG \
        ${builtins.toPath ./link-me-directly} $HOME
  '';
}

Declared by:

List of additional package outputs of the packages home.packages that should be installed into the user environment.

Type: list of string

Default: [ ]

Example:

[
  "doc"
  "info"
  "devdoc"
]

Declared by:

Attribute set of files to link into the user home.

Type: attribute set of (submodule)

Default: { }

Declared by:

Whether this file should be generated. This option allows specific files to be disabled.

Type: boolean

Default: true

Declared by:

Set the execute bit. If null, defaults to the mode of the source file or to false for files created through the text option.

Type: null or boolean

Default: null

Declared by:

Shell commands to run when file has changed between generations. The script will be run after the new files have been linked into place.

Note, this code is always run when recursive is enabled.

Type: strings concatenated with “\n”

Default: ""

Declared by:

If the file source is a directory, then this option determines whether the directory should be recursively linked to the target location. This option has no effect if the source is a file.

If false (the default) then the target will be a symbolic link to the source directory. If true then the target will be a directory structure matching the source’s but whose leafs are symbolic links to the files of the source directory.

Type: boolean

Default: false

Declared by:

Path of the source file or directory. If home.file.<name>.text is non-null then this option will automatically point to a file containing that text.

Type: path

Declared by:

Path to target file relative to HOME.

Type: string

Default: name

Declared by:

Text of the file. If this option is null then home.file.<name>.source must be set.

Type: null or strings concatenated with “\n”

Default: null

Declared by:

The user’s home directory. Must be an absolute path.

Type: path

Default:

"$HOME"   for state version < 20.09,
undefined for state version ≥ 20.09

Example: "/home/jane.doe"

Declared by:

Keyboard configuration. Set to null to disable Home Manager keyboard management.

Type: null or (submodule)

Default:

"{ }"  for state version < 21.11,
"null" for state version ≥ 21.11

Declared by:

Keyboard layout. If null, then the system configuration will be used.

This defaults to null for state version ≥ 19.09 and "us" otherwise.

Type: null or string

Default: null

Declared by:

Keyboard model.

Type: null or string

Default: null

Example: "presario"

Declared by:

X keyboard options; layout switching goes here.

Type: list of string

Default: [ ]

Example:

[
  "grp:caps_toggle"
  "grp_led:scroll"
]

Declared by:

X keyboard variant. If null, then the system configuration will be used.

This defaults to null for state version ≥ 19.09 and "" otherwise.

Type: null or string

Default: null

Example: "colemak"

Declared by:

Language configuration.

Type: submodule

Default: { }

Declared by:

The language to use for addresses.

Type: null or string

Default: null

Declared by:

The language to use unless overridden by a more specific option.

Type: null or string

Default: null

Declared by:

The language to use for collation (alphabetical ordering).

Type: null or string

Default: null

Declared by:

Character classification category.

Type: null or string

Default: null

Declared by:

The language to use for measurement values.

Type: null or string

Default: null

Declared by:

The language to use for messages, application UI languages, etc.

Type: null or string

Default: null

Declared by:

The language to use for formatting currencies and money amounts.

Type: null or string

Default: null

Declared by:

The language to use for personal names.

Type: null or string

Default: null

Declared by:

The language to use for numerical values.

Type: null or string

Default: null

Declared by:

The language to use for paper sizes.

Type: null or string

Default: null

Declared by:

The language to use for telephone numbers.

Type: null or string

Default: null

Declared by:

The language to use for formatting times.

Type: null or string

Default: null

Declared by:

Cursor configuration. Set to null to disable.

Top-level options declared under this submodule are backend independent options. Options declared under namespaces such as x11 are backend specific options. By default, only backend independent cursor configurations are generated. If you need configurations for specific backends, you can toggle them via the enable option. For example, home.pointerCursor.x11.enable will enable x11 cursor configurations.

Note that this will merely generate the cursor configurations. To apply the configurations, the relevant subsytems must also be configured. For example, home.pointerCursor.gtk.enable will generate the gtk cursor configuration, but gtk.enable needs to be set for it to be applied.

Type: null or (submodule)

Default: null

Declared by:

Package providing the cursor theme.

Type: package

Example: pkgs.vanilla-dmz

Declared by:

Whether to enable gtk config generation for home.pointerCursor .

Type: boolean

Default: false

Example: true

Declared by:

The cursor name within the package.

Type: string

Example: "Vanilla-DMZ"

Declared by:

The cursor size.

Type: signed integer

Default: 32

Example: 64

Declared by:

Whether to enable x11 config generation for home.pointerCursor .

Type: boolean

Default: false

Example: true

Declared by:

The default cursor file to use within the package.

Type: string

Default: "left_ptr"

Example: "X_cursor"

Declared by:

The profile directory where Home Manager generations are installed.

Type: path (read only)

Default:

"${home.homeDirectory}/.nix-profile"  or
"/etc/profiles/per-user/${home.username}"

Declared by:

Extra directories to add to PATH.

These directories are added to the PATH variable in a double-quoted context, so expressions like $HOME are expanded by the shell. However, since expressions like ~ or * are escaped, they will end up in the PATH verbatim.

Type: list of string

Default: [ ]

Example:

[
  "$HOME/.local/bin"
  "\${xdg.configHome}/emacs/bin"
  ".git/safe/../../bin"
]

Declared by:

Environment variables to always set at login.

The values may refer to other environment variables using POSIX.2 style variable references. For example, a variable parameter may be referenced as $parameter or ${parameter}. A default value foo may be given as per ${parameter:-foo} and, similarly, an alternate value bar can be given as per ${parameter:+bar}.

Note, these variables may be set in any order so no session variable may have a runtime dependency on another session variable. In particular code like

home.sessionVariables = {
  FOO = "Hello";
  BAR = "$FOO World!";
};

may not work as expected. If you need to reference another session variable, then do so inside Nix instead. The above example then becomes

home.sessionVariables = {
  FOO = "Hello";
  BAR = "${config.home.sessionVariables.FOO} World!";
};

Type: lazy attribute set of (string or path or signed integer or floating point number)

Default: { }

Example:

{
  EDITOR = "emacs";
  GS_OPTIONS = "-sPAPERSIZE=a4";
}

Declared by:

An attribute set that maps aliases (the top level attribute names in this option) to command strings or directly to build outputs.

This option should only be used to manage simple aliases that are compatible across all shells. If you need to use a shell specific feature then make sure to use a shell specific option, for example programs.bash.shellAliases for Bash.

Type: attribute set of string

Default: { }

Example:

{
  g = "git";
  "..." = "cd ../..";
}

Declared by:

It is occasionally necessary for Home Manager to change configuration defaults in a way that is incompatible with stateful data. This could, for example, include switching the default data format or location of a file.

The state version indicates which default settings are in effect and will therefore help avoid breaking program configurations. Switching to a higher state version typically requires performing some manual steps, such as data conversion or moving files.

Type: one of “18.09”, “19.03”, “19.09”, “20.03”, “20.09”, “21.03”, “21.05”, “21.11”, “22.05”, “22.11”, “23.05”, “23.11”, “24.05”

Declared by:

The user’s username.

Type: string

Default:

"$USER"   for state version < 20.09,
undefined for state version ≥ 20.09

Example: "jane.doe"

Declared by:

Customized glibcLocales package providing the LOCALE_ARCHIVE_* environment variable.

This option only applies to the Linux platform.

When Home Manager is configured with NixOS, the default value will be set to i18n.glibcLocales from the system configuration.

Type: path

Default: pkgs.glibcLocales

Example:

pkgs.glibcLocales.override {
  allLocales = false;
  locales = [ "en_US.UTF-8/UTF-8" ];
}

Declared by:

Select the enabled input method. Input methods are software to input symbols that are not available on standard input devices.

Input methods are especially used to input Chinese, Japanese and Korean characters.

Currently the following input methods are available in Home Manager:

Type: null or one of “fcitx”, “fcitx5”, “nabi”, “uim”, “hime”, “kime”

Default: null

Example: "fcitx5"

Declared by:

Enabled Fcitx5 addons.

Type: list of package

Default: [ ]

Example: with pkgs; [ fcitx5-rime ]

Declared by:

kime configuration. Refer to https://github.com/Riey/kime/blob/develop/docs/CONFIGURATION.md for details on supported values.

Type: YAML value

Default: { }

Example:

{
  daemon = {
    modules = ["Xim" "Indicator"];
  };

  indicator = {
    icon_color = "White";
  };

  engine = {
    hangul = {
      layout = "dubeolsik";
    };
  };
}

Declared by:

Selected UIM toolbar.

Type: one of “gtk”, “gtk3”, “gtk-systray”, “gtk3-systray”, “qt4”

Default: "gtk"

Example: "gtk-systray"

Declared by:

Whether to enable Home Manager to define per-user daemons by making use of launchd’s LaunchAgents.

Type: boolean

Default: pkgs.stdenv.hostPlatform.isDarwin

Declared by:

Define LaunchAgents.

Type: attribute set of (submodule)

Default: { }

Declared by:

Whether to enable ‹name›.

Type: boolean

Default: false

Example: true