EmailTemplate

メール、一括メール、リストメール、または Sales Engagement メールのテンプレートを表します。第一世代管理パッケージでのみサポートされます。

Visualforce メールテンプレートを使用して一括メールを送信することはできません。

メモ

サポートされているコール

create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()search()update()upsert()

特別なアクセスルール

カスタマーポータルユーザ��はこのオブジェクトにアクセスできません。

項目

項目 詳細
ApiVersion
double
プロパティ
Create、Filter、Nillable、Sort、Update
説明
このクラスの API バージョン。すべてのクラスには、作成時に指定された API バージョンが割り当てられています。
Body
textarea
プロパティ
Create、Nillable、Update
説明
メールの内容。最大 384 KB です。
BrandTemplateId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
必須。メールテンプレートに関連付けられている BrandTemplate の ID。ブランドテンプレートは、メールテンプレートのレターヘッド情報を提供します。
DeliveryRate
percent
プロパティ
Filter、Nillable、Sort
説明

参照のみ。(ソフトおよびハード) バウンスした数と対比した配信されたメール数の割合。なお、このデータには、受信者のスパムフォルダーに配信されたメールも含まれます。

この項目は、API バージョン 46.0 以降で使用できます。この項目にアクセスするには、組織で Sales Engagement を使用する必要があり、ユーザーに「Sales Engagement ユーザー」または「Sales Engagement ケイデンス作成者」権限セットが必要です。この項目値には、ListEmail オブジェクトまたは Sales Engagement ケイデンスで送信されたメールが含まれます。

Description
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
「販売促進一括メール」など、テンプレートの説明。
DeveloperName
string
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
API のオブジェクトの一意の名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更はサブスクライバーの組織で反映されます。表示ラベルは [テンプレートの一意の名前] です。

大規模データセットを作成する場合、必ず各レコードの一意の DeveloperName を指定してください。DeveloperName が指定されていないと、Salesforce で各レコードの DeveloperName を生成している間にパフォーマンスが低下する可能性があります。

メモ

Encoding
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
テンプレート用の文字セットエンコード。
EnhancedLetterheadId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
メールテンプレートに関連付けられた拡張レターヘッドの ID。

拡張レターヘッドを使用するには、HML を使用する Lightning メールテンプレートに関連付けます。

メモ

これはリレーション項目です。
リレーション名
EnhancedLetterhead
リレーション種別
Lookup
参照先
EnhancedLetterhead
EntityType
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort
説明
UIType2 (Lightning Experience) または 3 (Lightning Experience のサンプル) の場合、EntityType は、このテンプレートを使用可能なエンティティ (取引先、リードなど) を示します。有効な値は、標準オブジェクト ID プレフィックス (取引先は 001、取引先責任者は 003、商談は 006、リードは 00Q、ケースは 500、キャンペーンは 701) です。
この項目は API バージョン 39.0 で削除されました。代わりに RelatedEntityType を使用してください。
FolderId
reference
プロパティ
Create、Filter、Group、Sort、Update
説明
テンプレートを含むフォルダーの ID。
これはリレーション項目です。
リレーション名
Folder
リレーション種別
Lookup
参照先
Folder、Organization、User
FolderName
string
プロパティ
Filter、Nillable、Sort
説明
テンプレートを含むフォルダーの名前。
HasSalesforceFiles
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
メールテンプレートに Salesforce Files からの添付ファイルがあるかどうか。デフォルト値は false です。
HtmlValue
textarea
プロパティ
Create、Nillable、Update
説明
メールを表示する HTML コーディングなど、メールメッセージの内容を指定します。最大 384 KB です。
IsActive
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
このテンプレートが有効か (true)、無効か (false) を示します。
IsBuilderContent
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
メールテンプレートがメールテンプレートビルダーで作成されたかどうか。デフォルト値は false です。
LastUsedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
このメールテンプレートが最後に使用された日時。
Salesforce Classic テンプレートで使用されます。
通常、Lightning Experience テンプレートでは使用されません。
Markup
textarea
プロパティ
Create、Nillable、Update
説明
このテンプレートの内容を定義する Visualforce マークアップ、HTML、JavaScript、およびその他の Web 対応コード。
Name
string
プロパティ
Create、Filter、Group、idLookup、Sort、Update
説明
テンプレートの名前。表示ラベルは [メールテンプレート名] です。
NamespacePrefix
string
プロパティ
Filter、Group、Nillable、Sort
説明
このオブジェクトと関連付けられた名前空間プレフィックス。管理パッケージを作成する Developer Edition 組織ごとに一意の名前空間プレフィックスがあります。最大 15 文字です。namespacePrefix__componentName 表記を使用して、管理パッケージのコンポーネントを参照できます。

名前空間プレフィックスには、次のいずれかの値があります。

  • Developer Edition 組織では、インストールされた管理パッケージにオブジェクトが含まれていない限り、名前空間プレフィックスをサポートするすべてのオブジェクトで NamespacePrefix が組織の名前空間プレフィックスに設定されます。その場合、オブジェクトにはインストールされた管理パッケージの名前空間プレフィックスが付きます。この項目の値は、パッケージ開発者の Developer Edition 組織の名前空間プレフィックスです。
  • Developer Edition 組織でない場合、NamespacePrefix は、インストールされた管理パッケージの一部であるオブジェクトでのみ設定されます。その他のオブジェクトには名前空間プレフィックスがありません。

ログインユーザーに「アプリケーションのカスタマイズ」権限が付与されていない場合、この項目にアクセスできません。

