Skip to main content

Using the Office365/Exchange 2016 REST API in Powershell Contacts

Within a Mailbox from an API perspective the big 3 things you deal with are first Messaging, second Calendaring and then Contacts. Up until now I've had just some basic support for Contacts in the Exch-Rest module but from version 3.4 I've add lot more cmdlets to fill out this functionally. I've taken a guide from my EWSContacts Module and taken advantage of some of the new stuff you can do with the Graph API which was hard or not possible in EWS like getting Mail Enabled Contacts (AD Contacts).

I've added a documentation page with Examples on GitHub for most of the new cmdlets

To give a little taste of what you can do with these new cmldets

Creating Contacts

The New-EXRContact cmdlet can be used to create a contact in any mailbox specifying the most common properties
New-EXRContact -MailboxName -FirstName "FirstName" -LastName "Surname of Contact" -EmailAddress "" -MobilePhone 1111-222-333
If you want to also upload a photo as part of the contact you can use -photo switch to specify a file-name that contains the contact photo you want to be used for that contact eg
New-EXRContact -MailboxName -FirstName "FirstName" -LastName "Surname of Contact" -EmailAddress "" -MobilePhone 1111-222-333 -photo 'c:\photo\Johnsmith.jpg'
To create a contact in a contact Folder other then the default in the Mailbox use
New-EXRContact -MailboxName -FirstName "FirstName" -LastName "Surname of Contact" -EmailAddress "" -MobilePhone 1111-222-333 -ContactFolder SubContactFolder
Modifying existing Contacts

Eg modifying the department filed of an existing contact first find the contact based on the Email address and then update the Department field
$ExistingContact = Search-EXRContacts -MailboxName user@domain -emailaddressKQL ''
Set-EXRContact -Id $ -Department "New Department"
Uploading a Contact Photo of an existing contact
$ExistingContact= Search-EXRContacts -MailboxName user@domain -emailaddressKQL ''
Set-EXRContactPhoto -Id $ -FileName c:\photos\mycont.jpg
Export an existing Contact to a VCard

$ExistingContact = Search-EXRContacts -MailboxName user@domain -emailaddressKQL ''
Export-EXRContactToVcard -Id $ -SaveAsFileName c:\photos\mycont.vcf

Deleting a Contact 

$ExistingContact = Search-EXRContacts -MailboxName user@domain -emailaddressKQL ''
Invoke-DeleteEXRContactd -Id $
Enumerating all Contacts in a Contacts Folder

The Default Contacts folder in a Mailbox

Get-EXRContacts -MailboxName user@domain
Other Contact Folders 

Get-EXRContacts -MailboxName user@domain -ContactsFolderName FolderName

Directory (AD) Contacts

Enumerating Directory Contacts

Export a Directory Contact to Vcard

$dirContact = Get-EXRDirectoryContacts | Where-Object {$_.mail -eq ''}
Export-EXRDirectoryContactToVcard -Id $ -SaveAsFileName c:\photos\mycont.vcf

Some things that are still missing in the Graph API is the ability to manage private distribution lists which will probably come along at a later date. The source for all the new cmldets are available on GitHub

Popular posts from this blog

Export calendar Items to a CSV file using EWS and Powershell

Somebody asked about this last week and while I have a lot of EWS scripts that do access the Calendar I didn't have a simple example that just exported a list of the Calendar events with relevant information to a CSV file so here it is. I've talked on this one before in this howto  but when you query the calendar folder using EWS you need to use a CalendarView which will expand any recurring appointments in a calendar. There are some limits when you use a calendarview in that you can only return a maximum of 2 years of appointments at a time and paging will limit the max number of items to 1000 per call. So if you have a calendar with a very large number of appointments you need to break your query into small date time blocks. In this example script I'm just grabbing the next 7 days of appointments if you want to query a longer period you need to adjust the following lines (keeping in mind what I just mentioned) #Define Date to Query $StartDate = (Get-Date) $EndDate

Downloading a shared file from Onedrive for business using Powershell

I thought I'd quickly share this script I came up with to download a file that was shared using One Drive for Business (which is SharePoint under the covers) with Powershell. The following script takes a OneDrive for business URL which would look like This script is pretty simple it uses the SharePoint CSOM (Client side object Model) which it loads in the first line. It uses the URI object to separate the host and relative URL which the CSOM requires and also the SharePointOnlineCredentials object to handle the Office365 SharePoint online authentication. The following script is a function that take the OneDrive URL, Credentials for Office365 and path you want to download the file to and downloads the file. eg to run the script you would use something like ./spdownload.ps1 '

The MailboxConcurrency limit and using Batching in the Microsoft Graph API

If your getting an error such as Application is over its MailboxConcurrency limit while using the Microsoft Graph API this post may help you understand why. Background   The Mailbox  concurrency limit when your using the Graph API is 4 as per . This is evaluated for each app ID and mailbox combination so this means you can have different apps running under the same credentials and the poor behavior of one won't cause the other to be throttled. If you compared that to EWS you could have up to 27 concurrent connections but they are shared across all apps on a first come first served basis. Batching Batching in the Graph API is a way of combining multiple requests into a single HTTP request. Batching in the Exchange Mail API's EWS and MAPI has been around for a long time and its common, for email Apps to process large numbers of smaller items for a variety of reasons.  Batching in the Graph is limited to a m
All sample scripts and source code is provided by for illustrative purposes only. All examples are untested in different environments and therefore, I cannot guarantee or imply reliability, serviceability, or function of these programs.

All code contained herein is provided to you "AS IS" without any warranties of any kind. The implied warranties of non-infringement, merchantability and fitness for a particular purpose are expressly disclaimed.