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

EmailMessage

Salesforce のメールを表します。

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

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

特別なアクセスルール

EmailMessage は、メール-to-ケースま��は拡張メールを使用している組織でのみ使用可能です。これらは、ほとんどのお客様で自動的に有効になっています。

返信および転送機能を使用するには、EmailMessageRelation に存在するメールアドレスを FromAddress に指定し、RelationTypeFromAddress にする必要があります。

Status 項目はほとんどの場合、参照のみです。状況を New から Read に変更することのみ可能です。

HtmlBodyRelatedToId 項目は、Classic のリストビューではサポートされていますが、Lightning のリストビューではサポートされていません。Lightning Experience の関連リストや検索結果では、これらの項目が表示されなかったり、空白の値が表示されたり、エラーになったりします。

update() がサポートされるのは、メールレコードが Draft 状況で IsPrivateDraftfalse の場合です。また、メール状況が Draft で、IsPrivateDrafttrue であり、さらに CreatedBy が現在のユーザーに関連付けられている場合にもサポートされます。メールレコードが Draft ではない場合は、IsExternallyVisible 項目とカスタム項目のみを更新できます。

ユーザー (メールメッセージ関連レコードを変更する自動化プロセスを実行する自動ケース更新ユーザーなど) の「メールメッセージを更新」ユーザー権限を設定します。「メールメッセージを更新」権限セットがあると、ユーザーのプロセスで、[ドラフト] 状況でないメールメッセージに関連する EmailMessageRelation および ContentDocumentLink レコードを変更できます。この権限を他のユーザーに設定しないでください。

メールメッセージへのアクセス権は、関連するオブジェクトによって変わります。メールを作成したユーザーは CreatedById で指定し、そのユーザーがゲストユーザーでない限り、常にアクセス権が与えられます。IsExternallyVisible としてマークされたメッセージの場合、ゲストユーザーに参照アクセス権が与えられます。

アクセス権の判定に使用されるオブジェクトは、メール-to-ケースと拡張メールの場合では異なります。

  • メール-to-ケース - メール-to-ケースが有効で、メールがケースに基づく (ParentId 項目が Case) 場合、アクセス権は関連するケースレコードへのユーザーのアクセス権に依存します。メールメッセージがドラフトの場合、CreatedById 項目のユーザー、または「すべてのデータの編集」権限を持つユーザーのみがアクセスできます。
  • 拡張メール — アクセス権は、活動に基づいて決定されます。ActivityId 項目は、関連付けられた Task レコードを指定します。活動に基づいたオブジェクトへのアクセス権は、「活動へのアクセス」権限で制御できます。「すべてのデータの編集」権限を持つユーザーはメッセージにもアクセスできます。

API を使用して EmailMessage レコードを一括挿入する場合、同じアクセス権のルールが適用されます。アクセス権は ParentId 項目のケースまたは ActivityId 項目のタスクに基づきます。1 つのレコードを挿入する場合、CreatedById 項目は、操作を行ったユーザーを設定するか空白にしてください。

項目

項目 詳細
ActivityId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
メールに関連付けられている活動の ID。通常、読み取られていない新しいメールメッセージが受信された場合にケース所有者に対して作成される進行中の ToDo を表します。ケースのメールに対してのみ ActivityId を指定できます。他のエンティティではこれは自動作成されます。
BccAddress
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
視覚障害者���けのメールメッセージの CC が送信された受信者のメールアドレスの文字列配列。Salesforce の取引先責任者、リード、またはユーザーレコードに関連付けらていないメールアドレスのみを含めます。受信者が取引先責任者、リード、またはユーザーの場合、そのメールアドレスを BccAddress 項目に追加するのではなく、ID を BccIds 項目に追加します。ID を追加すると、メールメッセージが自動的に取引先責任者、リード、またはユーザーに関連付けられます。Experience Cloud サイトユーザーがメールの送信者ではない場合、この項目は null を返します。
少なくとも 1 人の受信者がいない限り、メールを送信できません。
BccIds
JunctionIdList
プロパティ
Create、Update
説明
視覚障害者向けのメールメッセージの CC が送信された取引先責任者、リード、およびユーザーの ID の文字列配列。各 ID は EmailMessageRelation レコードにリンクされます。このレコードは、メールメッセージと取引先責任者、リード、またはユーザーレコード間のリレーションを表します。Experience Cloud サイトユーザーがメールの送信者ではない場合、このリストは空です。

