mirror of
https://github.com/LnL7/nix-darwin.git
synced 2025-03-05 16:27:03 +00:00
e65131e69c
This process was automated by [my fork of `nix-doc-munge`]; thanks
to @pennae for writing this tool! It automatically checks that the
resulting documentation doesn't change, although my fork loosens
this a little to ignore some irrelevant whitespace and typographical
differences.
As of this commit there is no DocBook remaining in the options
documentation.
You can play along at home if you want to reproduce this commit:
$ NIX_PATH=nixpkgs=flake:nixpkgs/c1bca7fe84c646cfd4ebf3482c0e6317a0b13f22 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run github:emilazy/nix-doc-munge/0a7190f600027bf7baf6cb7139e4d69ac2f51062 \
{} +
[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge
61 lines
2 KiB
Nix
61 lines
2 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.offlineimap;
|
|
in {
|
|
|
|
options.services.offlineimap = {
|
|
enable = mkEnableOption (lib.mdDoc "Offlineimap, a software to dispose your mailbox(es) as a local Maildir(s)");
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.offlineimap;
|
|
defaultText = "pkgs.offlineimap";
|
|
description = lib.mdDoc "Offlineimap derivation to use.";
|
|
};
|
|
|
|
path = mkOption {
|
|
type = types.listOf types.path;
|
|
default = [];
|
|
example = literalExpression "[ pkgs.pass pkgs.bash pkgs.notmuch ]";
|
|
description = lib.mdDoc "List of derivations to put in Offlineimap's path.";
|
|
};
|
|
|
|
startInterval = mkOption {
|
|
type = types.nullOr types.int;
|
|
default = 300;
|
|
description = lib.mdDoc "Optional key to start offlineimap services each N seconds";
|
|
};
|
|
|
|
runQuick = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Run only quick synchronizations.
|
|
Ignore any flag updates on IMAP servers. If a flag on the remote IMAP changes, and we have the message locally, it will be left untouched in a quick run.
|
|
'';
|
|
};
|
|
|
|
extraConfig = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
description = lib.mdDoc "Additional text to be appended to {file}`offlineimaprc`.";
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
environment.systemPackages = [ cfg.package ];
|
|
environment.etc."offlineimaprc".text = cfg.extraConfig;
|
|
launchd.user.agents.offlineimap = {
|
|
path = [ cfg.package ];
|
|
command = "${cfg.package}/bin/offlineimap -c /etc/offlineimaprc" + optionalString (cfg.runQuick) " -q";
|
|
serviceConfig.KeepAlive = false;
|
|
serviceConfig.RunAtLoad = true;
|
|
serviceConfig.StartInterval = cfg.startInterval;
|
|
serviceConfig.StandardErrorPath = "/var/log/offlineimap.log";
|
|
serviceConfig.StandardOutPath = "/var/log/offlineimap.log";
|
|
};
|
|
};
|
|
}
|