DmlOptions.EmailHeader Class

Enables setting email options.

Namespace

Database

Usage

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.

Example

In the following example, the triggerAutoResponseEmail option is specified:
Account a = new Account(name='Acme Plumbing');

insert a;

Contact c = new Contact(email='jplumber@salesforce.com', firstname='Joe',lastname='Plumber', accountid=a.id);

insert c;

Database.DMLOptions dlo = new Database.DMLOptions();

dlo.EmailHeader.triggerAutoResponseEmail = true;

Case ca = new Case(subject='Plumbing Problems', contactid=c.id);

database.insert(ca, dlo);

DmlOptions.EmailHeader Properties

The following are properties for DmlOptions.EmailHeader.

triggerAutoResponseEmail

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

Signature

public Boolean triggerAutoResponseEmail {get; set;}

Property Value

Type: Boolean

Usage

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

triggerOtherEmail

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

Signature

public Boolean triggerOtherEmail {get; set;}

Property Value

Type: Boolean

Usage

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

Note

Note

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

triggerUserEmail

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

Signature

public Boolean triggerUserEmail {get; set;}

Property Value

Type: Boolean

Usage

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

Note

Note

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

Note

Note

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