メタデータ API 開発者ガイド
jEmailTemplate
MetadataWithContent メタデータ型を拡張し、その content 項目と fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
テンプレートファイルのファイルサフィックスは .email です。付随するメタデータファイルには、EmailTemplateName-meta.xml という名前が付けられます。
EmailTemplate コンポーネントは、対応するパッケージディレクトリの email フォルダに保存されます。たとえば、sampleFolder フォルダにある SampleTemplate という名前のメールテンプレートの場合は、パッケージの email/sampleFolder に SampleTemplate-meta.xml があります。
メールテンプレートの取得
package.xml ではメールテンプレートにワイルドカード (*) 記号を使用できません。明示的な名前を package.xml に入力するためにメールテンプレートのリストを取得するには、listMetadata() をコールし、EmailTemplate をデータ型として渡します。
次の例では、package.xml 内のフォルダを示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>MyDBFolder/MyDBName</members>
5 <name>Dashboard</name>
6 </types>
7 <types>
8 <members>MyDocumentFolder/MyDocumentName</members>
9 <name>Document</name>
10 </types>
11 <types>
12 <members>unfiled$public/MarketingProductInquiryResponse</members>
13 <members>unfiled$public/SalesNewCustomerEmail</members>
14 <name>EmailTemplate</name>
15 </types>
16 <types>
17 <members>MyReportFolder/MyReportName</members>
18 <name>Report</name>
19 </types>
20 <version>43.0</version>
21</Package>バージョン
メールテンプレートは API バージョン 12.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| apiVersion | double | これが Visualforce メールテンプレートである場合は、API バージョン。どの Visualforce メールテンプレートにも作成時に指定された API バージョンがあります。この項目は、API バージョン 16.0 以降で使用できます。 |
| attachedDocuments | string[] | 組織のドキュメントへの参照のリスト。これらのドキュメントは、メールテンプレートの添付ファイルとして含まれています。各ドキュメントは、MyFolder/MyDocument.txt などのパスで参照されます。 |
| attachments | Attachment[] | メールテンプレートの添付ファイルのリスト。 |
| available | boolean | 必須。メール送信時にこのテンプレートがユーザに提供されるか (true)、否か (false) を示します。 |
| content | base64Binary | メールテンプレートのコンテンツ。Base 64 で符号化されたバイナリデータAPI コールを行う前に、クライアントアプリケーションはバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。この項目には次のものが含まれています。
この項目は、MetadataWithContent コンポーネントから継承されます。 |
| description | string | メールテンプレートの説明。これはテンプレートを作成した理由を説明するのに役立ちます。 |
| encodingKey | Encoding (string 型の列挙) |
必須。デフォルトの文字コード設定は Unicode (UTF-8) です。テンプレートが別形式のデータを必要とする場合は、この設定を変更します。 使用できる値は次のとおりです。
|
| fullName | string | API アクセスの一意の識別子として使用されるメールテンプレートの開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目が、使用できなくなったバージョン 14.0 より前の文字を含んでいた場合は、それらの文字はこの項目から削除され、その項目の以前の値は name 項目に保存されていました。この項目は、Metadata コンポーネントから継承されています。 |
| letterhead | string | このメールテンプレートに関連付けられたレターヘッド名。type が html に設定されている場合のみ有効です。 |
| name | string | 必須。メールテンプレート名。fullName 項目で使用できる文字のリストは、バージョン 14.0 以降削減されています。この項目には、バージョン 14.0 以前の fullName 項目に含まれている値が含まれます。 |
| packageVersions | PackageVersion[] | このメールテンプレートによって参照されるコンポーネントを含むすべての管理パッケージのパッケージバージョンのリスト。この項目は、Visualforce メールテンプレートにのみ関連します。 |
| relatedEntityType | Object Name (string 型の列挙) | Lightning Experience メールテンプレートの作成、パッケージ化、または移動には必須です。 UIType が SFX (Lightning Experience) または SFX_Sample (Lightning Experience のサンプル) の場合、RelatedEntityType は、このテンプレートを使用可能なエンティティを示します。 RelatedEntityType は、カスタムオブジェクト名にすることができます。他の有効な値は、エンティティ API 名 (取引先の場合は「取引先」、取引先責任者の場合は「取引先責任者」、商談の場合は「商談」、リードの場合は「リード」など) です。値には、ユーザが参照アクセス権を持つ任意のエンティティ (カスタムエンティティを含む) を指定できますが、仮想エンティティ、設定エンティティ、またはプラットフォームエンティティは指定できません。 |
| style | EmailTemplateStyle (string 型の列挙) | 必須。テンプレートのスタイル。この項目は、type が html に設定されている場合にのみ表示されます。 使用できるスタイルの値は次のとおりです。
|
| subject | string | メールの件名。 |
| textOnly | string | type が html または custom に設定されている場合は、メール本文のテキスト。 |
| type | EmailTemplateType (string 型の列挙) | 必須。メールテンプレートの種類。 有効な値は、次のとおりです。
|
| UiType | EmailTemplateUiType (string 型の列挙) | このテンプレートを使用可能なユーザインターフェースを示します。有効な値は、次のとおりです。
UiType が SFX の場合、type は custom である必要があります。 |
例
1<EmailTemplate>
2 <available>true</available>
3 <description>Notification that user has been added to a community.</description>
4 <encodingKey>UTF-8</encodingKey>
5 <name>Communities: New Member Welcome Email</name>
6 <style>none</style>
7 <subject>Welcome to {!Community_Name}</subject>
8 <type>custom</type>
9 <uiType>SFX</uiType>
10 <relatedEntityType>Contact</relatedEntityType>
11</EmailTemplate>Attachment
| 項目 | データ型 | 説明 |
|---|---|---|
| content | base64Binary | 必須。添付ファイルのコンテンツ。Base 64 で符号化されたバイナリデータAPI コールを行う前に、クライアントアプリケーションはバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。 |
| name | string | 必須。添付ファイル名。 |
宣言的なメタデータの定義のサンプル
メールテンプレートの XML 定義のサンプルを以下に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<EmailTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
3 <available>true</available>
4 <description>Sample Email Template</description>
5 <encodingKey>ISO-8859-1</encodingKey>
6 <name>Sample Email Template</name>
7 <style>none</style>
8 <subject>Sample email subject</subject>
9 <textOnly>Your case has been resolved.</textOnly>
10 <type>custom</type>
11</EmailTemplate>