Component MailForm
Description
Mail forms compose and send e-mail from the form data.
An email form must contains some field components (to enter
some data) and a send button (
Mailforms usually contain a
Format
< MailForm ... > ... < /MailForm >
Details
Component must not be used inside a form.| Include File: | mform.hei |
| Session Mode: | accept |
Properties
| Property | Kind | Description |
| Oid | Id must be unique within the page. | |
| To | Recipient's e-mail address. | |
| Cc | List of carbon copy recipients, separated by commas. | |
| Bcc | List of blind carbon copy recipients, separated by commas. | |
| Subject | Subject line. | |
| From | Sender's e-mail address. | |
| Usercopy | Send a copy to the user. A | |
| Method | HTTP method to submit the form data set. Value "post" should be used when form processing causes side effects, e.g. modifies a database, and if the form contains fieldfileupload. |
Attributes
| Name | Description |
| to | Destination address |
| cc | Additional destination addresses |
| bcc | Blind additional destination addresses |
| from | Source address |
| subject | Subject |
| mailtext | Compiled email text |
Superclass
The component inherits Attributes, Methods, and Hookmethods from the following superclasses:
Hooks
checkinput (f, form) Is called to check to form content for consistency. f contains the form fields and form the form itself. If everything is ok return null otherwise an error message.
onsend () Is called immediately before the email is sent. The variables this.to, this.cc, this.bcc, this.subject, this.from, and this.mailtext can be read and written. On success null must be returned. Otherwise the email is not sent.
wraptext (f) This wraps the text generation. The parameter contains the form fields. At the end this.mailtext must contain the generated email text. The defbody inspects the mailtext tag and generates the email text in this.mailtext. The default wraptext just contains defbody.
It is possible to insert code that manipulates the form fields before the defbody. After the defbody this.mailtext can be manipulated. Alternatively the text can be generated completely within wraptext without using defbody.
© 1996-2024 H.E.I. All Rights Reserved.
