ruby-ezmlm: README.md@cba9fb39bcdb (annotated)

12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	1	# Ruby-Ezmlm
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	2
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	3	code
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	4	: https://bitbucket.org/mahlon/Ruby-Ezmlm
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	5
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	6
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	7	## Authors
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	8
14 cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	9	* Mahlon E. Smith <mahlon@martini.nu>
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	10	* Michael Granger <ged@faeriemud.org>
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	11	* Jeremiah Jordan <jjordan@laika.com>
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	12
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	13
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	14	## Description
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	15
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	16	This is a ruby interface for interacting with ezmlm-idx, an email list
14 cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	17	manager for use with the Qmail MTA, and the messages contained therein.
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	18	(The -idx provides an extended feature set over the original ezmlm
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	19	environment.)
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	20
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	21	http://untroubled.org/ezmlm/
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	22
14 cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	23	This was tested against ezmlm-idx 7.2.2.
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	24
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	25
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	26	## Prerequisites
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	27
14 cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	28	* Ruby 2.1 or better
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	29
1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	30
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	31	## Installation
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	32
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	33	$ gem install ezmlm
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	34
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	35
14 cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	36	## TODO
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	37
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	38	- Text file editing (trailers, etc.)
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	39	- Header / mime list accessors
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	40
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	41
13 a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	42	## Limitations
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	43
14 cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	44	This library doesn't create new lists from scratch. Use ezmlm-make.
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	45
13 a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	46	This library is designed to only work with lists stored on disk (the
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	47	default), not the SQL backends.
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	48
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	49	Address space (32 bit vs 64 bit) matters when ezmlm calculates hashes.
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	50	If things aren't adding up, make sure this library is running on a
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	51	machine with a matching address space as the list itself. (Running this
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	52	on a 64bit machine to talk to 32bit listserv isn't going to play well.)
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	53
14 cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	54	A lot of the fine tuning niceties of ezmlm come as flag options to
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	55	the various ezmlm-* binaries. This library largely just deals with
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	56	ezmlm-make flags for global list behaviors. (For example, see the man
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	57	page for ezmlm-reject.) Patches are welcome if you'd like these sorts
cba9fb39bcdb Checkpoint commit. Mahlon E. Smith <mahlon@laika.com> parents: 13 diff changeset	58	of miscellanous things included.
13 a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	59
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	60
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	61	## License
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	62
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	63	Copyright (c) 2017, Mahlon E. Smith <mahlon@martini.nu>
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	64	All rights reserved.
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	65
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	66	Redistribution and use in source and binary forms, with or without
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	67	modification, are permitted provided that the following conditions are met:
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	68
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	69	* Redistributions of source code must retain the above copyright notice,
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	70	this list of conditions and the following disclaimer.
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	71
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	72	* Redistributions in binary form must reproduce the above copyright notice,
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	73	this list of conditions and the following disclaimer in the documentation
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	74	and/or other materials provided with the distribution.
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	75
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	76	* Neither the name of the author/s, nor the names of the project's
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	77	contributors may be used to endorse or promote products derived from this
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	78	software without specific prior written permission.
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	79
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	80	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	81	AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	82	IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	83	DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	84	FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	85	DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	86	SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	87	CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	88	OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	89	OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

author	Mahlon E. Smith <mahlon@laika.com>
	Mon, 06 Feb 2017 11:54:16 -0800
changeset 14	cba9fb39bcdb
parent 13	a03c08c289e9
child 15	a38e6916504c
permissions	-rw-r--r--