aboutsummaryrefslogtreecommitdiff
path: root/home-manager/modules/programs/getmail-accounts.nix
blob: 24eb4fb588a660fc79cad730b4cb493867ede59a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{ config, lib, ... }:

with lib;

{
  options.getmail = {
    enable = mkEnableOption "the getmail mail retriever for this account";

    destinationCommand = mkOption {
      type = types.nullOr types.str;
      default = null;
      example = "\${pkgs.maildrop}/bin/maildrop";
      description = ''
        Specify a command delivering the incoming mail to your maildir.
      '';
    };

    mailboxes = mkOption {
      type = types.nonEmptyListOf types.str;
      default = [ ];
      example = [ "INBOX" "INBOX.spam" ];
      description = ''
        A non-empty list of mailboxes. To download all mail you can
        use the <literal>ALL</literal> mailbox.
      '';
    };

    delete = mkOption {
      type = types.bool;
      default = false;
      description = ''
        Enable if you want to delete read messages from the server. Most
        users should either enable <literal>delete</literal> or disable
        <literal>readAll</literal>.
      '';
    };

    readAll = mkOption {
      type = types.bool;
      default = true;
      description = ''
        Enable if you want to fetch all, even the read messages from the
        server. Most users should either enable <literal>delete</literal> or
        disable <literal>readAll</literal>.
      '';
    };

  };
}