Send Email Plugin

Usage details

Sending emails through a form may contain these elements:

1. An HTML form
2. Allow/restrict settings in configure
3. Optionally a feedback message macro SENDEMAIL
4. Optionally a custom email template

HTML form elements

The HTML form encapsulates the data to be sent, each part passed as a form field, either an input field or hidden field.

<form enctype="application/x-www-form-urlencoded" name="mailform" action="%SCRIPTURL{sendemail}%/%WEB%/%TOPIC%" method="POST">
... fields ...
<input type="submit" class="foswikiSubmit" value="Send" />
</form>

Note, that the from, to and cc parameters can be either an email address or a wiki user name, in which case the email address of that wiki user is used instead.

Allow/restrict settings

• {Plugins}{SendEmailPlugin}{Permissions}{Allow}{MailTo} - enter .* to allow to send to anyone
• {Plugins}{SendEmailPlugin}{Permissions}{Deny}{MailTo}

Other preferences can be set depending on your needs:

• {Plugins}{SendEmailPlugin}{Permissions}{Allow}{MailFrom}
• {Plugins}{SendEmailPlugin}{Permissions}{Deny}{MailFrom}
• {Plugins}{SendEmailPlugin}{Permissions}{Allow}{MailCc}
• {Plugins}{SendEmailPlugin}{Permissions}{Deny}{MailCc}

Each Deny is evaluated after each Allow, so Deny settings overrule Allow settings.

Examples of allow/restrict settings

• Allow to send to:
  • Set {SendEmailPlugin}{Permissions}{Allow}{MailTo} to:
    • john@tar.com to only allow to send mails to John
    • john@tar.com|mary@look.ca to allow to send mails to John and Mary
    • .*@tar.com to send mails to any address at @tar.com
    • .*@tar.com,mary@.* to send mails to any address at @tar.com and to all Marys in the world
• Deny to send to:
  • Set {SendEmailPlugin}{Permissions}{Deny}{MailTo} to:
    • .*@tar.com to deny to any address at @tar.com
    • .* to deny any address (no emails will be sent)

The same rules apply for {MailFrom} and {MailCc}.

Feedback notifications

Simply:

%SENDEMAIL%

The message can be tailored using SENDEMAIL parameters:

Feedback notification example

%SENDEMAIL{
feedbackSuccess="Request sent, we'll contact you shortly."
feedbackError="Could not send your message, please contact us."
format="<div class=\"foswikiNotification\">$message</div>"
}%

Email template

From: %FROM%
To: %TO%
CC: %CC%
Subject: %SUBJECT%

%BODY%

For a template topic named MailTemplate you can either pass the name Mail or MailTemplate.

The search path for templates always starts in the current web.

Examples

Example with a handcrafted HTML form

Show code Hide code

<form enctype="application/x-www-form-urlencoded" name="mailform" action="%SCRIPTURL{sendemail}%/%WEB%/%TOPIC%" method="POST">
<input type="hidden" name="successsection" value="thanks" />
<fieldset>
<legend><b>Send Email</b></legend>
<div class="foswikiFormSteps">
<div class="foswikiFormStep">
<h3>To:</h3>
<input class="foswikiInputField" id="to" name="to" size="30" type="text" value="%URLPARAM{"to"}%" />
</div>
<div class="foswikiFormStep">
<h3>CC:</h3>
<input type="text" class="foswikiInputField" id="cc" name="cc" size="30"  value="%URLPARAM{"cc"}%" />
</div>
<div class="foswikiFormStep">
<h3>Subject:</h3>
<input type="text" class="foswikiInputField" id="subject" name="subject" size="70" value="%URLPARAM{"subject"}%" />
</div>
<div class="foswikiFormStep">
<h3>Message:</h3>
<textarea class="foswikiInputField" cols="70" name="body" rows="6" style="width:100%">%URLPARAM{"body"}%</textarea>
</div>
<div class="foswikiFormStep">
<input type="submit" class="foswikiSubmit" value="Send" />
</div>
</div>
</fieldset>
</form>
%SENDEMAIL%
<!--
%STARTSECTION{"thanks"}%
---+!! Notification
%SENDEMAIL%
<input type="button" value="Ok" class="foswikiButton" onclick="window.location.href='%URLPARAM{"origurl" default="%SCRIPTURLPATH{view}%/%BASEWEB%/%BASETOPIC%"}%'" />
%ENDSECTION{"thanks"}%

-->