User Guide

cfmail 297
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
cfmailparam and 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.
server Optional 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 MX Administrator. A value here
overrides the Administrator. A value that includes a port
specification overrides the
port attribute. See the Usage
section for details.
port Optional TCP/IP port on which SMTP server listens for requests
(normally 25). A value here overrides the Administrator.
mailerID Optional ColdFusion
MX
Application
Server
Mailer ID to be passed in X-Mailer SMTP header, which
identifies the mailer application.
timeout Optional Number of seconds to wait before timing out connection to
SMTP server. A value here overrides the Administrator.
spoolEnable Optional Specifies whether to spool mail or always send it
Immediately. Overrides the ColdFusion MX 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 those 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.
debug Optional No • 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 MX
writes detailed debugging information to the log,
including all message contents, and can generate large
logs quickly.
• No: does not generate debugging output.
Attribute Req/Opt Default Description