この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

renderEmailTemplate()

メールテンプレートのテキスト本文の差し込み項目を、多態的な項目の場合も含め、対応する Salesforce レコード ID と置き換えます。メールテンプレートの本文と対応する whoId 値および whatId 値は引数で指定します。

構文

使用方法

renderEmailTemplate() コールは、カスタムテンプレートを使用したメールを sendEmail() コールで送信する場合の差し込み項目の表示に相当します。

renderEmailTemplate() コールの配列引数には最大 10 個の RenderEmailTemplateRequest 要素を指定でき、各 RenderEmailTemplateRequest には最大 10 個のテンプレート本文を含めることができます。各要求は配列内の他の要求から独立しており、1 つの要求でエラーが発生しても他の要求には影響しません。同様に、1 つのテンプレート本文でエラーが発生しても、同じ要求内の他のテキスト本文ではエラーになりません。

renderEmailTemplate() コールでは、差し込み項目が RenderEmailTemplateRequestwhatId または whoId の値に置き換えられます。

  • 差し込み項目が人以外のオブジェクトを参照している場合は、whatId の対応する値に置き換えられます。たとえば、差し込み項目が取引先または商談を参照している場合、whatId の値に置き換えられます。
  • 差し込み項目が人のオブジェクトを参照している場合は、whoId の対応する値に置き換えられます。たとえば、差し込み項目が取引先責任者、リード、またはユーザを参照している場合、whoId の値に置き換えられます。
RenderEmailTemplateRequestwhatId および whoId 項目の値は、要求ごとに検証されます。whatId が有効な What ID (人以外のオブジェクト) を参照していないか、whoId が有効な Who ID (人のオブジェクト) を参照していないと、要求に対してエラーが設定されます。

差し込み項目に値がないと、対応するテンプレート本文について renderEmailTemplate() コールからエラーが返されます。たとえば、差し込み項目が空白または null で置き換えられると、エラーが返されます。

サンプルコード —Java

次のサンプルでは、renderEmailTemplate() コールで、すべての取引先責任者差し込み項目を、指定された whoId 引数の値で置き換えます。同様に、商談差し込み項目 ({!Opportunity.Name}) を、指定された whatId の値で置き換えます。このサンプルの 2 番目のテンプレート本文は不正な差し込み項目 ({!Contact.SNARF}) であるため、2 番目のテンプレートはエラーになります。ただし、要求を表示するテンプレート全体は成功します。

最初の引数 (whoId) に有効な取引先責任者 ID を指定し、2 番目の引数 (whatId) に null を指定して、このサンプルを実行するとします。2 番目のテンプレートには、2 つのエラーが設定されます。最初のエラーは不正な差し込み項目が原因であり、2 番目のエラーは whatId が null であるために商談差し込み項目 ({!Opportunity.Name}) が見つからなかったことが原因です。応答は次のようになります。

RenderEmailTemplateRequest

名前 説明
templateBodies string[] {!Account.Phone}{!Contact.Name} などの差し込み項目を含めることができるテキスト本文の配列。
whatId reference 取引先、商談、キャンペーン、ケース、カスタムオブジェクトなどの人以外のオブジェクトを参照します。whatId は多態的です。つまり、ケースや商談など、複数の種別のオブジェクトを参照できる ID であるという意味です。
whoId reference リードや取引先責任者など、人のオブジェクトを参照します。whoId は多態的です。つまり、取引先責任者の ID やリードの ID に相当するという意味です。

障害

renderEmailTemplate() から、次のいずれかの API 状況コードが返される場合があります。

EMAIL_TEMPLATE_FORMULA_ERROR

EMAIL_TEMPLATE_MERGEFIELD_ACCESS_ERROR

EMAIL_TEMPLATE_MERGEFIELD_ERROR

EMAIL_TEMPLATE_MERGEFIELD_VALUE_ERROR

EMAIL_TEMPLATE_PROCESSING_ERROR