Mirrors/home-manager
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

mbsync: option for configuring a channel

Browse source 
A channel is a relationship between 2 directories/boxes/mailboxes
between the local machine (slave) and the remote mail server (master).
Each channel must be given at least:
     * an account-unique name
     * a pattern for which mailboxes to sync from master
     * a pattern for what directory where that mail ends up on the
     slave

Additional options can be added later.
This commit is contained in:
Karl Hallsby 2020-06-26 13:36:15 +02:00
parent a94c8b072e
commit d6dcf9f106
1 changed files with 42 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
modules/programs/mbsync-accounts.nix
View file

@ -6,6 +6,48 @@ let
extraConfigType = with lib.types; attrsOf (either (either str int) bool);
# Options for configuring channel(s) that will be composed together into a group.
groupChannel = { config, ... }: {
options = {
name = mkOption {
type = types.str;
default = "DEFAULT";
description = ''
The unique name for THIS channel in THIS group. The group will refer to
this channel by this name.
</para><para>
In addition, you can manually sync just this channel by specifying this
name to mbsync on the command line.
'';
};
masterPattern = mkOption {
type = types.str;
default = "";
description = ''
Regular expression pattern for which mailboxes on the remote mail server
to sync.
</para><para>
If this is left as the default, then mbsync will default to the pattern
<literal>INBOX</literal>.
'';
};
slavePattern = mkOption {
type = types.str;
default = "";
description = ''
Name for where mail coming from the master mail server will end up
locally. The mailbox specified by the master's pattern will be placed
in this directory.
</para><para>
If this is left as the default, then mbsync will default to the pattern
<literal>INBOX</literal>.
'';
};
};
};
in {
options.mbsync = {
enable = mkEnableOption "synchronization using mbsync";