JunctionIdList 項目名を fieldsToNull プロパティに追加すると、関連するすべての連結レコードが削除されます。このアクションは元に戻すことができません。

CcAddress
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
メールメッセージの CC が送信された受信者のメールアドレスの文字列配列。Salesforce の取引先責任者、リード、またはユーザーレコードに関連付けらていないメールアドレスのみを含めます。受信者が取引先責任者、リード、またはユーザーの場合、そのメールアドレスを CcAddress 項目に追加するのではなく、ID を CcIds 項目に追加します。そうすることで、メールメッセージが自動的に取引先責任者、リード、またはユーザーに関連付けられます。
少なくとも 1 人の受信者がいない限り、メールを送信できません。
CcIds
JunctionIdList
プロパティ
Create、Update
説明
メールメッセージの CC が送信された取引先責任者、リード、およびユーザーの ID の文字列配列。各 ID は EmailMessageRelation レコードにリンクされます。このレコードは、メールメッセージと取引先責任者、リード、またはユーザーレコード間のリレーションを表します。

JunctionIdList 項目名を fieldsToNull プロパティに追加すると、関連するすべての連結レコードが削除されます。このアクションは元に戻すことができません。

ClientThreadIdentifier
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
メールが属するスレッドを識別するサードパーティメールクライアントで使用される値。詳細は、「メール-to-ケースのスレッド」を参照してください。

API バージョン 56.0 以降で利用できます。

ContentDocumentIds
JunctionIdList
プロパティ
Create、Update
説明
メールに関連付けられたファイルや添付ファイルなどのコンテンツドキュメントの ID の文字列配列。ID はそれぞれ ContentDocumentLink レコードにリンクされます。このレコードはメールメッセージとコンテンツドキュメントレコード間のリレーションを表します。

JunctionIdList 項目名を fieldsToNull プロパティに追加すると、関連するすべての連結レコードが削除されます。このアクションは元に戻すことができません。

Division
picklist
プロパティ
Defaulted on create、Filter、Group、Restricted picklist、Sort
説明
組織のデータの論理セグメントです。たとえば、会社がさまざまな事業単位によって構成されている場合、「北米」、「ヘルスケア」、「コンサルティング」など、各事業単位のディビジョンを作成することができます。組織でディビジョン権限が有効化されている場合にのみ使用可能です。
EmailTemplateId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
メールに選択されたメールテンプレート (存在する場合)。この項目は、Lightning Experience でのみ入力されます。
これはリレーション項目です。
リレーション名
EmailTemplate
リレーション種別
Lookup
参照先
EmailTemplate
FirstOpenedDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
メールが最初に開封された日付。

この項目を表示するには、組織でメール追跡を有効にします。

FromAddress
email
プロパティ
Create、Filter、Nillable、Sort、Update
説明
メールが作成されたアドレス。この項目を使用する場合、EmailMessageRelation に存在するメールアドレスを指定し、RelationTypeFromAddress にします。
FromName
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
送信者の名前。この項目を使用する場合、EmailMessageRelation に存在するメールアドレスを指定し、RelationTypeFromAddress にします。
HasAttachment
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
メールがファイルを添付して送信されたか (true)、否か (false) を示します。
Headers
textarea
プロパティ
Create、Nillable、Update
説明
受信メールのインターネットメッセージのヘッダー。デバッグおよび追跡の目的で使用されます。送信メールには適用されません。
HtmlBody
textarea
プロパティ
Create、Nillable、Update
説明
メールの本文 (HTML 形式)。
次の少なくとも 1 つの項目にコンテンツが含まれない限り、メールを送信できません。
  • [件名] 項目
  • [HTML 内容] または [テキスト内容] 項目
