projects/sievemgr

changeset 17:2b799ca75d96

Add configuration example to the documentation
author Guido Berhoerster <guido+sievemgr@berhoerster.name>
date Tue Feb 02 19:04:34 2021 +0100 (7 months ago)
parents 14f5c9152901
children d14d93d011d7
files cmd/sievemgr/doc.go
line diff
     1.1 --- a/cmd/sievemgr/doc.go	Thu Dec 24 09:36:59 2020 +0100
     1.2 +++ b/cmd/sievemgr/doc.go	Tue Feb 02 19:04:34 2021 +0100
     1.3 @@ -86,6 +86,22 @@
     1.4  		skipped.  This renders the connection insecure and should only
     1.5  		be used for testing purposes.
     1.6  
     1.7 +An example configuration with two accounts is provided below:
     1.8 +
     1.9 +	account "work" host "mail.example.com" port 2000 user "foo"
    1.10 +	account "private" default host "example.net" user "baz" pass "qux"
    1.11 +
    1.12 +The first account must be explicitly referred to by its name "work".  sievemgr
    1.13 +will directly connect to the host "mail.example.com" using the non-standard
    1.14 +port 2000 since both host and port are given.  The user will be prompted for
    1.15 +the account password before authentication is performed with the username
    1.16 +"foo".
    1.17 +
    1.18 +The second account is the default account, host and port name of the server
    1.19 +will be determined by looking up the corresponding SRV record associated with
    1.20 +the domain "example.net". Authentication will be performed non-interactively
    1.21 +with the username "baz" and password "qux".
    1.22 +
    1.23  Global Options:
    1.24  
    1.25  	-f config