Additional arguments passed to each module in addition to oneslikelib,config,andpkgs,modulesPath.

This option is also available to all submodules. Submodules do notinherit args from their parent module, nor do they provide args totheir parent module or sibling submodules. The sole exception tothis is the argumentname which is provided byparent modules to a submodule and contains the attribute namethe submodule is bound to, or a unique generated name if it isnot bound to an attribute.

Some arguments are already passed by default, of which thefollowingcannot 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:

Email addresses to be associated with this account. Used to check theparticipation status (“PARTSTAT”), refer to khal documentation.

Type:list of string

Default:[ ]

Declared by:

Color in which events in this calendar are displayed.For instance ‘light green’ or an RGB color ‘#ff0000’

Type:null or string

Default:null

Example:"light green"

Declared by:

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

Type:string

Default:"*"

Declared by:

Priority of a calendar used for coloring (calendar with highest priority is preferred).

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:one of “calendar”, “discover”

Default:"calendar"

Declared by:

Local configuration for the calendar.

Type:submodule

Default:{ }

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:".ics"

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”

Default:"filesystem"

Declared by:

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

Type:string(read only)

Declared by:

Whether to enable synchronization using pimsync.

Type:boolean

Default:false

Example:true

Declared by:

Extra directives that should be added under this accounts local storage directive

Type:anything

Default:[ ]

Declared by:

Extra directives that should be added under this accounts pair directive

Type:anything

Default:[ ]

Example:

[  {    name = "collections";    params = [      "all"    ];  }]

Declared by:

Extra directives that should be added under this accounts remote storage directive

Type:anything

Default:[ ]

Example:

[  {    name = "interval";    params = [      60    ];  }]

Declared by:

Whether this is the primary account. Only one account may beset as primary.

Type:boolean

Default:false

Declared by:

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

Type:null or string

Default:null

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 the Thunderbird mail client for this account.

Type:boolean

Default:false

Example:true

Declared by:

Display color of the calendar in hex

Type:string

Default:""

Example:"#dc8add"

Declared by:

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

Type:list of string

Default:[ ]

Example:

[ "profile1" "profile2" ]

Declared by:

Mark calendar as read only

Type:boolean

Default:false

Declared by:

Whether to enable synchronization using vdirsyncer.

Type:boolean

Default:false

Example:true

Declared by:

Authentication settings. The default isbasic.

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

Default:null

Declared by:

Either a path to a certificate with a client certificate andthe 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 standardoutput.

Seehttps://vdirsyncer.pimutils.org/en/stable/config.html#googlefor more information.

Type:null or (list of string)

Default:null

Example:

[  "pass"  "client_id"]

Declared by:

A command that prints the OAuth credentials to standardoutput.

Seehttps://vdirsyncer.pimutils.org/en/stable/config.html#googlefor 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. Eitherremote wins orlocal wins ora list that contains a command to run. By default, an errormessage 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 resultsare not validated.

Type:null or (list of string)

Default:null

Declared by:

Metadata keys that should be synchronized when vdirsyncermetasync is executed.

Type:list of string

Default:[ ]

Example:

[  "color"  "displayname"]

Declared by:

What should happen if synchronization in one directionis impossible due to one storage being read-only.Defaults torevert.

Seehttps://vdirsyncer.pimutils.org/en/stable/config.html#pair-sectionfor 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/updatedfile.

Type:null or strings concatenated with “\n”

Default:null

Declared by:

A time range to synchronize. start and end can be any Pythonexpression that returns adatetime.datetimeobject.

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:

A command that prints the URL of the storage.

Type:null or (list of string)

Default:null

Example:

[  "~/get-url.sh"]

Declared by:

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

Type:null or string

Default:null

Declared by:

A command that prints the user name to standard output.

Type:null or (list of string)

Default:null

Example:

[  "~/get-username.sh"]

Declared by:

Null or path to certificate to verify SSL against

Type:null or absolute path

Default:null

Example:"/path/to/cert.pem"

Declared by:

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

Seehttps://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorialfor more information.

Type:null or string

Default:null

Declared by:

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

Type:string

