atsip76 / mail-server

Bulk mailing server

Mail-server

Читать readme на русском языке.

It consists of two parts: one is server on Node.js and a client on TypeScript + react-redux.

Installation

$ npm i
$ npm run server:build

You most likely want to change some values ​​in the configuration. Create a file config.json and override the desired values ​​from config.default.json.

Configuration example for config.json:

}
//client configuration
  "client": {
    "apiUrl": "/api",
    "imageServiceUrl": "/images", //URL of the server to download attachments, see: https://gitlab.eterfund.ru/ipfs-images/ipfs-images
    "webpack": {
      "port": 8080,
      "publicPath": "http://localhost:8080/"
    }
  },
//server configuration  
  "server": {
    "corsWhitelist": ["https://examplehost.com"], //array of URLs for CORS
    "fakeSender": false, //intended for server debugging, when set to true instead of sending a mailing, displays information about it to the console
    "logLevel": "silly", // error, warn, info, verbose, debug, silly
    "mail": {//mailing options
      "from": "[email protected]",
      "listIdDomain": "some.domain"
    },
    //parameters of the pause in the mailing (for operation, you must specify both fields)
    "maxEmailsWithoutPause": 3, //the number of successfully sent letters before the pause in the mailing 
    "pauseDuration": 10, //pause duration in seconds

    "port": 8020,
    "redis": {
      "db": 0,//Redis database number
      "pool": {//Redis connection pool configuration
        "min": 1, //minimum number of connections
        "max": 5 //maximum number of connections
      },
      "testingDb": 1 //Redis database number for tests
    },
    "smtp": {//smtp-server settings
      "host": "localhost",
      "port": 9025
    },
    "subscription": {//mailing subscription settings
      "requestTTL": 1209600, //the lifetime of the subscription request in redis
      "subject": "Subscription to mailing" //subject of the letter when subscribing to a mailing
    }
  }
}

After that you can start the server:

$ npm run server:start

or

$ node dist/server/index.js

Client installation

If you also need a client, create a file email-template.html before building it. If you don't need a letter template, just leave it blank.

Next, run the build:

$ npm run client:build

And configure your web server to distribute the contents of the client/public directory.

Principles of operation

Redis is used as a database to store information about mailings.

Mailing has attributes:

• ID;
• Name;
• State (NEW = 1, RUNNING = 2, PAUSED = 3, FINISHED = 4, ERROR = 5);
• Headers (The header List-Idis unique for each mailing. It is generated
  automatically from the time the mailing was created in the format 'YYYYMMDD', mailing id and the parameter list Id Domain. Required to view mailing statistics.);
• Receivers list;
• The number of already processed receivers;

License

Look through the file LICENSE.