cfmail
Description
Sends an e-mail message that optionally contains query output, using an SMTP server.
Categories
Related
History
ColdFusion
8: Added priority, useSSL, and useTLS attributes.
ColdFusion
MX 7:
The cfmail tag no longer lets
you send multipart mail by embedding the entire MIME-encoded message
in the tag body. Use the cfmailpart tag, instead.
The cfmail tag renders non-proportional
fonts proportionately. This is a behavior change from ColdFusion
5. ColdFusion MX 7 uses UTF-8 and sends this in the mail header
(Content-Type: text/plain; charset=UTF-8). ColdFusion 5 uses ISO-8859-1
(Latin 1). To avoid this behavior, add the charset="ISO-8859-1" attribute
to restore the default ColdFusion 5 encoding. Alternatively, you
can change the encoding on the Mail page in the ColdFusion Administrator.
ColdFusion
MX 6.1:
Added the following attributes: charset, failto,replyto, username, password and wraptext.
Added support for multiple mail servers in the server attribute.
Added several configuration options to the ColdFusion Administrator
Mail Settings page.
ColdFusion MX: Added the SpoolEnable attribute.
ColdFusion
9: Added support for digitally signing the mail. The following are
the relevant attributes that are newly added: sign, keystore, keystorepassword, keyalias, keypassword and remove.
Syntax
<cfmail
from = "e-mail address"
to = "comma-delimited list"
bcc = "comma-delimited list"
cc = "comma-delimited list"
charset = "character encoding"
debug = "yes|no"
failto = "e-mail address"
group = "query column"
groupcasesensitive = "yes|no"
mailerid = "header id"
maxrows = "integer"
mimeattach = "path"
password = "string"
port = "integer"
priority = "integer or string priority level"
query = "query name"
remove = "yes|no"
replyto = "e-mail address"
server = "SMTP server address"
spoolenable = "yes|no"
startrow = "query row number"
subject = "string"
timeout = "number of seconds"
type = "mime type"
username = "SMTP user ID"
useSSL = "yes|no"
useTLS = "yes|no"
wraptext = "column number"
sign = "true|false"
keystore = "location of keystore"
keystorepassword = "password of keystore"
keyalias = "alias of key"
keypassword = "password for private key">
(Optional) Mail message body and/or cfmailparam tags
</cfmail>
Note: You can specify
this tag’s attributes in an attributeCollection attribute
whose value is a structure. Specify the structure name in the attributeCollection attribute
and use the tag’s attribute names as structure keys.
Attributes
| Attribute | Description | Required | Default |
|---|---|---|---|
| bcc | Addresses to which to copy the message, without listing them in the message header. To specify multiple addresses, separate the addresses with commas. | Optional | |
| cc | Addresses to which to copy the message. To specify multiple addresses, separate the address with commas. | Optional | |
| charset | Character encoding of the mail message, including the headers. The following list includes commonly used values: utf-8 iso-8859-1 windows-1252 us-ascii shift_jis iso-2022-jp euc-jp euc-kr big5 hz-gb-2312 euc-cn utf-16 For more information on character encodings, see www.w3.org/International/O-charset.html. | Optional | Character encoding selected in ColdFusion Administrator Mail page; utf-8 |
| debug | yes: sends debugging output to standard output. By default, if the console window is unavailable, ColdFusion sends output to cf_root\runtime\logs\coldfusion-out.log on server configurations. On J2EE configurations, with JRun, the default location is jrun_home/logs/servername-out.log. Caution: If you set this option to yes, ColdFusion writes detailed debugging information to the log, including all message contents, and can generate large logs quickly. no: does not generate debugging output. | Optional | no |
| failto | Address to which mailing systems must send delivery failure notifications. Sets the mail envelope reverse-path value. | Optional | |
| from | E-mail message sender: A static string; for example, "support@mex.com" A variable; for example, "#GetUser.EMailAddress#". This attribute does not have to be a valid Internet address; it can be any text string. | Required | |
| group | Query column to use when you group sets of records to send as a message. For example, to send a set of billing statements to a customer, group on "Customer_ID." Case-sensitive. Eliminates adjacent duplicates when data is sorted by the specified field. | Optional | CurrentRow |
| groupcasesensitive | Boolean. Whether to consider case when using the group attribute. To group on case-sensitive records, set this attribute to Yes. | Optional | No |
| keyalias | Alias of the key with which the certificate and private key are stored in the keystore. If it is not specified, the first entry in the keystore is chosen as the alias. | Optional | |
| keypassword | Password for your private key. If not specified, the keystorepassword is used. | Optional | |
| keystore | The location of the keystore file, for example, C:\OpenSSL\bin\keystore.jks. | Optional | |
| keystorepassword | The password of the keystore. This is stored in ColdFusion configuration files. | Optional | |
| mailerid | Mailer ID to be passed in X-Mailer SMTP header, which identifies the mailer application. | Optional | ColdFusion Application Server |
| maxrows | Maximum number of messages to send when looping over a query. | Optional | |
| mimeattach | Path of the on-disk or in-memory file to attach to message. Attached file is MIME-encoded. ColdFusion attempts to determine the MIME type of the file; use the cfmailparam tag to send an attachment and specify the MIME type. | Optional | |
| password | A password to send to SMTP servers that require authentication. Requires a username attribute. | Optional | |
| port | TCP/IP port on which SMTP server listens for requests (normally 25). A value here overrides the Administrator. | Optional | |
| priority | The message priority level. Can be one of the following values: An integer in the range 1-5; 1 represents the highest priority. One of the following string values, which correspond to the numeric values: highest or urgent, high, normal, low, and lowest or non-urgent. | Optional | 3 |
| query | Name of cfquery from which to draw data for messages. Use this attribute to send more than one message, or to send query results within a message. | Optional | |
| remove | If yes, ColdFusion removes attachment files (if any) after the mail is successfully delivered. | Optional | false |
| replyto | Addresses to which the recipient is directed to send replies. | Optional | |
| server | SMTP server address, or (Enterprise edition only) a comma-delimited list of server addresses, to use for sending messages. At least one server must be specified here or in the ColdFusion Administrator. A value here overrides the Administrator. A value that includes a port specification overrides the port attribute. For details, see Usage. | Optional | |
| sign | Digitally signs the mail. If set to true, all messages that you send will have digital signature. | ||
| spoolenable | Whether to spool mail or always send it Immediately. Overrides the ColdFusion Administrator Spool mail messages to disk for delivery setting. yes: saves a copy of the message until the sending operation is complete. Pages that use this option might run slower than the ones that use the No option. no: queues the message for sending, without storing a copy until the operation is complete. If a delivery error occurs when this option is No, ColdFusion generates an Application exception and logs the error to the mail.log file. | Optional | |
| startrow | Row in a query to start from. | Optional | 1 |
| subject | Message subject. Can be dynamically generated. For example, to send messages that give customers status updates: "StatusofOrderNumber#Order_ID#". | Required | |
| timeout | Number of seconds to wait before timing out connection to SMTP server. A value here overrides the Administrator. | Optional | |
| to | Message recipient e-mail addresses: Static address, for example, "support@.com". Variable that contains an address, for example, "#Form.Email#". Name of a query column that contains an address, for example, "#EMail#". An e-mail message is sent for each returned row. To specify multiple addresses, separate the addresses with commas. | Required | |
| type | MIME type of the message. Can be a valid MIME media type or one of the following: text: specifies text/plain type. plain: specifies text/plain type. html: specifies text/html type. For a list of all registered MIME media types, see www.iana.org/assignments/media-types/. | Optional | text/plain |
| username | A user name to send to SMTP servers that require authentication. Requires a password attribute. | Optional | |
| useSSL | Whether to use Secure Sockets Layer. | Optional | |
| useTLS | Whether to use Transport Level Security. | Optional | |
| wraptext | The maximum line length, in characters of the mail text. If a line has more than the specified number of characters, replaces the last white space character, such as a tab or space, preceding the specified position with a line break. If there are no white space characters, inserts a line break at the specified position. A common value for this attribute is 72. | Optional | Do not wrap text |
Usage
Sends a mail message to the specified address. Mail messages can include attachments. The tag body can include CFML code to generate mail output. The cfmailparamand cfmailpart tags can only be used in the cfmail tag body.
Mail messages can be single or multipart. If you send a multi-part mail message, all message content must be in cfmailpart tags; ColdFusion ignores multipart message text that is not in cfmailpart tags.
Note: The cfmail tag does not make copies of attachments when spooling mail to disk. If you use the cfmail tag to send a message with an attachment with spooling enabled and you use the cffile tag to delete the attachment file, ColdFusion might not send the mail because the mailing process might execute after the file was deleted. (When this happens, the mail log includes a FileNotFound exception and the e-mail is not sent.) You can prevent this problem by setting SpoolEnable="No" in the attribute or disabling spooling in the ColdFusion Administrator. Disabling spooling causes the e-mail to be delivered immediately.
If you set type="text", sometimes whitespace might be compressed in the messages that you send. To resolve this, in the ColdFusion Administrator, go to Server Settings > Settings and then deselect the option Enable Whitespace Management.
Mail messages can be single or multipart. If you send a multi-part mail message, all message content must be in cfmailpart tags; ColdFusion ignores multipart message text that is not in cfmailpart tags.
Note: The cfmail tag does not make copies of attachments when spooling mail to disk. If you use the cfmail tag to send a message with an attachment with spooling enabled and you use the cffile tag to delete the attachment file, ColdFusion might not send the mail because the mailing process might execute after the file was deleted. (When this happens, the mail log includes a FileNotFound exception and the e-mail is not sent.) You can prevent this problem by setting SpoolEnable="No" in the attribute or disabling spooling in the ColdFusion Administrator. Disabling spooling causes the e-mail to be delivered immediately.
If you set type="text", sometimes whitespace might be compressed in the messages that you send. To resolve this, in the ColdFusion Administrator, go to Server Settings > Settings and then deselect the option Enable Whitespace Management.
Example
<h3>cfmail Example</h3>
<!--- Delete the surrounding comments to use this example.
<cfif IsDefined("form.mailto")>
<cfif form.mailto is not "" AND form.mailfrom is not "" AND form.Subject is not "">
<cfmail to = "#form.mailto#" from = "#form.mailFrom#" subject = "#form.subject#">
This message was sent by an automatic mailer built with cfmail:
= = = = = = = = = = = = = = = = = = = = = = = = = = =
#form.body#
</cfmail>
<h3>Thank you</h3>
Thank you, <cfoutput>#mailfrom#: your message, #subject#, has been sent to
#mailto#</cfoutput>.</p>
</cfif>
</cfif>
<form action = "cfmail.cfm" method="POST">
<pre>
TO: <input type = "Text" name = "MailTo">
FROM: <input type = "Text" name = "MailFrom">
SUBJECT: <input type = "Text" name = "Subject">
<hr>
MESSAGE BODY:
<textarea name ="body" cols="40" rows="5" wrap="virtual"></textarea>
</pre>
<!--- Establish required fields. --->
<input type = "hidden" name = "MailTo_required" value = "You must enter a recipient">
<input type = "hidden" name = "MailFrom_required" value = "You must enter a sender">
<input type = "hidden" name = "Subject_required" value = "You must enter a subject">
<input type = "hidden" name = "Body_required" value = "You must enter some text">
<input type = "Submit" name = ""></p>
</p>
</form>