Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
AttachmentRetrievalOption Enum
ActionableNotification Class
ActionableNotification.Builder Class
ActionError Enum
ActionResult Class
ActionResult.Builder Class
CustomNotification Class
Email Class (Base Email Methods)
Email Methods
EmailFileAttachment Class
InboundEmail Class
InboundEmail.AuthenticationResult Class
InboundEmail.AuthenticationResultField Class
InboundEmail.BinaryAttachment Class
InboundEmail.TextAttachment Class
InboundEmailResult Class
InboundEnvelope Class
MassEmailMessage Class
InboundEmail.Header Class
PushNotification Class
PushNotificationPayload Class
NotificationActionHandler Interface
RenderEmailTemplateBodyResult Class
RenderEmailTemplateError Class
SendEmailError Class
SendEmailResult Class
SingleEmailMessage Class
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Email Class (Base Email Methods)

Contains base email methods common to both single and mass email.

Namespace

Messaging

Usage

Sending an email by using Apex requires domain-level and user-level email verification. System-generated emails also require verification of the From email address. Email delivery fails if any of these verifications is incomplete. See Requirements to Send Email from Salesforce.

Important

If templates are not being used, all email content must be in plain text, HTML, or both.Visualforce email templates cannot be used for mass email.

Email Methods

The following are methods for Email. All are instance methods.

setBccSender(bcc)

Indicates whether the email sender receives a copy of the email that is sent. For a mass mail, the sender is only copied on the first email sent.

Signature

public Void setBccSender(Boolean bcc)

Parameters

Return Value

Type: Void

Usage

If the BCC compliance option is set at the organization ​level, the user cannot add BCC addresses on standard messages. The following error code is returned: BCC_NOT_ALLOWED_IF_BCC_ COMPLIANCE_​ENABLED. ​Contact your Salesforce representative for information on BCC compliance.

Note

setReplyTo(replyAddress)

Optional. The email address that receives the message when a recipient replies.

Signature

public Void setReplyTo(String replyAddress)

Parameters

Return Value

Type: Void

setTemplateID(templateId)

The ID of the template to be merged to create this email. Specify a value for setTemplateId, setHtmlBody, or setPlainTextBody. Or, you can define both setHtmlBody and setPlainTextBody.

Signature

public Void setTemplateID(ID templateId)

Parameters

  • templateId:

    Type: ID

Return Value

Type: Void

Usage

setHtmlBody and setPlainTextBody apply only to single email methods, not to mass email methods.

Note

setSaveAsActivity(saveAsActivity)

Optional. The default value is true, meaning the email is saved as an activity. This argument only applies if the recipient list is based on targetObjectId or targetObjectIds. If HTML email tracking is enabled for the organization, you will be able to track open rates.

Signature

public Void setSaveAsActivity(Boolean saveAsActivity)

Parameters

Return Value

Type: Void

setSenderDisplayName(displayName)

Optional. The name that appears on the From line of the email. This cannot be set if the object associated with a setOrgWideEmailAddressId for a SingleEmailMessage has defined its DisplayName field.

Signature

public Void setSenderDisplayName(String displayName)

Parameters

Return Value

Type: Void

setUseSignature(useSignature)

Indicates whether the email includes an email signature if the user has one configured. The default is true, meaning if the user has a signature it is included in the email unless you specify false.

Signature

public Void setUseSignature(Boolean useSignature)

Parameters

Return Value

Type: Void