mail module additions #318

teto · 2018-07-22T14:04:01Z

Adds msmtp, offlineimap, alot configurations.

I updated my previous code to fit the new system and removed some coupling between modules to make reviewing easier.

rycee · 2018-07-23T12:11:07Z

modules/lib/mail.nix

@@ -0,0 +1,8 @@
+{ config, lib }:
+{
+  isGmail = account:


Better add a "gmail" option in https://github.com/rycee/home-manager/blob/9570cedff62a6d08eb13f8c6164b496ff88c834f/modules/accounts/email.nix#L146-L158

rycee · 2018-07-23T12:13:11Z

modules/programs/alot.nix

+{ config, lib, pkgs, ... } @ top:
+
+with lib;
+with import ../lib/dag.nix { inherit lib; };


Better remove this and add

let cfg = config.programs.alot; dag = config.lib.dag; …

instead.

rycee · 2018-07-23T12:22:52Z

modules/programs/alot.nix

+          thread_indent_replies = 4;
+        '';
+        description = ''
+          Extra configuration lines to add to ~/.config/alot/config.


Either need some markup here, e.g.,

Extra configuration lines to add to <filename>~/.config/alot/config</filename>.

or rewording it, e.g.,

Extra lines to add to the alot configuration file.

rycee · 2018-07-23T12:24:33Z

modules/programs/alot.nix

+        default = ''
+          auto_remove_unread = True;
+          ask_subject = False;
+          handle_mouse = "True;


Perhaps this is some syntax error? I guess a quote has to be terminated by another quote…

rycee · 2018-07-23T12:25:54Z

modules/programs/alot.nix

+      extraConfig = mkOption {
+        type = types.lines;
+        default = ''
+          auto_remove_unread = True;


Does alot configuration lines really end with a semicolon?

rycee · 2018-07-23T12:30:27Z

modules/programs/alot.nix

+
+  notmuchConfig = account: "$XDG_CONFIG_HOME/notmuch/notmuchrc";
+
+  alot_accounts = config.accounts.email.accounts;


Maybe need to filter out those accounts for which alot.enable == true? Something like

filter (a: a.alot.enable) (attrValues config.accounts.email.accounts)

I'm guessing alot requires notmuch to be enabled for the account? If so, then it's probably best to add an assertion along the lines of

assertions = [ ( let badAccounts = filter (a: !a.notmuch.enable) alotAccounts; in { assertion = badAccounts == []; message = "alot: Notmuch not enabled for accounts: " + concatMapStringsSep ", " (a: a.name) badAccounts; } ) { assertion = config.notmuch.enable; message = "Notmuch not enabled"; } ];

Note, not tested and the message phrasing could be improved.

I would rather have alot enable notmuch automatically ?! (yes notmuch is mandatory)

rycee · 2018-07-23T12:31:11Z

modules/programs/alot.nix

@@ -0,0 +1,145 @@
+# alot config loader is sensitive to leading space !
+{ config, lib, pkgs, ... } @ top:


Can remove @ top since top doesn't seem to be used.

rycee

Thanks for the PR! I've begun adding comments but don't have time to go through everything right now. I'll continue at some later time.

Also it would be nice to have the commit split into one commit per program. That would make the PR easier to review and the Git history would be cleaner.

rycee · 2018-07-23T12:38:24Z

modules/programs/alot.nix

+
+  notmuchConfig = account: "$XDG_CONFIG_HOME/notmuch/notmuchrc";
+
+  alot_accounts = config.accounts.email.accounts;


Should use camel case: alotAccounts.

rycee · 2018-07-23T14:19:31Z

modules/programs/alot.nix

+
+  cfg = config.programs.alot;
+
+  notmuchConfig = account: "$XDG_CONFIG_HOME/notmuch/notmuchrc";


The account argument is not used so I guess it could be removed? Also, $XDG_CONFIG_HOME might not be set, in which case this path would be incorrect. I'd suggest to use

"${config.xdg.configHome}/notmuch/notmuchrc"

instead. Or even notmuchConfig = "$NOTMUCH_CONFIG" since the Notmuch module sets that session variable.

rycee · 2018-07-23T14:19:50Z

modules/programs/alot.nix

+
+      # contact completion
+      ${contactCompletionStr account}
+      ${if showSignature == "attach" then "gpg_key = {account." else ""}


Is "gpg_key = {account." intentional? Looks like a mistake 🙂

B.t.w, could also use optionalString, e.g.,

${optionalString (showSignature == "attach") "gpg_key = {account."}

I removed the gpg aspect. This can be added a posteriori

Yeah, I've left gpg support undefined in the accounts module for now. I believe it should be included as some point but I'd prefer to think about it first so that the design is sufficiently good.

rycee · 2018-07-23T14:20:03Z

modules/programs/alot.nix

+    pkgs.writeText "alot.conf" (''
+# Generated by home-manager
+# see http://alot.readthedocs.io/en/latest/configuration/config_options.html
+hooksfile = "$XDG_CONFIG_HOME/alot/hm_hooks"


I'm guessing this would result in the wrong path if $XDG_CONFIG_HOME is not set. I would suggest using

hooksfile = "${config.xdg.configHome}/alot/hm_hooks"

In fact I would prefer to rely on the environment variable so I've added a fallback ${XDG_CONFIG_HOME:-$HOME/.config}. Hardcoding the path kinda break the purpose of environment variables.

Fair enough, I'm happy as long as it is able to cope with the variable being missing.

rycee · 2018-07-23T14:26:44Z

modules/programs/alot.nix

+        description = "Can override what is decided in contactCompletion";
+      };
+
+      bindings = mkOption {


I had a look at the alot manual and perhaps this could be a submodule? Something like

bindings = { global = { "mouse press 4" = "move up"; # … }; bufferlist = { x = "close"; # … }; search = { enter = "select"; # … }; envelope = { a = "prompt 'attach ~/'"; # … }; taglist = { enter = "select"; # … }; thread = { enter = "select"; # … }; };

I.e., "global", "envelope", "search", "thread", "taglist", and "bufferlist" are options inside the submodule and each of them has a type such as types.attrsOf types.str.

rycee · 2018-07-23T15:00:42Z

modules/programs/alot.nix

+
+      contactCompletionCommand = mkOption {
+        default = contactCompletionStr;
+        description = "Can override what is decided in contactCompletion";


Need some better description that doesn't assume knowledge of the module implementation.

rycee · 2018-07-23T15:01:18Z

modules/programs/msmtp.nix

+    if cfg.offlineSendMethod == "native" then
+      "${pkgs.msmtp}/bin/msmtpq -C $XDG_CONFIG_HOME/msmtp/config --account=${account.name} -t"
+    else
+      "${pkgs.msmtp}/bin/msmtp $XDG_CONFIG_HOME/msmtp/config --account=${account.name} -t";


Can't assume that $XDG_CONFIG_HOME is set, better use ${config.xdg.configHome}.

rycee · 2018-07-23T15:02:22Z

modules/programs/msmtp.nix

+  accountStr = {userName, address, realName, ...} @ account: ''
+defaults
+tls on
+logfile ~/.msmtp.log


Perhaps config.xdg.dataHome is a better location for the log file?

rycee · 2018-07-23T15:03:28Z

modules/programs/msmtp.nix

+    else "";
+
+  accountStr = {userName, address, realName, ...} @ account: ''
+defaults


Hmm, won't this produce a defaults section for each account? I would assume it's best to only have one defaults section in the configuration.

rycee · 2018-07-23T15:04:28Z

modules/programs/msmtp.nix

+      ''passwordeval bash -c "echo $(${toString account.passwordCommand})"''
+    else "";
+
+  accountStr = {userName, address, realName, ...} @ account: ''


Perhaps simpler to do

accountStr = account: with account; '' … '';

?

teto · 2018-07-28T18:04:38Z

I would like to automatically enable notmuch for every account using alot. This

  config = mkIf cfg.enable {


    accounts.email = let
        enableNotmuch = account: 
          { account.notmuch.enable = true; };
      in
        mkMerge ( map enableNotmuch alotAccounts);
}

but this generates an infinite loop. any idea ?

rycee · 2018-08-01T20:18:54Z