This server will be upgraded at 3pm Sydney time on December 3rd (December 2nd, 8pm PST) and will be down for up to 30 minutes.

Form Mail Plugin

Name Form Mail
Vendor Adaptavist.com Ltd (Website)
Authors Dan Hardiker, Guy Fraser, Jens Schumacher
Homepage http://confluence.atlassian.com/display/CONFEXT/Form+Mail+Plugin
Issue Management http://jira.adaptavist.com/browse/FMP
Continuous Integration n/a
Categories Communication Macros
Most Recent Version 1.0
Availability Confluence v2.3-dr1 to v2.10
State Stable
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Donate
Release Docs http://confluence.atlassian.com/display/CONFEXT/Form+Mail+Plugin
Java API Docs n/a
Download Source n/a
Download JAR form-mail-1.0.jar
This plugin now accessable through the Confluence Repository Client.
If upgrading from 0.1
This macro now has a body, you will now need to close all your {form-mail} usages.

Description

A macro for presenting the user with an AJAX form-mail UI which they can email you with messages.
This action stores the to address in memory and passes around a key for mass mailier abuse protection.

Installation

Upload this macro using the Plugin Manager. If you are upgrading this plugin, you may also need to restart Confluence to see the changes (this is due to a known issue with Confluence).

Usage

Parameter Required Description
to yes email address or ~username to send to
subject no subject of the email
fields no custom message fields
macro body no custom success message
onsubmit no JavaScript to insert into the submission process

Examples

To defined as an email address

{form-mail:to=you@email.address.com}{form-mail}

To defined as a user

{form-mail:to=~admin}{form-mail}

Predefined message subject with custom message fields

{form-mail:to=~admin|subject=Example Subject|fields=How do you like the new fields feature?,What other features would you like to see implemented?}{form-mail}

Submit Handler

This will ask you if you wish you abort sending the mail, and will only continue if you click cancel. There are obviously more practical applications for this, such as form validation.

{form-mail:to=~admin|subject=Example Subject|onsubmit=if (confirm("Would you like to abort?")) return;}{form-mail}

Custom success message

{form-mail:to=~admin}
*Thank you!*

Your message has been successfully received. While we welcome all comments, we regret that we cannot always answer them individually.

_Site Administrative Team_
{form-mail}

Serving Suggestion

Mix with our Content Formatting Macros and the {section} + {column} macros to create an attractive layout (click image to enlarge):

Release History

Plugin Versions

