home-manager/modules/programs/getmail-accounts.nix

{ lib, ... }:
let
  inherit (lib) mkOption types;
in
{
  options.getmail = {
    enable = lib.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 `ALL` 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 `delete` or disable
        `readAll`.
      '';
    };

    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 `delete` or
        disable `readAll`.
      '';
    };

  };
}