OwnerId
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
テンプレートの所有者の ID。
これはリレーション項目です。
リレーション名
Owner
リレーション種別
Lookup
参照先
User
RelatedEntityType
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
UIType2 (Lightning Experience) または 3 (Lightning Experience のサンプル) の場合、RelatedEntityType は、このテンプレートを使用可能なエンティティを示します。有効な値は、エンティティ API 名: 取引先の場合は「取引先」、取引先責任者の場合は「取引先責任者」、商談の場合は「商談」、リードの場合は「リード」などです。値には、ユーザーが参照アクセス権を持つ任意のエンティティ (カスタムエンティティを含む) を指定できますが、仮想エンティティ、設定エンティティ、またはプラットフォームエンティティは指定できません。
スキーマレベルで制限はありません。
Subject
string
プロパティ
Create、Nillable、Sort、Update
説明
件名行の内容。
Lightning メールテンプレートでは 1,000 文字、Classic メールテンプレートでは 230 文字に制限されています。
TemplateStyle
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort
説明
テンプレートのスタイル。
可能な値は次のとおりです。
  • formalLetter — 標準レター (画像付き)
  • freeForm — 標準レター
  • newsletter — ニュースレター
  • none — メールレイアウトはありません
  • products — 商品
  • promotionLeft — 商品情報
  • promotionRight — プロモーション 1
TemplateType
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort
説明
テンプレートの種類。
可能な値は次のとおりです。
  • custom — カスタム
  • html — HTML
  • text — テキスト
  • visualforce — Visualforce
TimesUsed
int
プロパティ
Filter、Group、Nillable、Sort
説明
このメールテンプレートが使用された回数。
Salesforce Classic テンプレートで使用されます。
通常、Lightning Experience テンプレートでは使用されません。
TotalDelivered
int
プロパティ
Filter、Group、Nillable、Sort
説明

参照のみ。送信されたメールの総送信数からハードバウンス数とソフトバウンス数を引いた数。なお、このデータには、受信者のスパムフォルダーに配信されたメールも含まれます。

この項目は、API バージョン 46.0 以降で使用できます。この項目にアクセスするには、組織で Sales Engagement を使用する必要があり、ユーザーに「Sales Engagement ユーザー」または「Sales Engagement ケイデンス作成者」権限セットが必要です。この項目値には、ListEmail オブジェクトまたは Sales Engagement ケイデンスで送信されたメールが含まれます。

TotalHardBounced
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

参照のみ。アドレスが無効であるために、送信者に永続的にバウンスされたメールの総数。ハードバウンスは、ドメイン名が存在しないか、受信者が不明であると発生します。

この項目は、API バージョン 46.0 以降で使用できます。この項目にアクセスするには、組織で Sales Engagement を使用する必要があり、ユーザーに「Sales Engagement ユーザー」または「Sales Engagement ケイデンス作成者」権限セットが必要です。この項目値には、ListEmail オブジェクトまたは Sales Engagement ケイデンスで送信されたメールが含まれます。

TotalOpens
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

参照のみ。プロスペクトのメールクライアントが HTML 版のメールに含まれる画像を読み込んだ合計回数。画像をダウンロードしない HTML メールまたはテキストメールのリンクをプロスペクトがクリックした場合も、開封が記録されます。クリックされたということは、メッセージが表示されたということを意味します。デフォルトでは画像が表示されないメールクライアントもあります (Outlook、Apple Mail、Thunderbird)。Pardot では、画像が読み込まれるたびに開封が計数されます。

この項目は、API バージョン 46.0 以降で使用できます。この項目にアクセスするには、組織で Sales Engagement を使用する必要があり、ユーザーに「Sales Engagement ユーザー」または「Sales Engagement ケイデンス作成者」権限セットが必要です。この項目値には、ListEmail オブジェクトまたは Sales Engagement ケイデンスで送信されたメールが含まれます。

TotalSent
int
プロパティ
Filter、Group、Nillable、Sort
説明
参照のみ。送信したメールの総数。不達、送信除外、無効な宛先アドレスを含みます。

この項目は、API バージョン 46.0 以降で使用できます。この項目にアクセスするには、組織で Sales Engagement を使用する必要があり、ユーザーに「Sales Engagement ユーザー」または「Sales Engagement ケイデンス作成者」権限セットが必要です。この項目値には、ListEmail オブジェクトまたは Sales Engagement ケイデンスで送信されたメールが含まれます。

TotalSoftBounced
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

参照のみ。受信者のメールサーバーでメールが認識されたが、送信者に返された合計回数。受信者のメールボックスがいっぱいであるか、メールサーバーが一時的に使用不可になっていると発生します。ソフトバウンスメッセージは、時間を置くと配信可能になることがあります。ソフトバウンスが 5 回になると、Pardot によってプロスペクトはメールからオプトアウトされます。

この項目は、API バージョン 46.0 以降で使用できます。この項目にアクセスするには、組織で Sales Engagement を使用する必要があり、ユーザーに「Sales Engagement ユーザー」または「Sales Engagement ケイデンス作成者」権限セットが必要です。この項目値には、ListEmail オブジェクトまたは Sales Engagement ケイデンスで送信されたメールが含まれます。

UIType
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
このテンプレートを使用可能なユーザーインターフェースを示します。
可能な値は次のとおりです。
  • Aloha
  • SFX
  • SFX_Sample — SFXSample

使用方法

このオブジェクトを取得するには、オブジェクトに記述用のコール (describe) を発行し、オブジェクトが作成されたあと、各活動のクエリ結果を返します。これらのレコードは照会できません。

関連付けられたオブジェクト

このオブジェクトには次の関連するオブジェクトがあります。API バージョンが指定されていない場合、これらはこのオブジェクトと同じ API バージョンで使用できます。指定されている場合、指定された API バージョン以降で使用できます。

EmailTemplateChangeEvent (API バージョン 48.0)
このオブジェクトには変更イベントを利用できます。