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

Popular posts from this blog

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 https://docs.microsoft.com/en-us/graph/throttling#outlook-service-limits . 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
Read more

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

Disabling and Enabling POP3 and IMAP protocol settings via ADSI

  When you install Exchange and create all your mailboxes by default every mailbox will have POP3,IMAP and HTTP protocols enabled. Good practice is if you don't want people to use these protocols is just disable the protocols on the server which makes the user account settings redundant. But this is not always possible and sometimes you need to leave POP3 and IMAP access enabled for some applications or clients. So to stop people using POP3 and IMAP it can be a good idea to disable that protocol on their Active Directory user account.   To do this via ADSI is not that hard if you keep the following things in mind. The property that controls both these setting is the protocolSettings attribute of the User object. This is a mutli-valued property which also holds the setting for HTTP (OWA Access) as well.  By default this property will be blank meaning everything is enabled. Once you disable a protocol a value will get written for that protocol into the property. If you then re-en
Read more
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.