送信者はコンテンツを提供できます。また、定義済みの値を使用してコンテンツを自動的に挿入することもできます。メールテンプレートにこれらの項目のコンテンツを含めることもできます。
Incoming
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort
説明
メールが受信されたか (true)、送信されたか (false) を示します。
IsBounced
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
メールがバウンスしたかどうかを示します。

Lightning スレッドを使用している組織のバウンスメールでは、この項目は True に設定されます。参照 ID スレッドを使用している組織では、True に設定されません。

この項目を表示するには、組織で不達管理を有効にします。

IsClientManaged
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort
説明
IsClientManagedtrue に設定されて EmailMessage が作成された場合、EmailMessage の StatusDraft に設定されていない場合でも、ユーザーは EmailMessage.ContentDocumentIds を変更して添付ファイルをリンクできます。この項目が true に設定され、拡張メールが有効になっている場合、メール-to-ケースの設定に関係なく、EmailMessage に対してタスクレコードが作成されます。
IsDeleted
boolean
プロパティ
Defaulted on create、Filter
説明
オブジェクトがごみ箱に移動したか (true)、否か (false) を示します。表示ラベルは Deleted です。
IsExternallyVisible
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
Experience Cloud サイトのケースフィードが有効化されている場合、IsExternallyVisible によってサイトでのメールの外部表示が制御されます。IsExternallyVisible がデフォルト値の true に設定されている場合、外部ユーザーはケースフィードでメールを参照できます。
  • この項目が true に設定されているかどうかにかかわらず、[メール] 関連リストにはメールが表示されます。必要に応じて、この関連リストを外部コミュニティユーザー用のケースページレイアウトから削除できます。
  • ParentId 項目に値があるメールのみをサイトで外部表示できます。
  • メールの StatusDraft に設定されている場合、この項目は更新できません。
IsOpened
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
メールが開封されたかどうかを示します。

この項目を表示するには、組織でメール追跡を有効にします。

IsPrivateDraft
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort
説明
IsPrivateDrafttrue に設定されている場合、CreatedById ユーザーのみがこのメールドラフトを表示、更新、および送信できます。IsPrivateDraftfalse に設定されている場合、ケースで作業するための権限を持つすべてのユーザーがこのドラフトを表示できます。メールが送信されると、この項目は false に更新されます。公開ドラフトは Salesforce Classic に読み込まれて表示されますが、非公開ドラフトは Lightning Experience でのみ使用されます。
IsTracked
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
メールが追跡されているかどうかを示します。

この項目を表示するには、組織でメール追跡を有効にします。

LastOpenedDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
メールが最後に開封された日付。

この項目を表示するには、組織でメール追跡を有効にします。

MessageDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
メールが作成された日付。
受信メールの場合、この項目は日付ヘッダーを使用してメール-to-ケースで設定されます。日付ヘッダーはメールクライアントによって設定され、送信者の時間設定が適用されます。
MessageIdentifier
string
プロパティ
Create、Filter、Group、idLookup、Nillable、Sort、Update
説明
メールメッセージの ID。
Name
string
プロパティ
Filter、Group、idLookup、Sort
説明
[件名] 項目の最初の 255 文字から取得されるメールメッセージの名前。[件名] 項目が空の場合、[No Subject] のローカライズされた文字列が使用されます。この項目は参照のみで作成または更新できません。API バージョン 56.0 以降で利用できます。
ParentId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
メールに関連付けられたケースの ID。
これはリレーション項目です。
リレーション名
Parent
リレーション種別
Lookup
参照先
Case
RelatedToId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明

RelatedToId は、取引先、商談、キャンペーン、ケース、カスタムオブジェクトなど、人以外のオブジェクトを表します。RelatedToIds は多態的です。多態的とは、RelatedToId が関連オブジェクトの ID に相当することを意味します。

