/EWS-Office365-Contact-Sync

Uses Exchange Web Services to synchronize a Global Address List in Office 365 to a user's mailbox

Primary LanguagePowerShellMIT LicenseMIT

EWS Contact Sync

Utilizes both Exchange Web Services and Office 365 Remote PowerShell Services to sync your Global Address List to any/every user in the directory.

Why would I want to use this? iPhone/Android devices don't currently support offline Global Address List synchronization. By loading the Global Address List contacts into a folder within user's mailbox, you can circumvent this limitation.

Features

  • Fetch a list of contacts using the Office 365 Directory
  • Import the list of contacts into a specified user's Office 365 mailbox
  • You can run the sync for any number of users
  • Specify a custom contact folder
  • Authenticates using a AzureApp & certificate based authenication (See guide below)

Getting Started

  1. Install the Exchange Online Powershell V3.2.0

    Install-Module -Name ExchangeOnlineManagement -RequiredVersion 3.2.0 -Force

  2. Create an Azure app & certificate file using the tutorial here, taking note of the differences below.

    • The app will require Global Reader permission (Referenced in tutorial).
    • Take a record of the Azure app's Application (client) ID as you'll need this later.
    • Enable Public Client Flows in the Azure App (Authenication -> Allow public client flows)
    • Specify a redirect URI (Authenication -> Platform Configurations -> Add a platform -> Mobile and desktop applications -> Enable 'https://login.microsoftonline.com/common/oauth2/nativeclient' as a redirect URI.)
    • When updating the app's Manifest, insert the below code for requiredResourceAccess instead of following what the tutorial suggests. The below version also includes permissions for acting as an EWS Application. We'll need EWS to manage the contacts in each user's mailbox. 
          "requiredResourceAccess": [
    {
        "resourceAppId": "00000002-0000-0ff1-ce00-000000000000",
        "resourceAccess": [
            {
                "id": "dc50a0fb-09a3-484d-be87-e023b12c6440",
                "type": "Role"
            },
            {
                "id": "dc890d15-9560-4a4c-9b7f-a736ec74ec40",
                "type": "Role"
            }
        ]
    }
]

  3. Export your certificate password to a CliXml SecureString file. See Create-SecureCertificatePassword.ps1 in the Getting Started folder for an example on how to do this.

  4. You'll also need your Office 365 organization URL (Ends in .onmicrosoft.com). Do find this, navigate to the Office 365 Admin Center -> Setup -> Domains

  5. Download the latest version of the script here.

  6. You may need to unblock the script's included .dll files. To do this, navigate to EWSContacts\Module\bin -> For each .dll file, right click on the file -> Check 'Unblock'

  7. To test the script, run for a single mailbox in your directory. See below for an example (batch file)

    @echo off
cd "%~dp0EWS-Office365-Contact-Sync"

PowerShell.exe -ExecutionPolicy Bypass ^
-File "%CD%\EWSContactSync.ps1" ^
-CertificatePath "C:\Users\johndoe\Desktop\automation-cert.pfx" ^
-CertificatePasswordPath "C:\Users\johndoe\Desktop\SecureCertificatePassword.cred" ^
-ClientID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" ^
-FolderName "Directory Contacts" ^
-LogPath "%~dp0Logs" ^
-MailboxList john.doe@mycompany.com ^
-ExchangeOrg "mycompany.onmicrosoft.com" ^
-ModernAuth
pause

  8. Once you're ready, specify DIRECTORY for MailboxList. This will sync the contacts for all users in your directory. See below for an example (batch file)

    @echo off
cd "%~dp0EWS-Office365-Contact-Sync"

PowerShell.exe -ExecutionPolicy Bypass ^
-File "%CD%\EWSContactSync.ps1" ^
-CertificatePath "C:\Users\johndoe\Desktop\automation-cert.pfx" ^
-CertificatePasswordPath "C:\Users\johndoe\Desktop\SecureCertificatePassword.cred" ^
-ClientID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" ^
-FolderName "Directory Contacts" ^
-LogPath "%~dp0Logs" ^
-MailboxList DIRECTORY ^
-ExchangeOrg "mycompany.onmicrosoft.com" ^
-ModernAuth
pause

Prerequisites

  • Azure app with EWS and User read permissions (See above guide on how to set this up.)
  • Verify the neccessary Office 365 URLs are whitelisted in your environment. All Microsoft 365 Common URLs with ID#56 on this page should be allowed.
  • Powershell Version 5.0+
  • Think of a unique folder name (Any contacts not in the Global Address List will be deleted from the folder, so I don't recommend using 'Contacts' as the name.)

Deployment

See EWSContactSync.ps1 for documentation on optional parameters for filtering conatcts, mailboxes, etc...

Built With

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Ryan Graham - Initial work - grahamr975
  • Glenn Scales - EWSContacts Powershell Module - gscales

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments