User Guide Cancel

mail

Last updated on May 30, 2024 | Also applies to ColdFusion

ColdFusion

Open app

CFML Reference User Guide
ColdFusion functions
ColdFusion Tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

Note:

In ColdFusion (2018 release), script functions implemented as CFCs are deprecated in ColdFusion.

Description

Used to sends an e-mail message, that optionally contains query output, using an SMTP server.

Syntax

Mode	Syntax
Creating the service	new mail() or createObject("component", "mail")
Initializing the attributes	Any one of the following: mailService=new mail(_attribute-value_pair_) mailService.setAttributes(_attribute-value_pair_) mailService.set_AttributeName_(attribute_value) mailService.send(attribute-value_pair)
Executing the service action	mailService.send(_attribute-value_pair_)

Mode

Syntax

Creating the service

new mail() or createObject("component", "mail")

Initializing the attributes

Any one of the following:

mailService=new mail(_attribute-value_pair_)
mailService.setAttributes(_attribute-value_pair_)
mailService.set_AttributeName_(attribute_value)
mailService.send(attribute-value_pair)

Executing the service action

mailService.send(_attribute-value_pair_)

Properties

from	to	subject	bcc
cc	charset	debug	failto
group	groupcasesensitive	mailerid	maxrows
mimeattach	password	port	priority
query	replyto	server	spoolenable
startrow	timeout	type	username
useSSL	useTLS	wraptext	remove
body

All attributes supported by the tag cfmail can be used as attribute-value pairs. For example,

can be used as

mailerService.setFrom(form.mailFrom);

History

ColdFusion 9: Added this function.

Methods

addParam

Description	Used to add cfmailparam tags. For example, to attach a file or add a header to an e-mail message.
Syntax	mailService.addParam(attribute-value pair)
Returns	Nothing
Arguments	All attributes supported by the cfmailparam tag can be used as attribute-value pairs.

addPart

Description	Used to add cfmailpart tags. For example, one part of a multipart e-mail message.
Syntax	mailService.addPart(attribute-value pair)
Returns	Nothing
Arguments	All attributes supported by the cfmailpart tag can be used as attribute-value pairs.

send

Description	Used to invoke the mail service to send an e-mail message.
Returns	Nothing
Syntax	mailService.send(attribute-value pair)
Arguments	All attributes supported by the cfmail tag.

setAttributes

Description	Sets attributes for the mail function.
Returns	Nothing
Syntax	mailService.setAttributes (attribute-value pair)
Arguments	All attributes supported by the cfmail tag.

getAttributes

Description	Gets attributes that were set for the mail function.
Returns	Returns a struct with all or some of the attribute values.
Syntax	mailService.get_Attributes_ (attributelist)
Arguments	A comma-separated list of attributes. If no list is specified, all defined attributes are returned.

clearAttributes

Description	Removes all attributes added for the mail function.
Returns	Nothing
Syntax	mailService.clearAttributes(attribute_list)
Arguments	A comma-separated list of attributes.

clearParams

Description	Removes cfmailparam tags that were added using the addParam method.
Returns	Nothing
Syntax	mailService.clearParams()
Arguments	None

clearParts

Description	Removes cfmailpart tags that were added using the addPart method.
Returns	Nothing
Syntax	mailService.clearProcResults()
Arguments	None

clear

Description	Removes all attributes, cfmailparam tags, and cfmailpart tags that were added using the methods addParam and addPart.
Returns	Nothing
Syntax	mailService.clear()
Arguments	None

Usage

This function corresponds to the tag cfmail. For usage details, see the Usage section for cfmail.

Example

<h3>Sending mail in cfscript</h3>
<cfscript>
/* create mailer service */
mailerService = new mail();
if(IsDefined("form.mailto"))
{
if(form.mailto is not "" AND form.mailfrom is not "" AND form.Subject is not ""
and form.attachment is not "")
{
savecontent variable="mailBody"{
WriteOutput("This message was sent by an automatic mailer built with cfmail:
= = = = = = = = = = = = = = = = = = = = = = = = = = =" & "<br><br>" & form.body);
}
/* set mail attributes using implicit setters provided */
mailerService.setTo(form.mailto);
mailerService.setFrom(form.mailFrom);
mailerService.setSubject(form.subject);
mailerService.setType("html");
/* add mailparams */
mailerService.addParam(file=expandpath(form.attachment),type="text/plain",remove
=false);
/* send mail using send(). Attribute values specified in an end action like "send" will not persist after the action is performed */
mailerService.send(body=mailBody);
writeoutput("<h3>Thank you</h3>" & "<p>Thank you, " & mailfrom & "<br>" & "Your message, " & subject & ", has been sent to " & mailto & "</p>");
}
}
</cfscript>
<p>
<form action = "mail1.cfm" method="POST">
<table>
<tr>
<td>TO</td>
<td><input type = "Text" name = "MailTo"></td>
</tr>
<tr>
<td>FROM</td>
<td><input type = "Text" name = "MailFrom"></td>
</tr>
<tr>
<td>SUBJECT</td>
<td><input type = "Text" name = "Subject"></td>
</tr>
<tr>
<td>ATTACHMENT</td>
<td><input type = "file" name = "attachment"></td>
</tr>
</table>
<hr>
MESSAGE BODY:
<br>
<textarea name ="body" cols="40" rows="5" wrap="virtual"></textarea>

<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 = "hidden" name = "attachment_required" value = "You must select a file">
<p><input type = "Submit" name = ""></p>
</p>
</form>

Get help faster and easier

New user?

mail

Description

Syntax

Properties

See also

History

Methods

Usage

Example

Get help faster and easier

Ask the Community

Contact Us