DmlOptions.EmailHeader Class

Enables setting email options.

Database

Even though auto-sent emails can be triggered by actions in the Salesforce user interface, the DMLOptions settings for emailHeader take effect only for DML operations carried out in Apex code.

In the following example, the triggerAutoResponseEmail option is specified:

Suppose that you use an after-insert or after-update trigger to change ownership of leads, contacts, or opportunities. If you use the API to change record ownership, or if a Lightning Experience user changes a record’s owner, no email notification is sent. To send email notifications to a record’s new owner, set the triggerUserEmail property to true.

The following are properties for DmlOptions.EmailHeader.

  • triggerAutoResponseEmail

    Indicates whether to trigger auto-response rules (true) or not (false), for leads and cases.

  • triggerOtherEmail

    Indicates whether to trigger email outside the organization (true) or not (false).

  • triggerUserEmail

    Indicates whether to trigger email that is sent to users in the organization (true) or not (false).

Indicates whether to trigger auto-response rules (true) or not (false), for leads and cases.

public Boolean triggerAutoResponseEmail {get; set;}

Type: Boolean

This email can be automatically triggered by a number of events, for example creating a case or resetting a user password. If this value is set to true, when a case is created, if there is an email address for the contact specified in ContactID, the email is sent to that address. If not, the email is sent to the address specified in SuppliedEmail

Indicates whether to trigger email outside the organization (true) or not (false).

public Boolean triggerOtherEmail {get; set;}

Type: Boolean

This email can be automatically triggered by creating, editing, or deleting a contact for a case.

Email sent through Apex because of a group event includes additional behaviors. A group event is an event for which IsGroupEvent is true. The EventAttendee object tracks the users, leads, or contacts that are invited to a group event. Note the following behaviors for group event email sent through Apex:

  • Sending a group event invitation to a lead or contact respects the triggerOtherEmail option
  • Email sent when updating or deleting a group event also respects the triggerUserEmail and triggerOtherEmail options, as appropriate

Indicates whether to trigger email that is sent to users in the organization (true) or not (false).

public Boolean triggerUserEmail {get; set;}

Type: Boolean

This email can be automatically triggered by a number of events; resetting a password, creating a new user, or creating or modifying a task.

Adding comments to a case in Apex doesn’t trigger email to users in the organization even if triggerUserEmail is set to true.

Email sent through Apex because of a group event includes additional behaviors. A group event is an event for which IsGroupEvent is true. The EventAttendee object tracks the users, leads, or contacts that are invited to a group event. Note the following behaviors for group event email sent through Apex:

  • Sending a group event invitation to a user respects the triggerUserEmail option
  • Email sent when updating or deleting a group event also respects the triggerUserEmail and triggerOtherEmail options, as appropriate