Example:".calendar"

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:

Email addresses to be associated with this account. Used to check theparticipation status (“PARTSTAT”), refer to khal documentation.

Type:list of string

Default:[ ]

Declared by:

VCARD collections to be searched for contact birthdays.

Type:null or (list of string)

Default:null

Declared by:

Color in which events in this calendar are displayed.For instance ‘light green’ or an RGB color ‘#ff0000’

Type:null or string

Default:null

Example:"light green"

Declared by:

Priority of a calendar used for coloring (calendar with highest priority is preferred).

Type:signed integer

Default:10

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:

If provided, each item on this list will generate anentry on khard configuration file as a separate addressbook(vdir).

This is used for hardcoding sub-directories under the localstorage path(accounts.contact.accounts.<name>.local.path) for khard. Thedefault value will set the aforementioned path as a single vdir.

Type:(list of string) or string convertible to it

Default:

[  ""]

Declared by:

The glob expansion to be searched for contacts whentype is set to discover.

Type:string

Default:"*"

Declared by:

Either a single vdir located inaccounts.contact.accounts.<name>.local.pathor multiple automatically discovered vdirs inaccounts.contact.accounts.<name>.local.path/accounts.contact.accounts.<name>.khard.glob.

Type:one of “vdir”, “discover”

Default:"vdir"

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:".vcf"

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”

Default:"filesystem"

Declared by:

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

Type:string(read only)

Declared by:

Whether to enable synchronization using pimsync.

Type:boolean

Default:false

Example:true

Declared by:

Extra directives that should be added under this accounts local storage directive

Type:anything

Default:[ ]

Declared by:

Extra directives that should be added under this accounts pair directive

Type:anything

Default:[ ]

Example:

[  {    name = "collections";    params = [      "all"    ];  }]

Declared by:

Extra directives that should be added under this accounts remote storage directive

Type:anything

Default:[ ]

Example:

[  {    name = "interval";    params = [      60    ];  }]

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 the Thunderbird mail client for this account.

Type:boolean

Default:false

Example:true

Declared by:

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

Type:list of string

Default:[ ]

Example:

[ "profile1" "profile2" ]

Declared by:

A token is generated when adding an address book manually to Thunderbird, this can be entered here.

Type:null or string

Default:null

Example:"secret_token"

Declared by:

Whether to enable synchronization using vdirsyncer.

Type:boolean

Default:false

Example:true

Declared by:

Authentication settings. The default isbasic.

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

Default:null

Declared by:

Either a path to a certificate with a client certificate andthe 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 standardoutput.

Seehttps://vdirsyncer.pimutils.org/en/stable/config.html#googlefor more information.

Type:null or (list of string)

Default:null

Example:

[  "pass"  "client_id"]

Declared by:

A command that prints the OAuth credentials to standardoutput.

Seehttps://vdirsyncer.pimutils.org/en/stable/config.html#googlefor 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. Eitherremote wins orlocal wins ora list that contains a command to run. By default, an errormessage 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 resultsare not validated.

Type:null or (list of string)

Default:null

Declared by:

Metadata keys that should be synchronized when vdirsyncermetasync is executed.

Type:list of string

Default:[ ]

Example:

[  "color"  "displayname"]

Declared by:

What should happen if synchronization in one directionis impossible due to one storage being read-only.Defaults torevert.

Seehttps://vdirsyncer.pimutils.org/en/stable/config.html#pair-sectionfor 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/updatedfile.

Type:null or strings concatenated with “\n”

Default:null

Declared by:

A time range to synchronize. start and end can be any Pythonexpression that returns adatetime.datetimeobject.

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:

A command that prints the URL of the storage.

Type:null or (list of string)

Default:null

Example:

[  "~/get-url.sh"]

Declared by:

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

Type:null or string

Default:null

Declared by:

A command that prints the user name to standard output.

Type:null or (list of string)

Default:null

Example:

[  "~/get-username.sh"]

Declared by:

Null or path to certificate to verify SSL against

Type:null or absolute path

Default:null

Example:"/path/to/cert.pem"

Declared by:

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

