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 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

Popular posts from this blog

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 https://mydom-my.sharepoint.com/personal/gscales_domain_com/Documents/Email%20attachments/filename.txt 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 ' https://mydom-my.sharepoint.com/personal/gscales_domain_com/Documents/Email%20attachments/filena

A walk-though using the Graph API Mailbox reports in Powershell

Quite recently the Reporting side of the Graph API has moved in GA from beta, there are quite a number of reports that can be run across various Office365 surfaces but in this post I'm going to focus on the Mailbox related ones. Accessing Office365 Reports using Powershell is nothing new and has been available in the previous reporting endpoint  https://msdn.microsoft.com/en-us/library/office/jj984326.aspx however from the end of January many of these cmdlets are now being depreciated in favour of the Graph API  https://msdn.microsoft.com/en-us/library/office/dn387059.aspx . Prerequisites  In comparison to using the Remote PowerShell cmdlets where only the correct Office365 Admin permissions where needed, to use the new Graph API reports endpoint you need to use OAuth for authentication so this requires an Application Registration  https://developer.microsoft.com/en-us/graph/docs/concepts/auth_overview  that is then given the correct oAuth Grants to use the Reports EndPoin

How to test SMTP using Opportunistic TLS with Powershell and grab the public certificate a SMTP server is using

Most email services these day employ Opportunistic TLS when trying to send Messages which means that wherever possible the Messages will be encrypted rather then the plain text legacy of SMTP.  This method was defined in RFC 3207 "SMTP Service Extension for Secure SMTP over Transport Layer Security" and  there's a quite a good explanation of Opportunistic TLS on Wikipedia  https://en.wikipedia.org/wiki/Opportunistic_TLS .  This is used for both Server to Server (eg MTA to MTA) and Client to server (Eg a Message client like Outlook which acts as a MSA) the later being generally Authenticated. Basically it allows you to have a normal plain text SMTP conversation that is then upgraded to TLS using the STARTTLS verb. Not all servers will support this verb so if its not supported then a message is just sent as Plain text. TLS relies on PKI certificates and the administrative issue s that come around certificate management like expired certificates which is why I wrote th
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.