[SalesForce] How to pass paramaters from an email template into a custom component

setup:

Opportunities are related in a MDR to children__c object. When my opp reaches a stage, an email alert (via workflow) gets sent out with the opp info. I want to include a list of urls for the children record related to that master opp. I did some reading- and it looks like custom components do the trick.

questions:

is this the right approach?
how do i pass params to the custom compoenent from the email template?

EDIT- Code:

Apex Class

    public with sharing class BenefitChecklistEmailTemplateHelper {
        public list <Benefit_Checklist__c> checklists;
        public String oppId {get; set;}

        public BenefitChecklistEmailTemplateHelper(){
            system.debug('oppid :' +oppId);
            this.checklists = [select id, name from Benefit_Checklist__c where Opportunity__c = :oppId];

        }   
}

Custom component

    <apex:component controller="BenefitChecklistEmailTemplateHelper" access="global">
    <apex:attribute id="oppId" assignTo="{!oppId}" name="opportunityIDFromEmail" type="ID" description="The Opporunity's SF ID"/>    
       <table border="0" >
             <tr>
                 <apex:repeat var="c" value="{!Checklists}">
                    <tr>
                        <td><a href="https://na1.salesforce.com/{!c.id}">View</a> </td>
                        <td class="sub_section_label">Checklist Name</td><td class="sub_section_data">: {!c.id}</td>
                    </tr>
                </apex:repeat>   
            </tr>              
        </table>
    </apex:component>

Email Template

    <c.BenefitChecklistEmailTemplateHelper opportunityIDFromEmail="{!relatedTo}"/>

Best Answer

You have two options here, one with and one without a custom component.

Without Custom Component. If your using a Visualforce Email Template you can use the apex:repeat take to reference the child records of your Opportunity. From the link the following sample shows how to list related Cases to an Account.

<table border="0" >
    <tr >
        <th>Action</th><th>Case Number</th><th>Subject</th><th>Creator Email</th><th>Status</th>
    </tr>
    <apex:repeat var="cx" value="{!relatedTo.Cases}">
        <tr>
            <td><a href="https://na1.salesforce.com/{!cx.id}">View</a> | 
            <a href="https://na1.salesforce.com/{!cx.id}/e">Edit</a></td>
            <td>{!cx.CaseNumber}</td>
            <td>{!cx.Subject}</td>
            <td>{!cx.Contact.email}</td>
            <td>{!cx.Status}</td>
        </tr>
    </apex:repeat>                
</table>

With Custom Component. You can create a custom componnet that takes as an attribute an instance of your Opportunity (or its Id) who's controller then performs a SOQL query (or uses a relationship dereference, see note) for the child records. The component itself uses a apex:repeat tag. The reason you might want to do this, is to sort the child records or do additional processing on them to expose further information (you could not generate via formula fields for example).

<c:showMyChildren opportunity="{!relatedTo}"/>

NOTE: You can avoid the custom component doing a requery, if you include in your email template a render="false" apex:repeat for the information you want, its never displayed, but gives the Visualforce runtime enough of a hint to query the information, allowing the custom component to access this information via the passed in Opportunity.

Update following Revised Answer

I spotted a couple of things with your implementation of option 2 above.

Your component attribute takes an Id so you need to pass the Opportunity Id not the whole Opportunity record (which is what 'relatedTo' points to). Try changing it to opportunityIDFromEmail="{!relatedTo.Id}"/>
The 'oppId' property of your controller will not have been set by the time the constructor of your component controller is called. Its an often a pitfall when writing component controllers. As properties are set in an indeterminate order, its best to differ process until one of your output accessor methods is called, in this case your getChecklists() method, move your constructor code into this method.

Related Solutions

[SalesForce] Passing custom string into a Salesforce email template.

I've done something similar in the past, but it requires that you manually do the template merge field lifting. Here is an example of how you could do it below.

Since you are manually doing the merging in the template, you can put any kind of merge field into your template that you'd like. In this example, I'm pretending there is a custom merge field {!myCustomString} in the email template for your custom string you want to insert.

I've also assumed below that you have a merge field for first name {!Contact.FirstName} in the subject and in the body of the template. If you have other fields, you would need to include the fields in the contact query and then to the string replace for each of those fields.

public static void sendSingleMail(Id contactId, Id templateId, String fromAddress, String myCustomString){

    // grab the email template
    EmailTemplate emailTemplate = [select Id, Subject, HtmlValue, Body from EmailTemplate where Id =: teamplateId];

    // grab the contact fields we need. This assumes we are emailing a contact.
    Contact c = [Select Id, FirstName FROM Contact WHERE Id=: contactId];

    // process the merge fields
    String subject = emailTemplate.Subject;
    subject = subject.replace('{!Contact.FirstName}', c.FirstName);

    String htmlBody = emailTemplate.HtmlValue;
    htmlBody = htmlBody.replace('{!Contact.FirstName}', c.FirstName);
    htmlBody = htmlBody.replace('{!myCustomString}', myCustomString);

    String plainBody = emailTemplate.Body;
    plainBody = plainBody.replace('{!Contact.FirstName}', c.FirstName);
    plainBody = plainBody.replace('{!myCustomString}', myCustomString);

        //build the email message
    Messaging.Singleemailmessage email = new Messaging.Singleemailmessage();

    email.setReplyTo(fromaddress);
    email.setSenderDisplayName(fromaddress);
    email.setTargetObjectId(objId);
    email.setSaveAsActivity(true);

    email.setSubject(subject);
    email.setHtmlBody(htmlBody);
    email.setPlainTextBody(plainBody);

    Messaging.sendEmail(new Messaging.SingleEmailmessage[] {email});
}

[SalesForce] getSalesforceBaseUrl() in a Custom Email Template

To get the string value of the base url use:

String fullFileURL = URL.getSalesforceBaseUrl().toExternalForm()

then append the '/' + your other parameters you may need

Assuming your URL helper class is not named URL

Also, you will probably need to change to a VF email template. Look for other answers though that may have a way to do it in the HTML template. (One clunky way is to populate a field on the case that holds the base URL and use a trigger to set the value. Then you could use that in the custom HTML email template. Or use a custom setting)

Best Answer

Related Solutions

[SalesForce] Passing custom string into a Salesforce email template.

[SalesForce] getSalesforceBaseUrl() in a Custom Email Template

Related Topic