Friday, March 23, 2018

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 https://www.powershellgallery.com/packages/Exch-Rest 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 https://github.com/gscales/Exch-Rest/blob/master/Samples/ContactsExamples.md

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 mec@datarumble.com -FirstName "FirstName" -LastName "Surname of Contact" -EmailAddress "EmailAddress@domain.com" -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 mec@datarumble.com -FirstName "FirstName" -LastName "Surname of Contact" -EmailAddress "EmailAddress@domain.com" -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 mec@datarumble.com -FirstName "FirstName" -LastName "Surname of Contact" -EmailAddress "EmailAddress@domain.com" -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 'myaddress@domain.com'
Set-EXRContact -Id $ExistingContact.id -Department "New Department"
Uploading a Contact Photo of an existing contact
$ExistingContact= Search-EXRContacts -MailboxName user@domain -emailaddressKQL 'myaddress@domain.com'
Set-EXRContactPhoto -Id $ExistingContact.id -FileName c:\photos\mycont.jpg
Export an existing Contact to a VCard

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

Deleting a Contact 

$ExistingContact = Search-EXRContacts -MailboxName user@domain -emailaddressKQL 'myaddress@domain.com'
Invoke-DeleteEXRContactd -Id $ExistingContact.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

Get-EXRDirectoryContacts
Export a Directory Contact to Vcard


$dirContact = Get-EXRDirectoryContacts | Where-Object {$_.mail -eq 'glenscales@yahoo.com'}
Export-EXRDirectoryContactToVcard -Id $ExistingContact.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 https://github.com/gscales/Exch-Rest/tree/master/functions/contacts

No comments: