SingleEmailMessage メソッド
名前空間
使用方法
すべての基本メール (Email クラス) メソッドは、SingleEmailMessage オブジェクトでも使用できます。
メールプロパティは読み取りと書き込みが可能です。各プロパティには対応する setter および getter メソッドがあります。たとえば、toAddresses() プロパティは、setToAddresses() および getToAddresses() メソッドに相当します。このドキュメントで説明されているのは setter メソッドのみです。
SingleEmailMessage メソッド
SingleEmailMessage のメソッドは次のとおりです。すべてインスタンスメソッドです。
setBccAddresses(bccAddresses)
署名
public Void setBccAddresses(String[] bccAddresses)
パラメータ
- bccAddresses
- 型: String[]
戻り値
型: Void
使用方法
- toAddresses
- ccAddresses
- bccAddresses
- targetObjectId
BCC コンプライアンスオプションが組織レベルで設定されている場合、ユーザは BCC アドレスを標準のメッセージに追加することができません。次のエラーコードが返されます: BCC_NOT_ALLOWED_IF_BCC_ COMPLIANCE_ENABLED。BCC コンプライアンスについては、Salesforce の担当者にお問い合わせください。
setCcAddresses(ccAddresses)
署名
public Void setCcAddresses(String[] ccAddresses)
パラメータ
- ccAddresses
- 型: String[]
戻り値
型: Void
使用方法
- toAddresses
- ccAddresses
- bccAddresses
- targetObjectId
setCharset(characterSet)
署名
public Void setCharset(String characterSet)
パラメータ
- characterSet
- 型: String
戻り値
型: Void
setDocumentAttachments(documentIds)
署名
public Void setDocumentAttachments(ID[] documentIds)
パラメータ
- documentIds
- 型: ID[]
戻り値
型: Void
使用方法
添付文書の合計が 10 MB を超えない限り、いくつでも文書を追加できます。
setFileAttachments(fileNames)
署名
public Void setFileAttachments(EmailFileAttachment[] fileNames)
パラメータ
- fileNames
- 型: Messaging.EmailFileAttachment[]
戻り値
型: Void
使用方法
添付ファイルの合計が 10 MB を超えない限り、いくつでもファイルを追加できます。
setHtmlBody(htmlBody)
署名
public Void setHtmlBody(String htmlBody)
パラメータ
- htmlBody
- 型: String
戻り値
型: Void
setInReplyTo(parentMessageIds)
署名
public Void setInReplyTo(String parentMessageIds)
パラメータ
- parentMessageIds
- 型: String
- 1 つ以上の親メールのメッセージ ID が含まれます。
戻り値
型: Void
setOptOutPolicy(emailOptOutPolicy)
署名
public void setOptOutPolicy(String emailOptOutPolicy)
パラメータ
- emailOptOutPolicy
- 型: String
-
emailOptOutPolicy パラメータの有効な値は次のとおりです。
- SEND (デフォルト) — メールはすべての受信者に���信され、受信者の [メール送信除外] オプションは無視されます。
- FILTER — [メール送信除外] オプションが設定された受信者にはメールは送信されず、それ以外の受信者にはメールが送信されます。
- REJECT — [メール送信除外] オプションが設定された受信者がいる場合、sendEmail() がエラーを発生させ、メールは送信されません。
戻り値
型: void
例
この例では、送信除外設定を適用してメールを送信する方法を示します。受信者は、その ID で指定されます。FILTER オプションにより、メール送信を除外していない受信者にのみメールが送信されます。この例では、メールプロパティのドット表記を使用しています (set メソッドの使用と同等)。
1Messaging.SingleEmailMessage message = new Messaging.SingleEmailMessage();
2// Set recipients to two contact IDs.
3// Replace IDs with valid record IDs in your org.
4message.toAddresses = new String[] { '003D000000QDexS', '003D000000QDfW5' };
5message.optOutPolicy = 'FILTER';
6message.subject = 'Opt Out Test Message';
7message.plainTextBody = 'This is the message body.';
8Messaging.SingleEmailMessage[] messages =
9 new List<Messaging.SingleEmailMessage> {message};
10 Messaging.SendEmailResult[] results = Messaging.sendEmail(messages);
11if (results[0].success) {
12 System.debug('The email was sent successfully.');
13} else {
14 System.debug('The email failed to send: '
15 + results[0].errors[0].message);
16}setPlainTextBody(plainTextBody)
署名
public Void setPlainTextBody(String plainTextBody)
パラメータ
- plainTextBody
- 型: String
戻り値
型: Void
setOrgWideEmailAddressId(emailAddressId)
署名
public Void setOrgWideEmailAddressId(ID emailAddressId)
パラメータ
- emailAddressId
- 型: ID
戻り値
型: Void
setReferences(references)
署名
public Void setReferences(String references)
パラメータ
- references
- 型: String
戻り値
型: Void
setSubject(subject)
署名
public Void setSubject(String subject)
パラメータ
- subject
- 型: String
戻り値
型: Void
setTargetObjectId(targetObjectId)
署名
public Void setTargetObjectId(ID targetObjectId)
パラメータ
- targetObjectId
- 型: ID
戻り値
型: Void
setTemplateId(templateId)
署名
public Void setTemplateId(ID templateId)
パラメータ
- templateId
- 型: ID
戻り値
型: Void
setToAddresses(toAddresses)
署名
public Void setToAddresses(String[] toAddresses)
パラメータ
- toAddresses
- 型: String[]
戻り値
型: Void
使用方法
- toAddresses
- ccAddresses
- bccAddresses
- targetObjectId
setTreatBodiesAsTemplate(treatAsTemplate)
署名
public void setTreatBodiesAsTemplate(Boolean treatAsTemplate)
パラメータ
- treatAsTemplate
- 型: Boolean
戻り値
型: void
setTreatTargetObjectAsRecipient(treatAsRecipient)
署名
public void setTreatTargetObjectAsRecipient(Boolean treatAsRecipient)
パラメータ
- treatAsRecipient
- 型: Boolean
戻り値
型: void
使用方法
setWhatId(whatId)
署名
public Void setWhatId(ID whatId)
パラメータ
- whatId
- 型: ID
戻り値
型: Void
使用方法
値は、次の型のいずれかです。
- Account
- Asset
- Campaign
- Case
- Contract
- Opportunity
- Order
- Product
- Solution
- Custom