Automatic configuration of mapping email headers to SharePoint properties

This article applies to harmon.ie version 8.2 or later.

Note: Before you begin, please read Save email headers in SharePoint.

Starting from version 8.2, harmon.ie simplified the creation of email header mapping, using two new sample PowerShell scripts.

Notes:

• The scripts require some M365 administrator knowledge and privileges.
• The scripts can be run in site collections where email header mapping was never configured (including Teams and Groups site collections).
• The Powershell scripts are provided only as a reference template, and they are not a part of the harmon.ie product.
• An administrator may change the scripts.

To configure email header mapping, follow these steps:

1. Make sure that the SharePointPnPPowerShellOnline module is installed.
2. Download and extract harmonieEmailHeaderMapping.zip to a local folder on your computer.
3. As a user with administrator privileges, run the CreateEmailType.ps1 script in each site collection you want to configure with email header mapping:
   .\CreateEmailType.ps1 [-URL <Site Url>] [-ContentType <Type name>] [-Exclude @("Col1","Col2",...)] [-Parent <Type name>], where:
   • The URL may be given as a parameter or template-commented in the script.
   • -ContentType creates a custom name for the email content type. Default name: Email.
   • -Exclude excludes specific email header from the content type. Use the Email Header name as defined in the email columns table.
   • -Parent can be used to supply the parent content type instead of the default content type.
   Example: .\CreateEmailType.ps1 -ContentType Email -Exclude @("ConversationIndex", "MailPreviewData")
   The script does the following:
   • Creates email columns in your SharePoint site, for email header mapping. SharePoint automatically creates managed properties and crawled properties for each created email column.
   • Creates an email content type with the email columns.
4. Run the AddEmailType.ps1 script, in each list or library you want to configure with email header mapping:
   .\AddEmailType.ps1 [-URL <Site Url>] [-List <Document Library>] [-ContentType <Type name>], where:
   • The URL may be given as a parameter or template-commented in the script.
   • -List adds the content type to the given document library or list. Default library: Shared Documents.
   • -ContentType adds a custom email content type. Default name: Email.
   The script adds the email content type to the SharePoint library or list you want to configure with email header mapping.
5. Re-index the SharePoint site. This process my take a few hours when run for the first time.

Notes:

• If your content type is not called Email or E-mail, you need to configure the mail content type that will be assigned to uploaded email messages.
• It is recommended to define an email view displaying the email headers, and add it to document libraries where users upload emails.
• If you wish to configure custom column names, you should provision the column names mapping using the MailHeaderMappingList key.

SharePoint columns used for email header mapping:

The CreateEmailType.ps1 script creates the following SharePoint columns:

EMAIL HEADER	SHAREPOINT PROPERTY	TYPE	DESCRIPTION
Attachments	hrmAttachments	Single line of text or Yes/No	Indicates if the email message contains attachments. The default value should be No.
Categories	hrmCategories	Multiple lines of text	Message categories.
Cc	hrmCc	Multiple lines of text	The identity of the secondary recipients of the message.
Bcc	hrmBcc	Multiple lines of text	The identity of the blind recipients of the message. This field requires setting a provisioning registry key, as explained in Saving Bcc recipients.
ConversationIndex	hrmConversationIndex	Single line of text	A unique identifier for the conversation.
ConversationTopic	hrmConversationTopic	Single line of text	The common subject of the email thread. This column facilitates creating a SharePoint view to show related emails. Read Grouping email messages for more information.
Date	hrmDate	Date and Time	The date and time when the message was sent.
From	hrmFrom	Single line of text	The address of the message sender.
Importance	hrmImportance	Single line of text	The message’s importance.
InReplyTo	hrmInReplyTo	Single line of text	The contents of this field identify previous correspondence that this message answers.
MessageID	hrmMessageID	Single line of text	A unique identifier for the message.
MessageClass	hrmMessageClass	Single line of text	The type of the item (message, appointment, post, etc.). Used to show the correct item icon. Read Assign icons to uploaded Outlook items to learn more.
MailPreviewData	hrmMailPreviewData	Multiple lines of text	Stores the message content compressed, for the Show Preview command. Read Enable email previewing to learn more.
Received	hrmReceived	Date and Time	The date and time when a message is received.
References	hrmReferences	Single line of text	The contents of this field identify other correspondence that this message answers.
ReplyTo	hrmReplyTo	Single line of text	Indicates any mailbox(es) to which responses are to be sent.
Subject	hrmSubject	Single line of text	The subject of the message.
Sensitivity	hrmSensitivity	Single line of text	The message’s sensitivity.
To	hrmTo	Multiple lines of text	The identity of the primary recipients of the message.

Note: All multiple line properties are defined as plain text.