RelatedToId にアクセスするには、「参照先」の下にリストされた 1 つ以上のエンティティへのアクセス権が必要です。

これは多態的なリレーション項目です。
リレーション名
RelatedTo
リレーション種別
Lookup
参照先
Account、Accreditation、AssessmentIndicatorDefinition、AssessmentTask、AssessmentTaskContentDocument、AssessmentTaskDefinition、AssessmentTaskOrder、Asset、AssetRelationship、AssignedResource、Award、BoardCertification、BusinessLicense、BusinessMilestone、BusinessProfile、Campaign、CareBarrier、CareBarrierDeterminant、CareBarrierType、CareDeterminant、CareDeterminantType、CareDiagnosis、CareInterventionType、CareMetricTarget、CareObservation、CareObservationComponent、CarePgmProvHealthcareProvider、CarePreauth、CarePreauthItem、CareProgram、CareProgramCampaign、CareProgramEligibilityRule、CareProgramEnrollee、CareProgramEnrolleeProduct、CareProgramEnrollmentCard、CareProgramGoal、CareProgramProduct、CareProgramProvider、CareProgramTeamMember、CareProviderAdverseAction、CareProviderFacilitySpecialty、CareProviderSearchableField、CareRegisteredDevice、CareRequest、CareRequestDrug、CareRequestExtension、CareRequestItem、CareSpecialty、CareSpecialtyTaxonomy、CareTaxonomy、Case、CommSubscriptionConsent、ContactEncounter、ContactEncounterParticipant、ContactRequest、Contract、CoverageBenefit、CoverageBenefitItem、CreditMemo、DelegatedAccount、DocumentChecklistItem、EnrollmentEligibilityCriteria、HealthcareFacility、HealthcareFacilityNetwork、HealthcarePayerNetwork、HealthcarePractitionerFacility、HealthcareProvider、HealthcareProviderNpi、HealthcareProviderSpecialty、HealthcareProviderTaxonomy、IdentityDocument、Image、IndividualApplication、Invoice、ListEmail、Location、MemberPlan、Opportunity、Order、OtherComponentTask、PartyConsent、PersonLifeEvent、PlanBenefit、PlanBenefitItem、ProcessException、Product2、ProductItem、ProductRequest、ProductRequestLineItem、ProductTransfer、PurchaserPlan、ReceivedDocument、ResourceAbsence、ReturnOrder、ReturnOrderLineItem、ServiceAppointment、ServiceResource、Shift、Shipment、ShipmentItem、Solution、Visit、VisitedParty、VolunteerProject、WorkOrder、WorkOrderLineItem
ReplyToEmailMessageId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
現在のメールメッセージの返信先である受信または送信メールメッセージの ID。StatusDraft であるメッセージに返信することはできません。
これはリレーション項目です。
これは、設定時にケース関連メールの返信にのみ設定されます。
リレーション名
ReplyToEmailMessage
リレーション種別
Lookup
参照先
EmailMessage
Status
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
メールの状況。

Status 項目はほとんどの場合、参照のみです。状況を New から Read に変更することのみ���能です。

可能な値は次のとおりです。
  • 0 (新規)
  • 1 (既読)
  • 2 (返信済み)
  • 3 (送信済み)
  • 4 (転送済み)
  • 5 (下書き)
ケースの一部として送信されないメールでは、3 (送信済み) のみが有効です。
Subject
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
メールの件名行。
次の少なくとも 1 つの項目にコンテンツが含まれない限り、メールを送信できません。
  • [件名] 項目
  • [HTML 内容] または [テキスト内容] 項目
