Configuring the global opt-out list
You must define a global opt-out list for each manager root in EXM to list users who unsubscribed from all mailings.
If a recipient clicks the Unsubscribe from all link in an email message or marks the email message as spam, or if a hard bounce is registered for a recipient, the recipient is added to the manager root's specified global opt-out list and thereby excluded from email messages.
Every time an email message is sent, the Email Experience Manager (EXM) checks the specified global opt-out list to make sure that if any of the included recipients appear in that list, they do not receive an email message.
When you specify the Default settings, you must specify the global opt-out list for each manager root.
Note
The global opt-out list can only be a static contact list and not a segmented list.
When you create a new manager root, the Common Global Opt-out list is automatically specified as the default global opt-out list for the new manager root. You can change this in the Default settings dialog box.
EXM also uses the Common Global Opt-out list if the manager root is misconfigured when the global opt-out list is requested, for example, when you open the Default settings dialog box.
You can specify your default global opt-out list in the Sitecore.EmailExperience.ContentManagement.config file, in the StandardMessages.DefaultGlobalOptOutList setting:
<!--Specifies the path of the default global opt-out contact list.--> <setting name="StandardMessages.DefaultGlobalOptOutList" value="/sitecore/system/List Manager/All Lists/E-mail Campaign Manager/System/Common Global Opt-out" />
Note
EXM creates the Common Global Opt-out list automatically when it is requested. However, the module does not create the whole path. If you want to change the configuration settings, you must ensure that the folder structure that you specify exists in the content tree.
Implementation details
The ManagerRoot class has the GlobalSubscription property that contains an object of the GlobalSubscription type. This object can interact with the global opt-out list using the following methods:
AddToDefaultExcludeCollection()– adds recipients to the default global opt-out list.RemoveFromDefaultExcludeCollection()– removes recipients from the default global opt-out list.IsInDefaultExcludeCollection()– checks whether a recipient is in the default global opt-out list.IsInAnyExcludeCollection()– checks whether a recipient is in any of the global opt-out lists.GetAllExcludeCollections()– retrieves a collection of all the global opt-out lists.Note
The
IsInAnyExcludeCollection()andGetAllExcludeCollections()methods are intended for processing multiple global opt-out lists. EXM 3.1 supports a single global opt-out list. Therefore, in this version of the module, the methods only read the default global opt-out list.