Version Date State License Price
Show description 0.1 (#1) 23 Feb 2006 Alpha Freeware / Open Source (BSD) Donate

Release Notes
The inital release.

Contributors

Show description 0.2 (#2) 24 Feb 2006 Beta Freeware / Open Source (BSD) Donate

Release Notes
WARNING: macro now has a body!

The following issues were addressed:

  • FMP-1 ~username to be specifiable as the to address
  • FMP-4 Customisable success message
  • FMP-5 Better from field management

Contributors

Show description 0.3 (#3) 05 Mar 2006 Stable Freeware / Open Source (BSD) Donate

Release Notes
The following issues were addressed:

  • FMP-7 Unknown status: null

Contributors

Show description 0.4 (#4) 17 Nov 2006 Stable Freeware / Open Source (BSD) Donate

Release Notes
The following issues were addressed:

  • Simplified JavaScript code utilising the prototype library
  • Added optional subject parameter
  • Added optional fields parameter

Contributors

Show description 1.0 (#10) 04 May 2007 Stable Freeware / Open Source (BSD) Donate

Release Notes
The following issues were addressed:

  • Now builds with Maven 2 (restructured folder layout accordingly)
  • Converted to Confluence v2.3+
  • Now uses CSS for styling
  • Added optional onsubmit parameter (takes raw JS)

Contributors

Issue Tracking

Full Size

Labels

confluence21 confluence21 Delete
macro macro Delete
adaptavist adaptavist Delete
plugin plugin Delete
email email Delete
messaging messaging Delete
repository_current repository_current Delete
codegeist codegeist Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Nov 22, 2006

    Derek Nicol says:

    Is there a way to add custom fields to the form?

    Is there a way to add custom fields to the form?

    1. Nov 22, 2006

      Guy Fraser says:

      I think Jens has recently added this feature but the updated plugin isn't yet re...

      I think Jens has recently added this feature but the updated plugin isn't yet released....

      1. Nov 22, 2006

        Guy Fraser says:

        Update - version 0.4 has this feature but not sure where it's documented. Upgrad...

        Update - version 0.4 has this feature but not sure where it's documented. Upgrade to the latest version and check the notation guide as I assume there is more info in there.

        1. Nov 22, 2006

          Derek Nicol says:

          I'm new to confluence where is the notation guide for a plugin?

          I'm new to confluence where is the notation guide for a plugin?

          1. Nov 22, 2006

            Guy Fraser says:

            Edit a page, use the "wiki markup" editor and you should see a link on the right...

            Edit a page, use the "wiki markup" editor and you should see a link on the right hand side panel.

            1. Nov 22, 2006

              Derek Nicol says:

              Thanks, it doesnt look like there is any information there.

              Thanks, it doesnt look like there is any information there.

              1. Nov 22, 2006

                Guy Fraser says:

                I've sent an email to Jens and will update this page once I receive the info.

                I've sent an email to Jens and will update this page once I receive the info.

                1. Nov 22, 2006

                  Guy Fraser says:

                  Ah, there is an example above titled "Predefined message subject with custom mes...

                  Ah, there is an example above titled "Predefined message subject with custom message fields"

        2. Dec 04, 2006

          Menso Heus says:

          Where's the notation guide? I would like to add options and dropdown single sele...

          Where's the notation guide? I would like to add options and dropdown single select form elements, but how do I this if it's at all possible? Love the plugin, but with only the custom fields resulting in textareas, it's a bit limited. Would *love* if you could add this or explain how to use it.

          Thanks!

  2. Jan 16, 2007

    Guy Hoogewerf says:

    Very keen to start using this, but need to know a lot more about it, where can I...

    Very keen to start using this, but need to know a lot more about it, where can I get more information on this.

    1. Jan 16, 2007

      Dan Hardiker says:

      This is all the information available, what additional information are you after...

      This is all the information available, what additional information are you after?

  3. Mar 30, 2007

    W.B. McNamara says:

    Hi there -- very nice plugin! There are a couple of cases where we'...

    Hi there -- very nice plugin!

    There are a couple of cases where we'd like to enable anonymous feedback via our intranet:  is it possible to override/suppress the name and email address fields, using the Confluence mail server defaults instead?

    Many thanks,

    Whit

    1. May 02, 2007

      Elliot Braham says:

      Hi Whit, I needed something similar so I just edited the form.vm in the JAR to ...

      Hi Whit,

      I needed something similar so I just edited the form.vm in the JAR to default the name to "anonymous" and the email to "anonymous@anonymous.com". You could also obviously set the input type to hidden.

      I've uploaded my anonymous version of this plugin here.

      Regards, Elliot

  4. May 04, 2007

    Guy Fraser says:

    Not sure who added the javascript parameter, but is that not a security risk? Al...

    Not sure who added the javascript parameter, but is that not a security risk? Allowing people to easily inject JS in to pages can't be a good idea?

    1. May 05, 2007

      Dan Hardiker says:

      The JS is only executed on submit, and there are larger security holes in the pl...

      The JS is only executed on submit, and there are larger security holes in the plugin which are yet untapped. If you are worried about JS injection, then don't use this macro!

      Form-mail NG is around the corner anyway.

  5. Feb 18, 2008

    Hannah Denholm says:

    Hello, I have sucessfully added a form to my confluence site - its very simple ...

    Hello,

    I have sucessfully added a form to my confluence site - its very simple data collection such as feedback etc.  Is there any way this information can be output to Excel?

    Cheers!

  6. Aug 27

    John Crossman says:

    Is there a way to generate form fields that are not textarea?  For example,...

    Is there a way to generate form fields that are not textarea?  For example, an input field that only allows for 2 chars?

  7. Oct 13

    Matus says:

    I installed 1.0 version of plugin on Confluence 2.2.10. It looks good by I don't...

    I installed 1.0 version of plugin on Confluence 2.2.10. It looks good by I don't receive any messages I don't see anything in logs.