home-manager/modules/programs/msmtp-accounts.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

48 lines
1.3 KiB
Nix

{ config, lib, ... }:
with lib;
{
options.msmtp = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Whether to enable msmtp.
If enabled then it is possible to use the
`--account` command line
option to send a message for a given account using the
{command}`msmtp` or {command}`msmtpq` tool.
For example, {command}`msmtp --account=private` would
send using the account defined in
{option}`accounts.email.accounts.private`. If the
`--account` option is not
given then the primary account will be used.
'';
};
tls.fingerprint = mkOption {
type =
types.nullOr (types.strMatching "([[:alnum:]]{2}:)+[[:alnum:]]{2}");
default = null;
example = "my:SH:a2:56:ha:sh";
description = lib.mdDoc ''
Fingerprint of a trusted TLS certificate.
The fingerprint can be obtained by executing
{command}`msmtp --serverinfo --tls --tls-certcheck=off`.
'';
};
extraConfig = mkOption {
type = types.attrsOf types.str;
default = { };
example = { auth = "login"; };
description = lib.mdDoc ''
Extra configuration options to add to {file}`~/.msmtprc`.
See <https://marlam.de/msmtp/msmtprc.txt> for
examples.
'';
};
};
}