A backend server application that listens for web form submissions, implemented with the rocket framework (0.5 release candidate).
formulate is currently capable of using the host server's (or container's) built-in sendmail functionality to send email, after successfully receiving form data.
Configuration is currenly very simple. Two email addresses, a sending_email and a destination_email, will need to be provided. These email addresses may be set in the Rocket.toml configuration file (see Rocket.toml.template for an example).
Alternatively, two environment variables: FORM_SUBMISSION_destination_email and FORM_SUBMISSION_sending_email may be used to provide the values. Configuration overriding follows that of the Rocket framework, so if both the config file and environment variables are set, the environment variables take precedence.
The "destination email" will be the email address you wish the form submissions to be sent to.
The "sending email" is the address the emails will come from when delivered to your inbox. It is meant to be a stable address which you can use to filter your form submission emails. This "sending email" will be used in the email's 'From:'.
Any replies will be set to the 'Reply-To' address, which will be the email address set by the form's user.
It accepts the following parameters, most of which are required:
email: The email address of the form sender. This will be set as the 'Reply-To' address in the sent email. Can also be submitted as e-mail.full_name: The name the form sender would like to use in the sent email. This will be used as the email sender name. Can also be submitted as fullname.subject: (optional) The title of the email. A default subject will be used if this is not provided.message: The message body of the sent email.from_site: The URL of the site which the form is submitted from. Can also be submitted as site, website, or location. Alternatively, for url-encoded form submissions, this can be set to the URL of the page the user should be redirected to if the form was submitted successfully. This form field can be hidden and set via JavaScript before submission.It also responds with a message with appropriate HTTP status codes to indicate success or failure.
After passing the email on to sendmail and being informed of success, formulate responds with an appropriate HTTP status code to indicate success or failure. JSON payloads will receive a JSON response, while url-encoded forms will be redirected to the url defined in the from_site parameter.
A Dockerfile is included in the source repository to aid in containerized deployments.
An rc script is also provided to aid in deploying on FreeBSD platforms.