This plugin allows you to add an email contact form to your website.
This plugin requires Craft CMS 3.0.0-beta.20 or later.
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project -
Then tell Composer to load the plugin:
composer require craftcms/contact-form -
In the Control Panel, go to Settings → Plugins and click the “Install” button for Contact Form.
Your contact form template can look something like this:
{% macro errorList(errors) %}
{% if errors %}
<ul class="errors">
{% for error in errors %}
<li>{{ error }}</li>
{% endfor %}
</ul>
{% endif %}
{% endmacro %}
{% from _self import errorList %}
<form method="post" action="" accept-charset="UTF-8">
{{ csrfInput() }}
<input type="hidden" name="action" value="contact-form/send">
<input type="hidden" name="redirect" value="{{ 'contact/thanks'|hash }}">
<h3><label for="from-name">Your Name</label></h3>
<input id="from-name" type="text" name="fromName" value="{{ message.fromName ?? '' }}">
{{ message is defined and message ? errorList(message.getErrors('fromName')) }}
<h3><label for="from-email">Your Email</label></h3>
<input id="from-email" type="email" name="fromEmail" value="{{ message.fromEmail ?? '' }}">
{{ message is defined and message ? errorList(message.getErrors('fromEmail')) }}
<h3><label for="subject">Subject</label></h3>
<input id="subject" type="text" name="subject" value="{{ message.subject ?? '' }}">
{{ message is defined and message ? errorList(message.getErrors('subject')) }}
<h3><label for="message">Message</label></h3>
<textarea rows="10" cols="40" id="message" name="message">{{ message.message ?? '' }}</textarea>
{{ message is defined and message ? errorList(message.getErrors('message')) }}
<input type="submit" value="Send">
</form>The only required fields are fromEmail and message. Everything else is optional.
If you have a redirect hidden input, the user will get redirected to it upon successfully sending the email. The following variables can be used within the URL/path you set:
{fromName}{fromEmail}{subject}
For example, if you wanted to redirect to a contact/thanks page and pass the sender’s name to it, you could set the input like this:
<input type="hidden" name="redirect" value="{{ 'contact/thanks?from={fromName}'|hash }}">
On your contact/thanks.html template, you can access that from parameter using craft.app.request.getQueryParam():
<p>Thanks for sending that in, {{ craft.app.request.getQueryParam('from') }}!</p>Note that if you don’t include a redirect input, the current page will get reloaded.
You can add additional fields to your form by splitting your message field into multiple fields, using an array syntax for the input names:
<h3><label for="message">Message</label></h3>
<textarea rows="10" cols="40" id="message" name="message[body]">{{ message.message ?? '' }}</textarea>
<h3><label for="phone">Your phone number</label></h3>
<input id="phone" type="text" name="message[Phone]" value="">
<h3>What services are you interested in?</h3>
<label><input type="checkbox" name="message[Services][]" value="Design"> Design</label>
<label><input type="checkbox" name="message[Services][]" value="Development"> Development</label>
<label><input type="checkbox" name="message[Services][]" value="Strategy"> Strategy</label>
<label><input type="checkbox" name="message[Services][]" value="Marketing"> Marketing</label>If you have a primary “Message” field, you should name it message[body], like in that example.
An email sent with the above form might result in the following message:
Phone: (555) 123-4567
Services: Design, Development
Hey guys, I really loved this simple contact form (I'm so tired of agencies
asking for everything but my social security number up front), so I trust
you guys know a thing or two about usability.
I run a small coffee shop and we want to start attracting more freelancer-
types to spend their days working from our shop (and sipping fine coffee!).
A clean new website with lots of social media integration would probably
help us out quite a bit there. Can you help us with that?
Hope to hear from you soon.
Cathy Chino
If you create a config file in your config/ folder called contactform.php, you can override
the plugin’s settings in the Control Panel. Since that config file is fully multi-environment aware, this is
a handy way to have different settings across multiple environments.
Here’s what that config file might look like along with a list of all of the possible values you can override.
<?php
return [
'toEmail' => 'bond@007.com',
'prependSubject' => '',
'prependSender' => '',
'allowAttachments' => false,
'successFlashMessage' => 'Message sent!'
];You can programmatically add email recipients from your template by adding a hidden input field named toEmail like so:
<input type="hidden" name="toEmail" value="{{ 'me@example.com'|hash }}">
If you want to add multiple recipients, you can provide a comma separated list of emails like so:
<input type="hidden" name="toEmail" value="{{ 'me@example.com,me2@example.com'|hash }}">
Then from your craft/config/contactform.php config file, you’ll need to add a bit of logic:
<?php
return [
'toEmail' => Craft::$app->request->getValidatedBodyParam('toEmail'),
// ...
];In this example if $toEmail does not exist or fails validation (it was tampered with), the plugin will fallback to the “To Email” defined in the plugin settings, so you must have that defined as well.
If you would like your contact form to accept file attachments, follow these steps:
- Go to Settings → Contact Form in the Control Panel, and make sure the plugin is set to allow attachments.
- Make sure your opening HTML
<form>tag containsenctype="multipart/form-data". - Add a
<input type="file" name="attachment">to your form. - If you want to allow multiple file attachments, use multiple
<input type="file" name="attachment[]" multiple>inputs.
You can optionally post contact form submissions over Ajax if you’d like. Just send a POST request to your site with all of the same data that would normally be sent:
$('#my-form').submit(function(ev) {
// Prevent the form from actually submitting
ev.preventDefault();
// Send it to the server
$.ajax('/', {
dataType: 'json',
data: $(this).serialize(),
success: function(response) {
if (response.success) {
$('#thanks').fadeIn();
} else {
// response.error will be an object containing any validation errors that occurred, indexed by field name
// e.g. response.error.fromName => ['From Name is required']
alert('An error occurred. Please try again.');
}
}
});
});Plugins can be notified when a submission is being validated, providing their own custom validation logic, using the beforeValidate event on the Submission model:
use craft\contactform\models\Submission;
use yii\base\Event;
use yii\base\ModelEvent;
// ...
Event::on(Submission::class, Submission::EVENT_BEFORE_VALIDATE, function(ModelEvent $e) {
/** @var Submission $submission */
$submission = $e->sender;
$validates = // custom validation logic...
if (!$validates) {
$submission->addError('someAttribute', 'Error message');
$e->isValid = false;
}
});Plugins can be notified right before a message is sent out to the recipients using the beforeSend event. This is also an opportunity to flag the message as spam, preventing it from getting sent:
use craft\contactform\events\SendEvent;
use craft\contactform\Mailer;
use yii\base\Event;
// ...
Event::on(Mailer::class, Mailer::EVENT_BEFORE_SEND, function(SendEvent $e) {
$isSpam = // custom spam detection logic...
if (!$isSpam) {
$e->isSpam = true;
}
});Plugins can be notified right after a message is sent out to the recipients using the afterSend event.
use craft\contactform\events\SendEvent;
use craft\contactform\Mailer;
use yii\base\Event;
// ...
Event::on(Mailer::class, Mailer::EVENT_AFTER_SEND, function(SendEvent $e) {
// custom logic...
});