Contact Form API

A self hosted way to host a contact form on your website. A minimalist server written in Node.js to fit your basic need.

Features

• Validation
• Email notification
• Email confirmation (back to the sender)
• Discord webhook notification
• Rate limiting
• Origin/Domains whitelist (CORS support)
• Flexible JSON configuration
• I18n support (fr and en, add a new locale by creating a Pull Request!)

Installation & Configuration

• Clone this repository
• We recommend the use of yarn v1
• Install the packages: yarn install
• Fill your .env (from .env.example) with the desired HOST and PORT env var
• Then, From the content of config.example.json, create your own config.json:
  • The smtp object contain all the SMTP configuration. Every field is required, Using nodemailer under the hood
    • id: used to identify the config later in the apps object.
    • host: host to the SMTP server
    • port: port to the SMTP server
    • secure: boolean
    • auth:
      • user: The email address or username to identify with the SMTP server
      • pass: The password to authenticate with the SMTP server
  • The apps object contain all the applications
    • id: used to identify the app when posting a message. Required, Cannot be null
    • name: name that will show up in email and webhooks. Required, Cannot be null
    • origins: a array of all the allowed origin to post message for this app (verification via the 'Origin' header), if null, no domain verification will be conducted.
    • smtp: the ID of the SMTP config that will be used for this app. Required, Cannot be null
    • discord: the Discord Webhook URL to notify for a message on this app, if null no webhooks will be sent
    • email: the email address that will be used to notify the "administrator" of a new message, if null no notification will be sent to the administrator
• Finally, you can run the server using the yarn start command

Usage

The server expose a HTTP server where you can make a Request (for example a AJAX request) via POST /{id} (where the id param id is the id of the application in the config.json file)

> POST /{id} HTTP/1.1
> Host: yourdomain.fr
> Content-Type: application/json
> Accept-Language: fr

| {
| 	"name": "John Doe",
| 	"email": "[email protected]",
| 	"message": "Kasd eos consetetur invidunt dolores sea ipsum sea dolor kasd. Erat eirmod dolor consetetur voluptua, ipsum et accusam sadipscing sanctus et. Amet aliquyam diam sea eos ea amet nonumy ea lorem. No eos takimata nonumy justo diam tempor dolor rebum.",
| 	"subject": "Diam clita et et kasd.", // optional field
| 	"confirm": false // optional field, if true, will send a copy of this message back to the email given with the 'email' key
| 	"locale": "fr" // optional field, will force the locale, by default the locale is found using the Accept-Language header sent by the client
| }

This is pretty much it, the server will just respond back with a 200 code if everything is good and you will get your emails or webhook as planned. Other wise, you will get a 400 Bad Request error code indicating that the request has a issue.

Contribution

Don't hesitate to give feedback, ask for help or ask question about this project by opening a issue.

Also, fell free to make a Pull Request or to ask for new features.

Todo List & Roadmap

• Add docker image
• Add systemd unit file
• Add unit tests
• Allow for YAML config file instead of JSON config
• Validation of config file at startup
• Reorganize code and allow for multiple notification modules (slack, Standard webhook support)
• Publish an RSS feed
• Allow to store messages in a basic way (in filesystem)

Credits

• https://express-validator.github.io/docs/index.html
• https://discord.com/developers/docs/resources/webhook
• https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure
• https://cdnjs.com/libraries/axios