README.md (view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
 Listfix ======= Listfix is a simple email list manager built with python for the postfix email server. It is intended to be simple to set up and administer. Listfix simply receives email from postfix that is addressesed to a configured email list and replicates that email to all list recipients in it's database. Most of the origninal email headers are stripped and replaced such that the replicated email is properly addressed as having been generated and sent by your email server, with the "From" field having the same user@domain as the email list itself. This is necessary to avoid the email being flagged as spam. Listfix allows you to create multiple email lists, add and remove recipients, and review the contents of lists through a simple command line interface (CLI). As an alternative to the CLI, the Listfix database is stored in json format allowing for simple viewing and manipulating of the list data via your preferred text editor. This json format also allows for easy plugin capaibility via custom written scripts or other software. Table of Contents ----------------- 1. [Download](#download) 2. [Usage](#usage) 3. [Postfix Integration](#postfix-integration) 4. [License](#license) 5. [Tips](#tips) Download -------- #### Requirements: This project was built using python version 3.7. It has not been tested with lower versions. I suggest using at least python 3.7 to avoid any potential issues. #### Download from git: ``` $ git clone git@github.com:bartobri/listfix.git ``` Usage ----- Basic Usage: `listfix.py <command> [<arg_1>,<arg_2>,...]` After downloading the listfix git repo, cd to the listfix directory. Next use the following commands to create and manage your email list database. We'll be using the example everyone@smith-family.com for our email list address. #### Create a new email list: Usage: `listfix.py create <email_list_address> <email_list_name>` ``` $ ./listfix.py create everyone@smith-family.com "Smith Family" New list (everyone@smith-family.com) added. $ ``` #### List all email lists: Usage: `listfix.py lists` ``` $ ./listfix.py lists everyone@smith-family.com (Smith Family) $ ``` #### Add a recipient to an email list: Usage: `listfix.py add <email_list_address> <recipient_address> <recipient_name>` ``` $ ./listfix.py add everyone@smith-family.com mom@example.com "Sue Smith" New recipient (mom@example.com) added to list (everyone@smith-family.com) $ ./listfix.py add everyone@smith-family.com dad@example.com "Bob Smith" New recipient (dad@example.com) added to list (everyone@smith-family.com) $ ./listfix.py add everyone@smith-family.com me@example.com "Joe Smith" New recipient (me@example.com) added to list (everyone@smith-family.com) ``` #### List all recipients in an email list: Usage: `listfix.py dump <email_list_address>` ``` $ ./listfix.py dump everyone@smith-family.com mom@example.com (Sue Smith) dad@example.com (Bob Smith) me@example.com (Joe Smith) $ ``` #### Remove a recipient in an email list: Usage: `listfix.py remove <email_list_address> <recipient_address>` ``` $ ./listfix.py remove everyone@smith-family.com mom@example.com Recipient (mom@example.com) removed from list (everyone@smith-family.com) $ ``` #### Destroy an email list: Usage: `listfix.py destroy <email_list_address>` ``` $ ./listfix.py destroy everyone@smith-family.com Email list (everyone@smith-family.com) destroyed $ ``` Postfix Integration ------------------- These instructions assume you have the postfix email server set up on a unix or linux system and you have virtual domain settings enabled. |