Creating an environment safe wrapper for cfmail

The one thing that always makes me nervous when testing other people's code, is who is this going to email? Well many years back I created a cf_email custom tag that wrapped cfmail with some special if logic before it to determine if it was in production or different environment. The logic for is easy

comparenoCase(server.serverLevel,"PRODUCTION") EQ 0

and there was another script that got included in the application.cfm file "server.cfm" that loaded the server variables.
But the issue I ran into lately, was I needed to use one of the newer features within cfmail that wasn't hard coded into my wrapper. So knowing that coldfusion added the support to attributeCollection=attributes and seeing the Ray Camden had a nice blog post on CFASSOCIATE. I asked one of my co-workers to work on it :-D But anyways, we came up with the below code.

The below code allows the same features within coldfusion to be used for within the customTag, but now we can add additional logic to verify environment and only send the program's email in production, and tweak the TO,CC,BCC fields if not within production.
Test Code
<cf_email to="endUser@cfhero.com" from="help@cfhero.com" subject="This is only a test">

    <cf_emailparam file="#expandPath("./web.jpg")#" disposition="inline" contentID="image1">
 
    There should be an image here <img src="cid:image1" />

</cf_email>
cf_email
<cfif CompareNoCase(thisTag.hasEndtag,"NO") EQ 0>
 <cfthrow message="cf_email requires end tag" />
</cfif>

<cfparam name="attributes.from">
<cfparam name="attributes.to">
<cfparam name="attributes.subject">


<cfif CompareNoCase(thisTag.executionMode,"END") EQ 0 >

<!--- add customization here for non-production use --->
 
<!--- blank the generated content out and move it into a variable --->
<cfset variables.GeneratedContent = thisTag.GeneratedContent>
<cfset thisTag.generatedContent = "">
 
<cfmail attributecollection="#attributes#" from="#attributes.from#" subject="#attributes.subject#" to="#attributes.to#">
 <cfif isDefined("thisTag.emailParam")>
  <cfloop array="#thisTag.emailParam#" index="attrCol">
   <cfmailparam attributecollection="#attrCol#" >
  </cfloop> 
 </cfif>
#variables.GeneratedContent#
</cfmail>
</cfif>

cf_emailParam
<cfif CompareNoCase(thisTag.hasEndtag,"YES") EQ 0 AND CompareNoCase(thisTag.executionMode,"END") EQ 0 >
 <cfexit method="exittag" />
</cfif>

<cfassociate basetag="cf_email" datacollection="emailParam">

Comments

Post a Comment

Popular posts from this blog

ColdFusion in an Enterprise Environment - Part 1 - Understanding how to use SubVersion (SVN)

Subversion can be used in many ways, so this isn't the holy grail of how you need to use subversion, but it does add application management to subversion. What does application management mean? Well, the definition for this article is how to control what gets released into production. This article is not going to go into how to setup version, or how to add an external to the repository tree. But how in concept to use SVN and an external to achieve application management. First of course you need a SVN repository, which for the purpose of this article our repository will be noted as "/". Second we need to know that will we still be using the concepts of trunk, tags, and branches, they just won't live in the root of the repository. The trunk is the current working copy of development, while the tag folder is to version releases (by tagging). Branches will be used when "new" development is going on and emergency coding is required on the existin...
Read more

coldfusion builder 2 extension not displaying browse button on type=projectdir

I'm in the process of creating an extension that fires from the RDSView (from a database table).  Basically I would like it to create 7 files for me by using the table's columns I selected.  *PERFECT*, I got the files being created, but I have to TYPE in the LOCATION to store the files <-- WHAT --  Yes, I said I have to type in the full path to where I want the files to be stored. So my question to anyone who might see this blog is -->  Is there a way via (call back, response, etc) in an cfbuilder extension for the user to pick the project and/or folder as an input? PS.  if you read this and don't know the answer, please "socialize" it (tweet, FaceBook, etc) so possibly the correct person with the answer can answer it.  *THANKS* **UPDATE 9/29/2011** I was able to email a contact at Adobe with this issue, and after working back and forth, it came up that the input of  type="projectdir" does NOT work when using a REMOTE server. How disappoin...
Read more

Being Thread Safe in Coldbox/Coldfusion

Thread safe never crossed my mind.  I never put CFC in the application scope to allow quicker execution (bypassing the createobject function).  But now that my office has implemented ColdBox, it cache's a lot for you, including its handlers - which are CFCs.  Well, we got bit by that evil words "THREAD SAFE".  Our code WASN'T... yes including my code. So what does that mean.  Well I'll try to do a quick explanation, thread safe is any variable that is dedicated to a SINGLE user will NOT be shared to other users.  For example, in a object a "private" variable is NOT thread safe.  So if many users use the same object (implementation of a class), then we must make sure the variables being passed around are LOCAL to that function.  Therefore, in a CFC (depending on language) you must force your function variables to be LOCAL to the function only. In CF8 use of the VAR keyword provides this <cfset var myLocalVar = "" /> In CF9 the use o...
Read more