tracker issue : CF-4204129

select a category, or use search below
(searches all categories and all time range)
Title:

cfmailparam page could be easily improved with a proposed better header example

| View in Tracker

Status/Resolution/Reason: To Test//HaveNewInfo

Reporter/Name(from Bugbase): Charlie A. / ()

Created: 03/30/2019

Components: Documentation

Versions: 2018

Failure Type: Others

Found In Build/Fixed In Build: n/a /

Priority/Frequency: Normal /

Locale/System: / Win 2016

Vote Count: 0

Folks, the CF docs for cfmailparam (in the Developing CF Apps) manual has an example which is old and no longer appropriate. I can offer a more useful one, that can be fixed in one line of code.

I'm talking about this page:
https://helpx.adobe.com/coldfusion/developing-applications/using-external-resources/sending-and-receiving-e-mail/using-the-cfmailparam-tag.html

In the last section, on "Adding a custom header to a message", it shows adding a reply-to header, using cfparam. That is no longer necessary, since CF7 (as indicated on the CFML ref page https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-tags/tags-m-o/cfmail.html).

So the last section's wording and example could/should be changed to refer to a more useful example of a header one may want to set, such as "importance". Where the current code shows this:

<cfmailparam name="Reply-To" value="widget_master@YourCompany.com"> 

It could be changed to do this:

<cfmailparam name = "Importance" value = "High"> 

But again, don't just change the example. The paragraph above it must change, to explain how it's setting the mail's "importance" to "high", and what that means for mail clients and why it's useful. The point is that it helps people appreciate the real value of the cfmailparam tag. 

(And FWIW, note that the CFML Reference on cfmailparam DOES itself show use of this tag to set that importance header this way, in its "Example 1", though it has many other headers in its rather complicated example.)

Finally, note also that curiously, all the examples on the cfmailparam page (in the Developing Apps page) fail to show the opening CFMAIL tag. More than that, note how they are gray in color, in contrast to the examples in the CFML Reference page for the cfmailparam. Can that be corrected? (And could it be noted to fix that in any and ALL pages in the Developing Apps doc which might suffer from that problem. I realize that could take a long time to fix. I just mean please note it to start the process to fix it.)

Attachments:

Comments: