1. Contacts

Email addresses facet

Version:

Format in Sitecore 8.x

In Sitecore 8.x, email addresses are associated with a contact through a property on the contact. The name of the property is Emails.

The following is an example the Emails property on the contact:

"Emails" : {
    "Preferred" : "work",
    "Entries" : {
        "work" : {
            "SmtpAddress" : "[email protected]",
            "BounceCount" : 0
        },
        "home" : {
            "SmtpAddress" : "[email protected]",
            "BounceCount" : 0
        }
    }
}

The Entries property is a dictionary. Each member of the dictionary has a key and a value. The key describes the email address. The value is an object that contains the details of the email address.

In addition to the Entries property, the Emails object has another property named Preferred. The value is the key for one of the email addresses.

Format in Sitecore 9

In Sitecore 9, email addresses are associated with a contact through a contact facet:

Facet NameEmails
Facet TypeSitecore.XConnect.Collection.Model.EmailAddressList

in Sitecore 9, the preferred email address is stored separate from the other email addresses, unlike in Sitecore 8.x where all email addresses are stored in a single dictionary.

Facet PropertyDescription
PreferredEmailObject that represents the preferred email address
PreferredKeyKey for the preferred email address
OthersDictionary that contains all other email addresses associated with the contact

Mapping email address properties

Source objectMember of the dictionary located at Emails.Entries on the contact document
Target objectSitecore.XConnect.Collection.Model.EmailAddress
Mapping definitionMongoDB to xConnect Contact Mappings > MongoDB Email to xConnect Contact Email Address
Value to write to target objectProperty on target object
BounceCount from source objectBounceCount
SmtpAddress from source objectSmtpAddress
falseValidated
If you have suggestions for improving this article, let us know!