Seehttps://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorialfor more information.

Type:null or string

Default:null

Declared by:

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

Type:string

Declared by:

List of email accounts.

Type:attribute set of (submodule)

Default:{ }

Declared by:

Whether this account is enabled. Potentially useful to allowsetting email configuration globally then enabling or disabling onspecific systems.

Type:boolean

Default:true

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.Seeaerc-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.Seeaerc-binds(5).

Type:attribute set of (strings concatenated with “\n” or 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,useprograms.aerc.extraConfig.Seeaerc-config(5).

Type:attribute set of (strings concatenated with “\n” or 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 incomingmethod.Seeaerc-imap(5).

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

Default:null

Example:"auth"

Declared by:

Sets the oauth2 params if authentication mechanism oauthbearer orxoauth2 is used.Seeaerc-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 outgoingmethod.Seeaerc-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 orxoauth2 is used.Seeaerc-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 identities of this account.

Type:list of (string matching the pattern .*@.* or (submodule))

Default:[ ]

Example:

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

Declared by:

Contact completion configuration as expected per alot.Seealot’s wiki forexplanation about possible values.

Type:attribute set of string

Default:

{  type = "shellcommand";  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";}

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 tomsmtpq --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 tomsmtpq --read-envelope-from --read-recipients.

Type:string

Declared by:

Some email providers have peculiar behavior that requirespecial treatment. This option is therefore intended toindicate the nature of the provider.

When this indicates a specific provider then, for example,the IMAP, SMTP, and JMAP server configuration may be setautomatically.

Type:one of “davmail”, “fastmail.com”, “gmail.com”, “migadu.com”, “outlook.office365.com”, “plain”, “runbox.com”, “yandex.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. Mostusers should either enabledelete or disablereadAll.

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 canuse theALL 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 theserver. Most users should either enabledelete ordisablereadAll.

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 ingpg --list-keys.

Type:string

Declared by:

Sign messages by default.

Type:boolean

Default:false

Declared by:

Whether to enable the email client Himalaya CLI for this email account.

Type:boolean

Default:false

Example:true

Declared by:

Himalaya CLI configuration for this email account.Seehttps://github.com/pimalaya/himalaya/blob/master/config.sample.toml for supported values.

Type:open submodule of (TOML value)

Default:{ }

Declared by:

The IMAP configuration to use for this account.

Type:null or (submodule)

Default:null

Declared by:

The authentication mechanism.

Type:null or string or one of “anonymous”, “apop”, “clear”, “cram_md5”, “digest_md5”, “gssapi”, “login”, “ntlm”, “plain”, “xoauth2”

Default:null

Example:"plain"

Declared by:

Hostname of IMAP server.

Type:string

Example:"imap.example.org"

Declared by:

The port on which the IMAP server listens. Ifnull 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 shouldbe used to validate the connection authenticity. Ifnull then the system default is used.Note, if set then the system default may still be accepted.

Type:null or absolute 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:

Extra arguments to pass to goimapnotify.

Type:list of string

Default:[ ]

Example:

[  "-wait 1"]

Declared by:

Additional configuration to add for this account.

Type:JSON value

Default:{ }

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 andaccounts.email.accounts.<name>.jmap.sessionUrl are specified,host is preferred by applications when establishing asession.

Type:null or string

Default:null

Example:"jmap.example.org"

Declared by:

URL for the JMAP Session resource.

If both this option andaccounts.email.accounts.<name>.jmap.host are specified,host is preferred by applications when establishing asession.

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 ifnotmuch inithas been used to configure this account outside of HomeManager.

Type:boolean

Default:true

Declared by:

Settings which are applied to.gmailieer.jsonfor the account.

See thelieer manualfor documentation of settings not explicitly covered by this module.

Type:open submodule of (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 usefulfor indexing with third-party programs.

Type:string

Default:""

Example:"mbox"

Declared by:

Work around a Gmail API quirk where an empty change historyis sometimes returned.

See thisGitHub issuefor more details.

Type:boolean

Default:false

Declared by:

Set Gmail labels to ignore when syncing from remote labels tolocal 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 toremote 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 theonCalendar option. Seesystemd.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 isstored. 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 thegiven mail store.

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

Default:"none"

Example:"maildir"

Declared by:

Permanently remove messages marked for deletion fromthe 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:

{  TLSType = "IMAP";  TLSVersions = [ "+1.3" "+1.2" "-1.1" ];  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 bysubstituting 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 forsynchronized email messages. Namely, when using mbsync without specifyinga set of channels into a group, all synchronized directories end up beneaththe[Gmail]/ directory.

This option allows you to specify a group, and subsequently channels thatwill 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. Whenperforming a synchronization, the groups are synchronized, rather thanthe individual channels.

Using these channels and then grouping them together allows for you todefine the maildir hierarchy as you see fit.

Type:attribute set of (submodule)

Default:{ }

Declared by:

Extra configuration lines to add toTHIS channel’sconfiguration.

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.IfPatterns are specified,farPatternis 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 patternINBOX.

Type:string

Default:""

Example:"[Gmail]/Sent Mail"

Declared by:

The unique name for THIS channel in THIS group. The group will refer tothis channel by this name.

In addition, you can manually sync just this channel by specifying thisname 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 uplocally. The mailbox specified by the far pattern will be placed inthis directory.

If this is left as the default, then mbsync will default to the patternINBOX.

Type:string

Default:""

Example:"Sent"

Declared by:

Instead of synchronizingjust the mailboxes thatmatch thefarPattern, use it as a prefix which isnot matched against the patterns, and is not affected by mailbox listoverrides.

Type:list of string

Default:[ ]

Example:

[  "INBOX"]

Declared by:

The name of this group for this account. These names are different thansome 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 noeffect whenflatten is used.

Type:one of “Verbatim”, “Maildir++”, “Legacy”

Default:"Verbatim"

Example:"Maildir++"

Declared by:

Whether to enable the meli mail client for this account.Requires SMTP settings…

Type:boolean

Default:false

Example:true

Declared by:

Folder display name

Type:attribute set of (attribute set)

Default:{ }

Example:

{  INBOX = {    alias = "📥 Inbox";  };  Sent = {    alias = "📤 Sent";  };}

Declared by:

Mailboxes to show in meli

Type:list of string

Default:

[  "Inbox"  "Sent"  "Trash"  "Drafts"]

Example:

[  "INBOX"  "Sent"  "Trash"  "Drafts"]

Declared by:

Whether to enable msmtp.

If enabled then it is possible to use the--account command lineoption to send a message for a given account using themsmtp ormsmtpq tool.For example,msmtp --account=private wouldsend using the account defined inaccounts.email.accounts.private. If the--account option is notgiven then the primary account will be used.

Type:boolean

Default:false

Declared by:

Extra configuration options to add to~/.msmtprc.Seehttps://marlam.de/msmtp/msmtprc.txt forexamples.

Type:attribute set of string

Default:{ }

Example:

{  auth = "login";}

Declared by:

Fingerprint of a trusted TLS certificate.The fingerprint can be obtained by executingmsmtp --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 ifmujmap.toml is managedoutside of Home Manager.

Type:boolean

Default:true

Declared by:

Settings which are applied tomujmap.tomlfor the account.

See themujmap projectfor documentation of settings not explicitly covered by this module.

Type:open submodule of (TOML value)

Default:{ }

Declared by:

Whether to create new mailboxes automatically on the server from notmuchtags.

Type:boolean

Default:true

Declared by:

The cache directory in which to store mail files while they are beingdownloaded. 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 sessionURL. Mutually exclusive withaccounts.email.accounts.<name>.mujmap.settings.session_url.

Ifnull, defaults toaccounts.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 HTTPauthentication.

Ifnull, defaults toaccounts.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 withaccounts.email.accounts.<name>.mujmap.settings.fqdn.

Ifnull, defaults toaccounts.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 thevalues of these files; please seehttps://github.com/elizagamedev/mujmap/blob/main/mujmap.toml.examplefor more details.

Type:open submodule of (TOML value)

Default:{ }

Declared by:

Tag for notmuch to use for messages stored in the mailbox labeled with theTrash name attribute.

If set to an empty string, this mailboxand its childmailboxes 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 theImportant name attribute and/or with the$Importantkeyword.

If set to an empty string, this mailbox,its childmailboxes, 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 theInbox name attribute.

If set to an empty string, this mailboxand its childmailboxes are not synchronized with a tag.

Type:string

Default:"inbox"

Declared by:

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

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 theSent name attribute.

If set to an empty string, this mailboxand its childmailboxes 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 theJunk name attribute and/or with the$Junk keyword,except for messages with the$NotJunk keyword.

If set to an empty string, this mailbox,its childmailboxes, and these keywords are not synchronized with a tag.

Type:string

Default:"spam"

Declared by:

Username for basic HTTP authentication.

Ifnull, defaults toaccounts.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 theattribute 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:

Whether this account uses maildir folders or IMAP mailboxes

Type:one of “maildir”, “imap”

Default:"maildir"

Example:"imap"

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:

Show the default mailbox (INBOX)

Type:boolean

Default:true

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 accountsection.

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 accountsection.

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 onstandard 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 beset 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 absolute 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:

The authentication mechanism.

Type:null or string or one of “anonymous”, “apop”, “clear”, “cram_md5”, “digest_md5”, “gssapi”, “login”, “ntlm”, “plain”, “xoauth2”

Default:null

Example:"plain"

Declared by:

Hostname of SMTP server.

Type:string

Example:"smtp.example.org"

Declared by:

The port on which the SMTP server listens. Ifnull 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 shouldbe used to validate the connection authenticity. Ifnull then the system default is used.Note, if set then the system default may still be accepted.

Type:null or absolute 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:

List of message filters to add to this Thunderbird accountconfiguration.

Type:list of (submodule)

Default:[ ]

Example:

[  {    name = "Mark as Read on Archive";    enabled = true;    type = "128";    action = "Mark read";    condition = "ALL";  }]

Declared by:

Whether this filter is currently active.

Type:boolean

Default:true

Declared by:

Action to perform on matched messages.

Type:string

Declared by:

Argument passed to the filter action, e.g. a folder path.

Type:null or string

Default:null

Declared by:

Condition to match messages against.

Type:string

Declared by:

Extra settings to apply to the filter

Type:null or string

Default:null

Declared by:

Name for the filter.

Type:string

Declared by:

The raw text of the filter.Note that this will override all other options.

Type:null or string

Default:null

Declared by:

Type for this filter.

Type:string

Declared by:

Extra settings to add to each identity of this Thunderbirdaccount configuration. Theid given asargument 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 beenabled. If this list is empty (the default), this account willbe enabled for all declared profiles.

Type:list of string

Default:[ ]

Example:

[ "profile1" "profile2" ]

Declared by:

Extra settings to add to this Thunderbird account configuration.Theid given as argument is an automaticallygenerated 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 asthe SMTP, IMAP, and JMAP user name.

Type:null or string

Default:null

Declared by:

Path to default file containing certificate authorities thatshould be used to validate the connection authenticity. Thispath may be overridden on a per-account basis.

Type:null or absolute path

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

Declared by:

The base directory for account maildir directories. May be arelative path (e.g. the user setting this value as “MyMaildir”),in which case it is relative the home directory (e.g. resultingin “~/MyMaildir”).

Type:string

Default:"Maildir"

Declared by:

Packages whose D-Bus configuration files should be included inthe configuration of the D-Bus session-wide message bus. Specifically,files in «pkg»/share/dbus-1/services will be included in the user’s$XDG_DATA_HOME/dbus-1/services directory.

Type:list of package

Default:[ ]

Declared by:

Settings to write to the dconf configuration system.

Note that the database is strongly-typed so you need to use the same typesas described in the GSettings schema. For example, if an option is of typeuint32 (u), you need to wrap the numberusing thelib.hm.gvariant.mkUint32 constructor.Otherwise, since Nix integers are implicitly coerced toint32(i), it would get stored in the database as such, and GSettingsmight be confused when loading the setting.

You might want to usedconf2nixto 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.Seehttps://editorconfig.org for documentation.

Type:attribute set of section of an INI file (attrs 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, forexample, allow fontconfig to discover fonts andconfigurations installed throughhome.packages andnix-env.

Type:boolean

Default:false

Declared by:

Whether to enable font antialiasing.

Type:null or boolean

Default:null

Example:true

Declared by:

Extra font config files that will be added to~/.config/fontconfig/conf.d/.Files are named likefontconfig/conf.d/{priority}-{label}.conf.

Type:attribute set of (submodule)

Default:{ }

Example:

{  commit-mono-options = {    enable = true;    priority = 80;    source = "./resources/fontconfig/commit-mono.conf";  };  tamzen = {    enable = true;    label = "tamzen-disable-antialiasing";    priority = 90;    text = ''      <?xml version="1.0"?>      <!DOCTYPE fontconfig SYSTEM "fonts.dtd">            <fontconfig>        <description>Disable anti-aliasing for Tamzen since it is a bitmap font</description>        <match target="pattern">          <test name="family" compare="eq" qual="any">            <string>Tamzen</string>          </test>          <edit name="antialias" mode="assign">            <bool>false</bool>          </edit>        </match>      </fontconfig>    '';  };}

Declared by:

Whether to enable Whether this font config file should be generated…

Type:boolean

Default:false

Example:true

Declared by:

Label to use for the name of the config file.

Type:string

Default:"<name>"

Declared by:

Determines the order in which configs are loaded.Must be a value within the range of 0-99, where priority 0 is the highest priority and 99 is the lowest.

Type:integer between 0 and 99 (both inclusive)

Default:90

Declared by:

Config file to source. Alternatively, use the ‘text’ option instead.

Type:null or absolute path

Default:null

Declared by:

Verbatim contents of the config file. If this option is null then the ‘source’ option must be set.

Type:null or strings concatenated with “\n”

Default:null

Declared by:

Per-user default emoji font(s). Multiple fonts may be listed incase a font does not support all emoji.

Note that fontconfig matches color emoji fonts preferentially,so if you want to use a black and white font while havinga color font installed (eg. Noto Color Emoji installed alongsideNoto Emoji), fontconfig will still choose the color font evenwhen it is later in the list.

Type:list of string

Default:[ ]

Declared by:

Per-user default monospace font(s). Multiple fonts may be listed incase multiple languages must be supported.

Type:list of string

Default:[ ]

Declared by:

Per-user default sans serif font(s). Multiple fonts may be listedin case multiple languages must be supported.

Type:list of string

Default:[ ]

Declared by:

Per-user default serif font(s). Multiple fonts may be listed incase multiple languages must be supported.

Type:list of string

Default:[ ]

Declared by:

The font hinting mode.

Type:null or one of “none”, “slight”, “medium”, “full”

Default:null

Example:"slight"

Declared by:

The sub-pixel rendering mode.

Type:null or one of “none”, “rgb”, “bgr”, “vertical-rgb”, “vertical-bgr”

Default:null

Example:"rgb"

Declared by:

Whether to enable GTK theming and configuration.

Type:boolean

Default:false

Example:true

Declared by:

Default color scheme for all GTK versions

Type:null or one of “dark”, “light”

Default:null

Declared by:

Default cursor theme for all GTK versions.

Type:null or (submodule)

Default:null

Declared by:

Package providing the cursor theme. This package will be installedto your profile. Ifnull then the cursor themeis 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:

Default font for all GTK versions.

Type:null or (submodule)

Default:null

Declared by:

Package providing the font. This package will be installedto your profile. Ifnull then the fontis 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:

Whether to enable GTK 2 configuration.

Type:boolean

Default:true

Example:true

Declared by:

The location of the GTK 2 configuration file.

Type:absolute path

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

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

Declared by:

Cursor theme for GTK 2 applications.

Type:null or (submodule)

Default:config.gtk.cursorTheme

Declared by:

Package providing the cursor theme. This package will be installedto your profile. Ifnull then the cursor themeis 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:

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

Type:strings concatenated with “\n”

Default:""

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

Declared by: