README.md

Apillon Mailing Service - MAIL

Mailing service is simple service that provides endpoint and templates for sending emails to users. It (currently) doesn't have any database and does not store any data. For sending emails it uses AWS Simple Email Service (AWS SES). Some mails are pre-written with customizable properties (e.g. templates located in template-data.ts) while some emails can contain custom data for the subject, content etc. There is also a deployed lambda for converting an HTML file to a PDF attachment (e.g. for payment invoices) which is utilized through the GeneratePdfMicroservice class.

Table of Contents

1. Getting Started
2. Configuration
3. Deployment
4. License

Getting Started

Please read Development and Debug and Test documentation. These instructions will help you set up the development environment and run the microservice locally.

Configuration

Environment variables that have to be set:

  /************************************************************
   * MAIL - Apillon Mailing Service
   ************************************************************/

  /**
   *  function name
   */
  MAIL_FUNCTION_NAME: string;
  MAIL_FUNCTION_NAME_TEST: string;
  /**
   * LMAS dev server port
   */
  MAIL_SOCKET_PORT: number;
  MAIL_SOCKET_PORT_TEST: number;
  /**/

  /** MAILING */
  MAIL_TEMPLATE_PATH: string;
  SMTP_HOST: string;
  SMTP_PORT: number;
  SMTP_USE_SSL: boolean;
  SMTP_USERNAME: string;
  SMTP_PASSWORD: string;
  SMTP_NAME_FROM: string;
  SMTP_EMAIL_FROM: string;
  ADMIN_EMAILS: string; // emails for admin notifications

Deployment

Please read Deployment documentation.

License

Copyright (c) Apillon - all rights reserved