home-manager/modules/programs/neomutt-accounts.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

87 lines
2.2 KiB
Nix

{ config, lib, ... }:
with lib;
let
extraMailboxOptions = {
options = {
mailbox = mkOption {
type = types.str;
example = "Sent";
description = lib.mdDoc "Name of mailbox folder to be included";
};
name = mkOption {
type = types.nullOr types.str;
example = "Junk";
default = null;
description = lib.mdDoc "Name to display";
};
};
};
in {
options.notmuch.neomutt = {
enable = mkEnableOption (lib.mdDoc "Notmuch support in NeoMutt") // {
default = true;
};
virtualMailboxes = mkOption {
type = types.listOf (types.submodule ./notmuch-virtual-mailbox.nix);
example = [{
name = "My INBOX";
query = "tag:inbox";
}];
default = [{
name = "My INBOX";
query = "tag:inbox";
}];
description = lib.mdDoc "List of virtual mailboxes using Notmuch queries";
};
};
options.neomutt = {
enable = mkEnableOption (lib.mdDoc "NeoMutt");
sendMailCommand = mkOption {
type = types.nullOr types.str;
default = if config.msmtp.enable then
"msmtpq --read-envelope-from --read-recipients"
else
null;
defaultText = literalExpression ''
if config.msmtp.enable then
"msmtpq --read-envelope-from --read-recipients"
else
null
'';
example = "msmtpq --read-envelope-from --read-recipients";
description = lib.mdDoc ''
Command to send a mail. If not set, neomutt will be in charge of sending mails.
'';
};
extraConfig = mkOption {
type = types.lines;
default = "";
example = "color status cyan default";
description = lib.mdDoc ''
Extra lines to add to the folder hook for this account.
'';
};
mailboxName = mkOption {
type = types.nullOr types.str;
default = null;
example = "==== <mailbox-name> ===";
description = lib.mdDoc "Use a different name as mailbox name";
};
extraMailboxes = mkOption {
type = with types; listOf (either str (submodule extraMailboxOptions));
default = [ ];
description = lib.mdDoc "List of extra mailboxes";
};
};
}