comparison cmd/sievemgr/doc.go @ 17:2b799ca75d96

Add configuration example to the documentation
author Guido Berhoerster <guido+sievemgr@berhoerster.name>
date Tue, 02 Feb 2021 19:04:34 +0100
parents 44c07eb8ef08
children fc5e6970a0d5
comparison
equal deleted inserted replaced
16:14f5c9152901 17:2b799ca75d96
84 Optionally specify that verification of the certificate 84 Optionally specify that verification of the certificate
85 presented by the server when making a TLS connection should be 85 presented by the server when making a TLS connection should be
86 skipped. This renders the connection insecure and should only 86 skipped. This renders the connection insecure and should only
87 be used for testing purposes. 87 be used for testing purposes.
88 88
89 An example configuration with two accounts is provided below:
90
91 account "work" host "mail.example.com" port 2000 user "foo"
92 account "private" default host "example.net" user "baz" pass "qux"
93
94 The first account must be explicitly referred to by its name "work". sievemgr
95 will directly connect to the host "mail.example.com" using the non-standard
96 port 2000 since both host and port are given. The user will be prompted for
97 the account password before authentication is performed with the username
98 "foo".
99
100 The second account is the default account, host and port name of the server
101 will be determined by looking up the corresponding SRV record associated with
102 the domain "example.net". Authentication will be performed non-interactively
103 with the username "baz" and password "qux".
104
89 Global Options: 105 Global Options:
90 106
91 -f config 107 -f config
92 Set the name of the configuration file to config. 108 Set the name of the configuration file to config.
93 109