aboutsummaryrefslogtreecommitdiff
path: root/home-manager/modules/programs/alot.nix
blob: e907cd3e0ac5aed470754ff278060486e27f5bd9 (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# alot config loader is sensitive to leading space !
{ config, lib, pkgs, ... }:

with lib;

let

  cfg = config.programs.alot;

  alotAccounts =
    filter (a: a.notmuch.enable) (attrValues config.accounts.email.accounts);

  boolStr = v: if v then "True" else "False";

  mkKeyValue = key: value:
    let value' = if isBool value then boolStr value else toString value;
    in "${key} = ${value'}";

  mk2ndLevelSectionName = name: "[" + name + "]";

  tagSubmodule = types.submodule {
    options = {
      translated = mkOption {
        type = types.nullOr types.str;
        description = ''
          Fixed string representation for this tag. The tag can be
          hidden from view, if the key translated is set to
          <literal>""</literal>, the empty string.
        '';
      };

      translation = mkOption {
        type = types.nullOr types.str;
        default = null;
        description = ''
          A pair of strings that define a regular substitution to
          compute the string representation on the fly using
          <literal>re.sub</literal>.
        '';
      };

      normal = mkOption {
        type = types.nullOr types.str;
        default = null;
        example = "'','', 'white','light red', 'white','#d66'";
        description = ''
          How to display the tag when unfocused.
          See <link xlink:href="https://alot.readthedocs.io/en/latest/configuration/theming.html#tagstring-formatting"/>.
        '';
      };

      focus = mkOption {
        type = types.nullOr types.str;
        default = null;
        description = "How to display the tag when focused.";
      };
    };
  };

  accountStr = account:
    with account;
    concatStringsSep "\n" ([ "[[${name}]]" ]
      ++ mapAttrsToList (n: v: n + "=" + v) ({
        address = address;
        realname = realName;
        sendmail_command =
          optionalString (alot.sendMailCommand != null) alot.sendMailCommand;
        sent_box = "maildir" + "://" + maildir.absPath + "/" + folders.sent;
        draft_box = "maildir" + "://" + maildir.absPath + "/" + folders.drafts;
      } // optionalAttrs (aliases != [ ]) {
        aliases = concatStringsSep "," aliases;
      } // optionalAttrs (gpg != null) {
        gpg_key = gpg.key;
        encrypt_by_default = if gpg.encryptByDefault then "all" else "none";
        sign_by_default = boolStr gpg.signByDefault;
      } // optionalAttrs (signature.showSignature != "none") {
        signature = pkgs.writeText "signature.txt" signature.text;
        signature_as_attachment = boolStr (signature.showSignature == "attach");
      }) ++ [ alot.extraConfig ] ++ [ "[[[abook]]]" ]
      ++ mapAttrsToList (n: v: n + "=" + v) alot.contactCompletion);

  configFile = let
    bindingsToStr = attrSet:
      concatStringsSep "\n" (mapAttrsToList (n: v: "${n} = ${v}") attrSet);
  in ''
    # Generated by Home Manager.
    # See http://alot.readthedocs.io/en/latest/configuration/config_options.html

    ${generators.toKeyValue { inherit mkKeyValue; } cfg.settings}
    ${cfg.extraConfig}
    [tags]
  '' + (let
    submoduleToAttrs = m:
      filterAttrs (name: v: name != "_module" && v != null) m;
  in generators.toINI { mkSectionName = mk2ndLevelSectionName; }
  (mapAttrs (name: x: submoduleToAttrs x) cfg.tags)) + ''
    [bindings]
    ${bindingsToStr cfg.bindings.global}

    [[bufferlist]]
    ${bindingsToStr cfg.bindings.bufferlist}
    [[search]]
    ${bindingsToStr cfg.bindings.search}
    [[envelope]]
    ${bindingsToStr cfg.bindings.envelope}
    [[taglist]]
    ${bindingsToStr cfg.bindings.taglist}
    [[thread]]
    ${bindingsToStr cfg.bindings.thread}

    [accounts]

    ${concatStringsSep "\n\n" (map accountStr alotAccounts)}
  '';

in {
  options = {
    programs.alot = {
      enable = mkOption {
        type = types.bool;
        default = false;
        example = true;
        description = ''
          Whether to enable the Alot mail user agent. Alot uses the
          Notmuch email system and will therefore be automatically
          enabled for each email account that is managed by Notmuch.
        '';
      };

      hooks = mkOption {
        type = types.lines;
        default = "";
        description = ''
          Content of the hooks file.
        '';
      };

      bindings = mkOption {
        type = types.submodule {
          options = {
            global = mkOption {
              type = types.attrsOf types.str;
              default = { };
              description = "Global keybindings.";
            };

            bufferlist = mkOption {
              type = types.attrsOf types.str;
              default = { };
              description = "Bufferlist mode keybindings.";
            };

            search = mkOption {
              type = types.attrsOf types.str;
              default = { };
              description = "Search mode keybindings.";
            };

            envelope = mkOption {
              type = types.attrsOf types.str;
              default = { };
              description = "Envelope mode keybindings.";
            };

            taglist = mkOption {
              type = types.attrsOf types.str;
              default = { };
              description = "Taglist mode keybindings.";
            };

            thread = mkOption {
              type = types.attrsOf types.str;
              default = { };
              description = "Thread mode keybindings.";
            };
          };
        };
        default = { };
        description = ''
          Keybindings.
        '';
      };

      tags = mkOption {
        type = types.attrsOf tagSubmodule;
        default = { };
        description = "How to display the tags.";
      };

      settings = mkOption {
        type = with types;
          let primitive = either (either (either str int) bool) float;
          in attrsOf primitive;
        default = {
          initial_command = "search tag:inbox AND NOT tag:killed";
          auto_remove_unread = true;
          handle_mouse = true;
          prefer_plaintext = true;
        };
        example = literalExample ''
          {
            auto_remove_unread = true;
            ask_subject = false;
            thread_indent_replies = 2;
          }
        '';
        description = ''
          Configuration options added to alot configuration file.
        '';
      };

      extraConfig = mkOption {
        type = types.lines;
        default = "";
        description = ''
          Extra lines added to alot configuration file.
        '';
      };
    };

    accounts.email.accounts = mkOption {
      type = with types; attrsOf (submodule (import ./alot-accounts.nix pkgs));
    };
  };

  config = mkIf cfg.enable {
    home.packages = [ pkgs.alot ];

    xdg.configFile."alot/config".text = configFile;

    xdg.configFile."alot/hooks.py" = mkIf (cfg.hooks != "") {
      text = ''
        # Generated by Home Manager.
      '' + cfg.hooks;
    };
  };
}