Mercurial > projects > managesieve

comparison README @ 0:6369453d47a3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Guido Berhoerster <guido+managesieve@berhoerster.name>
date Thu, 15 Oct 2020 09:11:05 +0200
parents
children 3fe1614de42c
comparison
equal deleted inserted replaced
-1:000000000000 0:6369453d47a3
1 managesieve
2 ===========
3
4 Description
5 -----------
6
7 The package managesieve implements the ManageSieve protocol as specified in
8 RFC 5804. It covers all mandatory parts of the protocol with the exception of
9 the SCRAM-SHA-1 SASL mechanism. Additional SASL authentication mechanisms can
10 be provided by consumers.
11
12 A command-line ManageSieve client called sievemgr is included and provides an
13 example of how the package may be used.
14
15 Usage
16 -----
17
18 API documentation and usage examples can be displayed using the `go doc`
19 command or accessed on [pkg.go.dev][1].
20
21 [1]: https://pkg.go.dev/go.guido-berhoerster.org/managesieve
22 "managesieve documentation"
23
24 Build Instructions
25 ------------------
26
27 managesieve is a Go module and requires Go version 1.14 or later. It can be
28 used by including its canonical name "go.guido-berhoerster.org/managesieve".
29 See the Go documentation for details.
30
31 The sievemgr utility can be built using the `go build` command. See the Go
32 documentation for details.
33
34 Contact
35 -------
36
37 Please send any feedback, translations or bug reports via email to
38 <guido+managesieve@berhoerster.name>.
39
40 Bug Reports
41 -----------
42
43 When sending bug reports, please always mention the exact version of the
44 managesieve package with which the issue occurs as well as the Go
45 compiler and version and version of the operating system you are using
46 and make sure that you provide sufficient information to reproduce the issue
47 and include any input, output, any error messages.
48
49 In case of build issues, please also specify the implementations and versions
50 of the tools used to build the package and/or program, in particular the Go
51 compiler.
52
53 In case of crashes, please attach the full backtrace to the bug report.
54
55 License
56 -------
57
58 Except otherwise noted, all files are Copyright (C) 2020 Guido Berhoerster and
59 distributed under the following license terms:
60
61 Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
62
63 Permission is hereby granted, free of charge, to any person obtaining
64 a copy of this software and associated documentation files (the
65 "Software"), to deal in the Software without restriction, including
66 without limitation the rights to use, copy, modify, merge, publish,
67 distribute, sublicense, and/or sell copies of the Software, and to
68 permit persons to whom the Software is furnished to do so, subject to
69 the following conditions:
70
71 The above copyright notice and this permission notice shall be included
72 in all copies or substantial portions of the Software.
73
74 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
75 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
76 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
77 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
78 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
79 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
80 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.