Skip to content

Latest commit

 

History

History
78 lines (73 loc) · 2.45 KB

README.md

File metadata and controls

78 lines (73 loc) · 2.45 KB

complete Personalized HTML email sending system

ver 0.8 - Dangerous sharp edges

1. What is it?

Upload zip packages of html emails to be send to multiple receivers.
receiver lists can be imported from json or CSV file.
Emails can be personalized per recipient.

Example
 In html you write insert.name and in send email it will be replaced with
recipients name!
in more complez manner, this can be used to track customers
by tags for example.
PICS

2. Features (some coming)

Email personalization before sending
Automatic image upload
Saveable options
Compose and save receiver lists and emails
Automated scheduled running

3. Technology

  • java spring boot
  • maven
  • thymeleaf
  • mysql
  • Jackson / JSON
  • JPA
  • JavaMail API

4. How to

4.1.1 full install

Ubuntu (Currently only full install platform)

  • you have Java, maven, mysql, apache2
  • Create database & user for mysql (as in application.properties)
  • Clone repo git clone repourl
  • Adjust application.properties file in project root.
  • run install.sh with sudo bash install.sh password y
    password = password for mailUser
    y = creates needed directories for you.
  • mvn package
  • cd target
  • su - mailUser -c "java -jar filename.jar"
4.2 Requires
4.2.1 for local image upload
  • ubuntu
  • Apache2
  • enable userdir in apache2 Tutorial
  • userdir should be home/*/public_html
4.2.2 for remote upload
  • Mysql
  • Maven
  • Java
4.3 Use
4.3.1 zip packages

Max size: 5MB
Max size can be changed in application.properties.
Uploaded zip file should contain just two files,
.html file to be used in email, and pictures in a folder.

  • img folder (.jpg / .png / .gif only)
  • .html document

HTML files and img are now stored in folder.

4.3.2 Receiver lists

New lists can be made and saved within software.
Uploads should be either JSON arrays or CSV files.
Lists are kept in mysql database, and can be reused.

4.3.3 SMTP server credentials

Are asked after uploading a zip file.
These can be saved in mysql for reuse.

5. TODO

  • Remote img upload
  • More personalization
  • Options page
  • import CSV
  • Better user guide
  • More error handling
  • better automated running

6. Licence

--