CFMail: CFMAILPARAM Used to Embed Images in Email

Posted May 22, 2006 at 12:57 PM

Tags: ColdFusion

It used to be in pre-ColdFusion MX 7 (CFMX 7), to embed images in an email, to set them up so that they do not show up as attachments or external source links, I needed to use a special CFMail custom tag. Just the other day, on the House of Fusion mailing list, there was a thread about embedding images in emails.

I did not know this, but apparently in ColdFusion MX 7, the CFMailParam tag can be used to embed images directly into the email content. After some initial testing, it seems this is completely true and very exciting! It is almost too easy.

I tried it with two different methodologies. One, embeds a file from the local file system. The other embeds an image from a live Url. Both seemed to work find with Microsoft Outlook and GMail. The live Url link did not work in Hotmail, but was available as a downloadable attachment. While I could not test it, I was told that the test for live Url embedding did not work in Thunderbird.

Here is the sample code:

 Launch code in new window » Download code as text file »

  • <cfmail
  • to="xxxx@xxxx.com"
  • from="xxxx@xxxx.com"
  • subject="Embedded Image test via CFMail"
  • type="html">
  •  
  • <h2>
  • This Email is Designed to Test Embedded Email Messages
  • </h2>
  •  
  • <p>
  • Image of a girl I found on Flickr.com.
  • </p>
  •  
  • <p>
  • <img src="cid:girl" width="350" height="263" alt="" /><br />
  • </p>
  •  
  • <p>
  • Image of two girls I found on Flickr.com.
  • </p>
  •  
  • <p>
  • <img src="cid:girls" width="350" height="261" alt="" /><br />
  • </p>
  •  
  • <!--- Embed image via the local file system. --->
  • <cfmailparam
  • file="#ExpandPath('./girl.jpg')#"
  • contentid="girl"
  • disposition="inline"
  • />
  •  
  • <!--- Embed the image via a live Url link. --->
  • <cfmailparam
  • file="http://static.flickr.com/42/111929124_66e7ca6af0.jpg?v=0"
  • contentid="girls"
  • disposition="inline"
  • />
  •  
  • </cfmail>

Download Code Snippet ZIP File

Post Comment  |  Ask Ben  |  Permalink  |  Other Searches  |  Print Page





Reader Comments

Nov 28, 2007 at 1:01 PM // reply »
1 Comments

Fantastic tip. If was the first one I found when googling. I am building a crm system and need to send graphics.

Here is what I have added to it.

