Installation
To install the Grails Contact Form plug-in type in this command in your project's root folder:
grails install-plugin contact-form
Upgrading from an earlier release
There shouldn't be any issues upgrading from an earlier release.
Configuration
Before running your application with the contact-form plug-in, make sure you perform the following configuration steps.
URL Mappings
Once install your new contact form will be available at the following URL:
http://{HOSTNAME}:{PORT}/{APPLICATION-NAME}/contactFormIf you would prefer to change the URL to the contact form, please take advantage of the
grails-app/conf/UrlMappings.groovy file. For example, to change the mapping from "contactForm" to "contactUs" insert the following line into your URL mappings file:
"/contactUs" {
controller = "contactForm"
}Mail configuration
The next step is to provide mail plug-in configuration your SMTP server details. The configuration is available in the
grails-app/conf/Config.groovy file. The existing example configuration is a template for use with a GMAIL account. Please update as required.
Note: This is set up to use SSL, if your SMTP server does not make use of SSL then you should remove the "props" SSL attributes.
Captcha configuration
Finally, you need to update the captcha definition found again in the
grails-app/conf/Config.groovy file. The existing configuration contains comments which highlight the following properties:
- Allowed characters
- Font size
- Font type
- Background size
- Background colour
- Maximum text length
- Minimum text length
- Text colour
Further documentation
The contact form plug-in is dependent on both the Mail and JCaptcha plug-ins. For additional configuration and feature information please refer to the following documentation:
For further information regarding URL mapping please refer to the following documentation:
Fisheye
Docs
Edit Plugin
Close