mirror of
https://github.com/nix-community/home-manager
synced 2024-11-10 07:04:17 +00:00
36a53d9f26
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
50 lines
1.2 KiB
Nix
50 lines
1.2 KiB
Nix
{ config, lib, ... }:
|
|
|
|
with lib;
|
|
|
|
{
|
|
options.getmail = {
|
|
enable =
|
|
mkEnableOption (lib.mdDoc "the getmail mail retriever for this account");
|
|
|
|
destinationCommand = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
example = "\${pkgs.maildrop}/bin/maildrop";
|
|
description = lib.mdDoc ''
|
|
Specify a command delivering the incoming mail to your maildir.
|
|
'';
|
|
};
|
|
|
|
mailboxes = mkOption {
|
|
type = types.nonEmptyListOf types.str;
|
|
default = [ ];
|
|
example = [ "INBOX" "INBOX.spam" ];
|
|
description = lib.mdDoc ''
|
|
A non-empty list of mailboxes. To download all mail you can
|
|
use the `ALL` mailbox.
|
|
'';
|
|
};
|
|
|
|
delete = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Enable if you want to delete read messages from the server. Most
|
|
users should either enable `delete` or disable
|
|
`readAll`.
|
|
'';
|
|
};
|
|
|
|
readAll = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = lib.mdDoc ''
|
|
Enable if you want to fetch all, even the read messages from the
|
|
server. Most users should either enable `delete` or
|
|
disable `readAll`.
|
|
'';
|
|
};
|
|
|
|
};
|
|
}
|