送信者はコンテンツを提供できます。また、定義済みの値を使用してコンテンツを自動的に挿入することもできます。メールテンプレートにこれらの項目のコンテンツを含めることもできます。
TextBody
textarea
プロパティ
Create、Nillable、Update
説明
メールの本文 (平文テキスト形式)。TextBody が設定されていない場合、HtmlBody から抽出されます。
次の少なくとも 1 つの項目にコンテンツが含まれない限り、メールを送信できません。
  • [件名] 項目
  • [HTML 内容] または [テキスト内容] 項目
送信者はコンテンツを提供できます。また、定義済みの値を使用してコンテンツを自動的に挿入することもできます。メールテンプレートにこれらの項目のコンテンツを含めることもできます
ThreadIdentifier
string
プロパティ
Create、Filter、Group、idLookup、Nillable、Sort、Update
説明
メールメッセージが属しているメールスレッドの ID。
ToAddress
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
メールメッセージが送信された受信者のメールアドレスの文字列配列。Salesforce の取引先責任者、リード、またはユーザーレコードに関連付けらていないメールアドレスのみを含めます。受信者が取引先責任者、リード、またはユーザーの場合、そのメールアドレスを ToAddress 項目に追加するのではなく、ID を ToIds 項目に追加します。そうすることで、メールメッセージが自動的に取引先責任者、リード、またはユーザーに関連付けられます。
少なくとも 1 人の受信者がいない限り、メールを送信できません。
ToIds
JunctionIdList
プロパティ
Create、Update
説明
メールメッセージの CC が送信された取引先責任者、リード、およびユーザーの ID の文字列配列。各 ID は EmailMessageRelation レコードにリンクされます。このレコードは、メールメッセージと取引先責任者、リード、またはユーザーレコード間のリレーションを表します。

JunctionIdList 項目名を fieldsToNull プロパティに追加すると、関連するすべての連結レコードが削除されます。このアクションは元に戻すことができません。

ValidatedFromAddress
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
送信者のアドレス、メールが作成された検証済みの組織の共有メールアドレス、またはメール-to-ケースのルーティングアドレスが含まれる選択リスト値。

ValidatedFromAddress は、Group By または Sort By ステートメントでの使用には適していません。代わりに FromAddress を使用します。

使用方法

組織でメール-to-ケースを使用している場合、メールが会社のアドレスのいずれかに送信されるとケースが作成されます。メールは、ParentID 項目によってケースに関連付けられ、EmailMessage レコードに保存されます。ユーザーがメールを参照すると、EmailMessage レコードが表示されます。

組織で拡張メールを使用している場合、各メールは EmailMessage レコードおよび ToDo レコードとして保存されます。ユーザーがメールを参照すると、EmailMessage レコードが表示されます。

サンプルコード — Apex

このサンプルログでは、Salesforce での活動をメールで送信します。

1// if EnhancedEmail Perm is not enabled, continue logging the email as a task
2
3// if EnhancedEmail Perm is enabled, create an EmailMessage object
4EmailMessage emailMessage = new EmailMessage();
5emailMessage.status = '3'; // email was sent
6emailMessage.relatedToId = '006B0000003weZGIAY'; // related to record e.g. an opportunity
7emailMessage.fromAddress = 'sender@example.com'; // from address
8emailMessage.fromName = 'Dan Perkins'; // from name
9emailMessage.subject = 'This is the Subject!'; // email subject
10emailMessage.htmlBody = '<html><body><b>Hello</b></body></html>'; // email body
11// Contact, Lead or User Ids of recipients
12String[] toIds = new String[]{'003B000000AxcEjIAJ'}; 
13emailMessage.toIds = toIds;
14// additional recipients who don’t have a corresponding contact, lead or user id in the Salesforce org (optional)
15emailMessage.toAddress = 'emailnotinsalesforce@toexample.com, anotherone@toexample.com';
16insert emailMessage; // insert
17
18// Add Email Message Relation for id of the sender
19EmailMessageRelation emr = new EmailMessageRelation();
20emr.emailMessageId = emailMessage.id;
21emr.relationId = '005B0000003qHvOIAU'; // user id of the sender
22emr.relationType = 'FromAddress';
23insert emr;

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

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

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