automad/mail

This extension provides a basic wrapper for PHP's built-in mail function including basic human verification

Installs: 24

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:automad-package

1.0.0 2020-01-05 16:52 UTC

This package is auto-updated.

Last update: 2020-08-05 18:35:33 UTC


README

The Mail extension provides a basic wrapper for the PHP function mail(), including optional human verification using a honeypot.

Markup

The basic markup requires the method call as well as a contact form.
Note that the names of the form fields must match the following example:

<@ Automad/Mail { to: @{ email } } @>

<form action="@{ url }" method="post">

    <!-- The honeypot - this input will be hidden by the included CSS -->
    <input type="text" name="human" value="">
	
    <!-- The actual form fields and button -->
    <input type="text" name="from" value="" placeholder="Your Email">
    <input type="text" name="subject" value="" placeholder="Your Subject">
    <textarea name="message" placeholder="Your Message"></textarea>
    <button class="uk-button" type="submit">Send</button>

</form>

Options

The following options can be specified:

Parameter Description
to The receiving email address
error The message to be displayed on errors
success The message to be displayed on success

A markup with all options specified:

<@ Automad/Mail { 
    to: @{ email },
    error: 'Error Message ...',
    success: 'Success Message ...'
} @>