1. I loop through the email content looking for src ( I know there won't be anything else in there with src but <img> as it's my content.
2. Add each image URL to a list
3. Loop through the list and replace the url in the mailer content with the cid: +filename (without extension)
4. Then at the bottom of the email loop through the list again and do the <cfmailparam> inside the loop.

Worked first time. Thank you!!!


Nov 28, 2007 at 2:37 PM // reply »
6,371 Comments

@Simon,

Sounds like a cool idea. I like it a lot. I recently got into CFPop for pulling down emails and I've been told you have to do the opposite on render of the email body (taking all the CIDs and swapping them back into img SRC attributes to point to files on the server or something). Nothing to do with what you are saying, but at the other end of the same spectrum.


John H.
Apr 3, 2008 at 4:51 PM // reply »
2 Comments

Could this be adapted to embed css into the email as well? So far I've had no luck.


Apr 4, 2008 at 7:49 AM // reply »
6,371 Comments

@John,

I don't think so. When you use CSS in a web page, you are not referring to the file itself, but rather to formatting rules that are loaded in the file. I don't think this loads files, but rather provides inline references to them.


John H.
Apr 4, 2008 at 10:48 AM // reply »
2 Comments

Yeah. I settled on including the css in a style tag in the header. I was experimenting with styling emails that will be viewed in Lotus Notes.

They'll get just the plain markup while the rest will be able to view the styled email.

I did discover that Lotus Notes will not display .png files. A simple conversion to .gif and presto!


May 7, 2008 at 7:31 AM // reply »
2 Comments

I attempted to use this tag to embed an image, it only sends as an attachment and I am using CF7 .. Strange.

<cffunction name="send" access="public" returntype="void" output="false">
<cfargument name="emailNotobj" required="true" type="bmg.model.beans.emailnotification" />
<cfset var r = variables.reactor.createRecord("distroList").load(distroId=arguments.emailNotObj.getdList()) />
<cfset var eList = "" />
<cfset var emails = r.getDistroEmailIterator().getQuery() />
<cfset var b = getPreview(arguments.emailNotObj) />
<cfloop query="emails">
<cfset eList = eList & emails.email & ',' />
</cfloop>
<cfmail to="#eList#" from="BMGBase@awsmail.att.com" type="html" subject="#arguments.emailNotObj.getSubject()#">
<div>
<cfmailparam file="#ExpandPath('views/images/mailheader.jpg')#" contentid="emailHeader" disposition="inline" />
</div>
#b#
</cfmail>
</cffunction>


May 7, 2008 at 7:37 AM // reply »
6,371 Comments

@Thomas,

To embed it, I am pretty sure you need to give it a contentid value and then reference via an IMG tag within the email where the src is "cid:YOUR_VALUE".


May 7, 2008 at 7:38 AM // reply »
2 Comments

two seconds after i post my question i realize there is an image tag with cid:idname in it. I guess I assumed the param tag was going to just fit it in automagically for me. :(


May 7, 2008 at 7:39 AM // reply »
6,371 Comments

@Thomas,

No problem :)


Aug 23, 2008 at 6:58 AM // reply »
1 Comments

Hi all,

Just writing to confirm that the embedded images work in Thunderbird.

The first time I ran Bens example, it didnt work but after looking at the source in Thunderbird, I figured out why it wasnt showing.

The image Ben uses in his example is :
http://static.flickr.com/42/111929124_66e7ca6af0.jpg?v=0

The ?v=0 at the end was causing problems in Thunderbird.

To make it work, I changed the image URL to:
http://static.flickr.com/42/111929124_66e7ca6af0.jpg

and BINGO! Works a charm!

Regards,
Dan.


Walker
Jan 28, 2009 at 7:52 PM // reply »
1 Comments

I'm trying to get what Simon did. I have two files index.cfm which I use to see that the page looks like in my browser (and I edit) and when I'm ready to send I call cfmail.cfm which I use a CFINCLUDE to my index.cfm file.

Is there any code on how to do the what Simon did?
I'm using CFHTTP for the first time.

1. I loop through the email content looking for src ( I know there won't be anything else in there with src but <img> as it's my content.

2. Add each image URL to a list

3. Loop through the list and replace the url in the mailer content with the cid: +filename (without extension)

4. Then at the bottom of the email loop through the list again and do the <cfmailparam> inside the loop.

Thanks


IK
May 19, 2009 at 2:47 PM // reply »
1 Comments

What about tracking images? Currently I am using a img tag to call a cfm age to track whether the email was opened or not. This doesn't work with this method as far as I've tested. Is there a way to do this without making the user 'Download images'?


May 19, 2009 at 2:51 PM // reply »
6,371 Comments

@IK,

Not as far as I know. You either use the CFM to track AND have to get them to explicitly download the image... or you have the image always display, but you lose the ability to track.


Jun 16, 2009 at 2:39 AM // reply »
4 Comments

Thanks for this - I have been trying to find a solution to this for years! So simple! one question tho... any idea if I could get it to embed a pdf in the body of the email?


Jun 16, 2009 at 8:27 AM // reply »
6,371 Comments

@Dave,

You might could try an IFrame to embed the PDF, but not sure that would work.


Jun 17, 2009 at 2:08 PM // reply »
38 Comments

here again for a solution - and of course i found it - thx ben.


Jun 18, 2009 at 2:31 AM // reply »
4 Comments

Thanks Ben - searched for and tried everything I could think of without success. If ever you hear of / create a solution, I would be keen to hear from you!


Jun 18, 2009 at 8:34 AM // reply »
6,371 Comments

@James,

Woohoo, glad to help :)

@Dave,

I am not sure what you are referring to. A solution for what?


Oct 9, 2009 at 7:43 PM // reply »
1 Comments

Yet another tip, from the most useful collection of tutorials on the net.. thanks Ben!


Oct 28, 2009 at 12:49 PM // reply »
4 Comments

I have a weird problem where the image is embeded inline like it should, but it's also showing the image at the bottom of the email message. i.e. the same image is being displayed twice. Not sure if this my email program (Mac OS X Mail.app) or if I'm doing something wrong.

Has anyone else experienced this issue?


Oct 28, 2009 at 1:23 PM // reply »
6,371 Comments

@Doug,

I have gotten that a few times. The thing at the bottom is usually the email client's way to represent attached images. So, it shows up inline, but then it also shows up as an image attachment.


Post Comment  |  Ask Ben

Recent Blog Comments
Nov 7, 2009 at 5:53 PM
Ask Ben: Javascript String Replace Method
You can find here an advanced function that prepared with javascript replace function. This can make the first letters of words, sentences, lines and whatever you define automatically: http://www.m ... read »
Andrew Neely
Nov 7, 2009 at 4:56 PM
A Moment That Touched Me - The Fountainhead
Ben, Glad you enjoyed the podcast. Yeah, the Tank Riot guys can get really chatty during the episodes, but that's part of the charm of it for me. They've covered everything from Nichola Tesla to Cha ... read »
Nov 7, 2009 at 4:43 PM
Building A Fixed-Position Bottom Menu Bar (ala FaceBook)
Is it possible to make some more MenĂ¼`s ? ... read »
Jill
Nov 7, 2009 at 11:40 AM
How To Unformat Your Code (Like A Pro)
Derek, I think you might be right - sweet! Thanks for the link :) ... read »
Nov 7, 2009 at 11:25 AM
How To Unformat Your Code (Like A Pro)
I think it would be way easier to just use this http://www.logichammer.com/html-formatter/ He just released v3 and it rocks. ... read »
Jill
Nov 7, 2009 at 7:58 AM
How To Unformat Your Code (Like A Pro)
LMAO - this was pretty funny! I have to admit - I also love to reformat code so I can read it. My boss used to tell me to leave my OCD at home. Now I don't feel so bad after reading everyone else' ... read »
Nov 6, 2009 at 10:10 PM
How To Unformat Your Code (Like A Pro)
The timing of this post is just uncanny. I spent the last 15-20 minutes manually un-formatting my "Ben Nadel" style code within a CFC of mine. I was really digging the readability a few weeks ago, bu ... read »
Roe
Nov 6, 2009 at 5:11 PM
Passing Arrays By Reference In ColdFusion - SWEEET!
ArraySort also reorders the results of these java obj's ... read »