README.md
changeset 14 cba9fb39bcdb
parent 13 a03c08c289e9
child 15 a38e6916504c
equal deleted inserted replaced
13:a03c08c289e9 14:cba9fb39bcdb
     4 : https://bitbucket.org/mahlon/Ruby-Ezmlm
     4 : https://bitbucket.org/mahlon/Ruby-Ezmlm
     5 
     5 
     6 
     6 
     7 ## Authors
     7 ## Authors
     8 
     8 
       
     9 * Mahlon E. Smith <mahlon@martini.nu>
     9 * Michael Granger <ged@faeriemud.org>
    10 * Michael Granger <ged@faeriemud.org>
    10 * Jeremiah Jordan <jjordan@laika.com>
    11 * Jeremiah Jordan <jjordan@laika.com>
    11 * Mahlon E. Smith <mahlon@martini.nu>
       
    12 
    12 
    13 
    13 
    14 ## Description
    14 ## Description
    15 
    15 
    16 This is a ruby interface for interacting with ezmlm-idx, an email list
    16 This is a ruby interface for interacting with ezmlm-idx, an email list
    17 manager for use with the Qmail MTA.  (The -idx provides an extended
    17 manager for use with the Qmail MTA, and the messages contained therein.
    18 feature set over the initial ezmlm environment), and messages therein.
    18 (The -idx provides an extended feature set over the original ezmlm
       
    19 environment.)
    19 
    20 
    20 http://untroubled.org/ezmlm/
    21 http://untroubled.org/ezmlm/
       
    22 
       
    23 This was tested against ezmlm-idx 7.2.2.
    21 
    24 
    22 
    25 
    23 ## Prerequisites
    26 ## Prerequisites
    24 
    27 
    25 * Ruby 2.2 or better
    28 * Ruby 2.1 or better
    26 
    29 
    27 
    30 
    28 ## Installation
    31 ## Installation
    29 
    32 
    30     $ gem install ezmlm
    33     $ gem install ezmlm
    31 
    34 
    32 
    35 
       
    36 ## TODO
       
    37 
       
    38   - Text file editing (trailers, etc.)
       
    39   - Header / mime list accessors
       
    40 
       
    41 
    33 ## Limitations
    42 ## Limitations
       
    43 
       
    44 This library doesn't create new lists from scratch.  Use ezmlm-make.
    34 
    45 
    35 This library is designed to only work with lists stored on disk (the
    46 This library is designed to only work with lists stored on disk (the
    36 default), not the SQL backends.
    47 default), not the SQL backends.
    37 
    48 
    38 Address space (32 bit vs 64 bit) matters when ezmlm calculates hashes.
    49 Address space (32 bit vs 64 bit) matters when ezmlm calculates hashes.
    39 If things aren't adding up, make sure this library is running on a
    50 If things aren't adding up, make sure this library is running on a
    40 machine with a matching address space as the list itself.  (Running this
    51 machine with a matching address space as the list itself.  (Running this
    41 on a 64bit machine to talk to 32bit listserv isn't going to play well.)
    52 on a 64bit machine to talk to 32bit listserv isn't going to play well.)
    42 
    53 
    43 The option set offered with ezmlm-make is not fully ported, just the
    54 A lot of the fine tuning niceties of ezmlm come as flag options to
    44 most common switches.  Patches welcome.
    55 the various ezmlm-* binaries.  This library largely just deals with
       
    56 ezmlm-make flags for global list behaviors.  (For example, see the man
       
    57 page for ezmlm-reject.)  Patches are welcome if you'd like these sorts
       
    58 of miscellanous things included.
    45 
    59 
    46 
    60 
    47 ## License
    61 ## License
    48 
    62 
    49 Copyright (c) 2017, Mahlon E. Smith <mahlon@martini.nu>
    63 Copyright (c) 2017, Mahlon E. Smith <mahlon@martini.nu>