# SMAM (Send Me A Mail)
Always wanted to implement a contact form in your website and/or portfolio, but don't want to busy yourself with something too complex (mail sending in PHP, for example, is a complete mess)? Here's a miracle solution for ya! Just run the nodemailer-based app, include a JavaScript file in your HTML page, and you're all set :wink:
## Install and run
Just clone this repository, edit the `settings.json` file (described below) and run the server:
```
git clone https://github.com/babolivier/smam
cd smam
npm install
npm start
```
The default port will be set to `1970`, but you can set the one you want by using an environment variable:
```bash
PORT=8080 npm start
```
Same goes with the host. Without further instructions, the server will listen on `0.0.0.0`, which means it will accept every connection, whatever the source. You can override this by using the `HOST` environment variable:
```bash
HOST=127.0.0.1 npm start
```
So, if we want our server to only listen to requests from its host, on the 8080 port, we'll start the server like this:
```bash
HOST=127.0.0.1 PORT=8080 npm start
```
Obviously, you'll need Node.js and NPM (or any Node.js package manager) to run the app. As we're launching a webserver (which will serve the necessary files and process the mail sending requests), this app will run continuously. One good practice would be to run it as a daemon (in a systemd service, for example).
## Usage
First, include the script in your HTML page's header:
```html
...
...
```
Then, add an empty `
```
## Configuration
First, you must rename the `settings.example.conf` into `settings.conf`, and edit it. You'll find yourself in front of a file with this structure:
```json
{
"mailserver": {
"pool": true,
"host": "mail.example.tld",
"port": 465,
"secure": true,
"auth": {
"user": "noreply@noreply.tld",
"pass": "hackme"
}
},
"recipients": [
"you@example.tld",
"someone.else@example.com"
],
"formOrigin": "https://example.tld",
"language": "en",
"labels": true,
"customFields": {
"deadline": {
"label": "Development deadline",
"type": "select",
"options": [
"A week",
"A month",
"More than a month"
],
"required": true
},
"domain": {
"label": "Website domain",
"type": "text",
"required": false
},
"budget_max": {
"label": "Maximum budget (€)",
"type": "number",
"required": true
}
}
}
```
The `mailserver` section is the set of parameters which will be passed to nodemailer's transporter initialisation, describing the output mail server and following the same structure as the `option` object in [nodemailer's SMTP configuration section](https://github.com/nodemailer/nodemailer#set-up-smtp). Please head there to have the full list of parameters.
The `recipients` section is an array containing the e-mail addresses any message sent via the form will be sent to. Just write down the form's recipient(s)'s addresse(s).
The `formOrigin` part is a string containing the origin of the page you'll include the contact form into. This allows SMAM to work with the [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) security most browser use. For more info on how to fill this field, and what is an origin, please give a look at [the MDN's definition](https://developer.mozilla.org/en-US/docs/Glossary/origin).
The `language` string tells SMAM in which language you want your form served. Possible values are all the files in `locales/`'s names (without the `.json`). To create your own translation, please read the section below.
Finally, the `labels` setting is a boolean to set whether or not labels will be displayed in the `