ericlbarnes / Statamic-email-form

Email form plugin for Statamic
http://ericlbarnes.com/blog/statamic-email-form-plugin
Other
36 stars 6 forks source link

Statamic Email Form Plugin

This plugin is designed to allow you to quickly and easily create forms that will be used to email reciepents. This is a very simple plugin and if you need more power checkout the official Raven plugin.

Example Form Template

Here is a full example to get you going. Please see the parameters section for more field options:

{{ email_form subject="Contact Form" to="handsome@example.com" required="name" }}
    {{ if error}}
        <h1>Error</h1>
        <ul>
        {{ errors }}
            <li>{{error}}</li>
        {{ /errors }}
        </ul>
    {{ endif }}

    {{ if success }}
        <p>Your message has been sent!</p>
    {{ else }}
        <div>
            <label for="name">Name:</label>
            <input type="text" name="name" id="name" value="Bill">
        </div>
        <div>
            <label for="from">Email:</label>
            <input type="text" name="from" id="from" value="test@test.com">
        </div>
        <div><input type="submit"></div>
    {{ endif }}
{{ /email_form }}

Parameters

The {{ email_form }} tag accepts the following paramaters:

Issues / Gotchas - On the radar

  1. With html_caching enabled the success and error messages will not display. See this issue report
  2. The name field is hard coded as the reply name in the plugin so it is recommended you use this field in your form.
  3. The plugin does have some hard coded English text and that will be fixed up in a future release. Still deciding on the best option for this.
  4. Validation is currently lacking some useful features. Basically only simple checking if the field is empty.

Contributions

If you see any issues or have ideas for improvements pull requests are gladly accepted. ;-)