Using A Name Suffix In ColdFusion's CFMail Tag
Posted May 8, 2007 at 9:08 AM by Ben Nadel
Usually, when sending an email using ColdFusion's CFMail tag, I use very simple email addresses like this:
- <cfmail
- to="ben@xxxxxxxxx.com"
- from="libby@xxxxxxxxx.com"
- subject="Thanks for last night!">
-
- Thanks for last night. I had a great time.
- Let's do that again soon.
-
- </cfmail>
But, sometimes, when I want to up the level of professionalism, I will add the sender and recipient names to the email addresses:
- <cfmail
- to="Ben <ben@xxxxxxxxx.com>"
- from="Libby <libby@xxxxxxxxx.com>"
- subject="Thanks for last night!">
-
- Thanks for last night. I had a great time.
- Let's do that again soon.
-
- </cfmail>
Doing this will use the first value "Ben" as the name to display and will use the value in between the "<" and ">" as the user's email address. But what happens if that name contains a suffix like "Jr" or "Sr"? When I first came up against this, I tried to do what I had done before:
- <cfmail
- to="John Noble, Jr. <john.jr@xxxxxxxxx.com>"
- from="John Noble, Sr. <john.sr@xxxxxxxxx.com>"
- subject="Son, I found a girl for you"
- type="HTML">
-
- <p>
- Dear Son,
- </p>
-
- <p>
- This is a girl from your mother's drawing class. She
- looks like a ton of fun. I really think you should
- consider meeting her for drinks. Here's a URL:
- http://flickr.com/photos/keppyslinger/477844455/
- </p>
-
- </cfmail>
In this case, John Noble, Sr. is sending an email to his son, John Noble, Jr.. However, when I try to run the code above, I get the following ColdFusion error:
Attribute validation error for tag CFMAIL. The value of the attribute to, which is currently "John Noble, Jr. <john.jr@xxxxxxxxx.com>", is invalid.
The problem with this is that you can use ColdFusion's CFMail tag to send to multiple recipients by using a comma-delimited list of email addresses in the TO attribute:
- <cfmail
- to="dude@xxxx.com,chick@xxxxx.com,dog@xxxxxx.com"
- from="ben@xxxxxx.com"
- subject="To all of you!">
-
- Hey guys, you all rock!
-
- </cfmail>
Well, that is to say, that is not a problem. This is, in fact, a highyl beneficial feature of the ColdFusion language. But, my problem in this case is that the comma in the suffix name is confusing ColdFusion into thinking that there are multiple TO addresses. The trick to fixing this, as I just discovered, is to wrap the name of the sender or recipient in quotes so that ColdFusion knows to treat it as a whole value. This will, for lack of a better term, escape the comma in the CFMail attributes:
- <cfmail
- to="""John Noble, Jr."" <john.jr@xxxxxxxxx.com>"
- from="""John Noble, Sr."" <john.sr@xxxxxxxxx.com>"
- subject="Son, I found a girl for you"
- type="HTML">
-
- <p>
- Dear Son,
- </p>
-
- <p>
- This is a girl from your mother's drawing class. She
- looks like a ton of fun. I really think you should
- consider meeting her for drinks. Here's a URL:
- http://flickr.com/photos/keppyslinger/477844455/
- </p>
-
- </cfmail>
Notice that the names are wrapped in double-double quotes. Remember that in ColdFusion, in order to escape double quotes within a double-quote-quoted string value, you have to use two quotes in a row.
As it turns out though, ColdFusion provides an even easier way to handle this situation. If you don't want to use the quote escaping, you can swap up the order of the name and email address and place the display name within parenthesis:
- <cfmail
- to="john.jr@xxxxxxxxx.com (John Noble, Jr.)"
- from="john.sr@xxxxxxxxx.com (John Noble, Sr.)"
- subject="Son, I found a girl for you"
- type="HTML">
-
- <p>
- Dear Son,
- </p>
-
- <p>
- This is a girl from your mother's drawing class. She
- looks like a ton of fun. I really think you should
- consider meeting her for drinks. Here's a URL:
- http://flickr.com/photos/keppyslinger/477844455/
- </p>
-
- </cfmail>
This will accomplish the same exact thing with slightly more readable code. I am not sure if one offers advantages over the other outside of the need to escape the comma. So, that's how you escape commas within the user name of the ColdFusion CFMail tag.
Reader Comments
I never knew Jurassic Park was a real place! =)
Just don't be fooled. That was a professional dinosaur rider on a closed road. Do not try that at home.
Thanks for the usefully Examples.
Thanks Ben,
I experimented a while back and gave up. Nice to know the proper way to handle it. I wonder why this is not documented by Adobe... or, maybe it is and I missed it.
Anyway, thanks for the tip!
I tried all this and none of it works. Still get the error.
@Dusty,
What error is it giving you?
Thank you thank you thank you! This is EXACTLY what I've been looking for!
It's clear that she was riding the dinosaur under controlled conditions, thanks for the warning Ben :)
@Dusty, I got it up and running now. Post the error please?
The only one of these that worked, using CFMAIL and SmarterMail, was the double-double quote approach. Thanks very much for this helpful page. Bob mack
@Robert,
Yeah, that's the one I've found to be the most universal.
I noticed this only became an issue after I upgraded from MX7 to CF9. I had a cfmail tag that in the from address had "Companyname, Inc <test@email.com> and this worked perfectly in MX7.
After upgraded to 9, all my mail started going in the undeliverable folder. Took a while to figure it out but thanks for pointing this out Ben.
@Rob,
That's good to know - I haven't upgraded to CF9 yet, but I'll keep my eyes open.
I just ran into the comma problem. Thanks for this post, it solved my problem.
@Don,
Glad to be here to help.
Thanks Ben. This is really a very helpful article. Keep posting... Congrats.
The question is now how do you get CSS in your cfmail body. Yikes!
@ Omar.. If you're including a stylesheet, be sure to put the full path since it is an email and would need to be downloaded over the internet...
For example...
<link rel="stylesheet" href="http://www.yourdomain.com/css/styles.css" type="text/css" />
hope that helps.
@Rob G., im not sure why this doesn't work for me. I'll try it again.
Be sure your email program is not set to block html. Also some webmail doesn't download html accurately either.
@Omar,
I find CSS in email to be hit or miss. I tend to use inline CSS to get the most stable results. But, I am far from the best guy to talk to about this; I don't send out too many emails.
@Ben Nadel, I've seem to have got it working with this, noting the style tag wrapped around the link
<style type="text/css">
<link rel="stylesheet" href="http://www.domain.com/css/mail.css" type="text/css" />
</style>
@Omar,
Interesting. I am not sure why that would work. It must escape the Style tags (allowing the Link tag to execute).
I always know that when I google any CF problem and end up on this guy's website, I've found the solution. Thanks Ben for all your support. This, as usual, was exactly what I was looking for.
@Matt,
Very awesome! Glad I could be here to help :)
Hi Ben
I was wondering if you knew how to display special chars in the cfmail subjuct line.
I want & not to be &! ?
Saved my neck again, Ben! :) Great info!
