Developer Messaging

EWS Script to automatically generate registry keys to enable Custom Forms in Outlook

Akashb — Tue, 14 Nov 2017 21:08:05 GMT

As you know Custom form script is now disabled by default and you will need to create a set of registry keys as outlined in this KB. We have had a few customers who have a lot of custom forms published in the Organizational Forms Library and it can be painful to get the message class of each of those form and then create the registry entries. The script below iterates through all the forms published in the Organizational Forms Library and then generates the required set of registry keys. This is a PowerShell script that uses EWS Managed API Ver 2.2 to access the Organizational Forms Library and generate the registry keys. This script will need to be run with credentials of a user that has access to the Organizational Forms Library.

#

# DumpMessageClassforForms.ps1

#

# By Akash Bhargava, Microsoft Ltd. 2017. Use at your own risk.  No warranties are given.

# Thank you David for the Template

# DISCLAIMER:

# THIS CODE IS SAMPLE CODE. THESE SAMPLES ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.

# MICROSOFT FURTHER DISCLAIMS ALL IMPLIED WARRANTIES INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR OF FITNESS FOR

# A PARTICULAR PURPOSE. THE ENTIRE RISK ARISING OUT OF THE USE OR PERFORMANCE OF THE SAMPLES REMAINS WITH YOU. IN NO EVENT SHALL

# MICROSOFT OR ITS SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS,

# BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE THE

# SAMPLES, EVEN IF MICROSOFT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. BECAUSE SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION

# OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE LIMITATION MAY NOT APPLY TO YOU.

param (

    [Parameter(Mandatory=$False,HelpMessage="Username used to authenticate with EWS")]

    [string]$AuthUsername,

    [Parameter(Mandatory=$False,HelpMessage="Password used to authenticate with EWS")]

    [string]$AuthPassword,

    [Parameter(Mandatory=$False,HelpMessage="Domain used to authenticate with EWS")]

    [string]$AuthDomain,

    [Parameter(Mandatory=$False,HelpMessage="EWS Url (if omitted, then autodiscover is used)")]

    [string]$EwsUrl,

    [Parameter(Mandatory=$False,HelpMessage="Path to managed API (if omitted, a search of standard paths is performed)")]

    [string]$EWSManagedApiPath = "",

    [Parameter(Mandatory=$False,HelpMessage="Whether to ignore any SSL errors (e.g. invalid certificate)")]

    [switch]$IgnoreSSLCertificate,

    [Parameter(Mandatory=$False,HelpMessage="Bitness of Outlook and Windows")]

    [string]$Bitness = "x32on64",

    [Parameter(Mandatory=$False,HelpMessage="Log file - activity is logged to this file if specified")]

    [string]$LogFile = ""

)

[string]$info = "White"                # Color for informational messages

[string]$warning = "Yellow"            # Color for warning messages

[string]$error = "Red"                 #Color for error messages

[string]$success = "Green"             # Color for success messages

[string]$LogFile = "Log.txt"   # Path of the Log File

[string]$RegFile = "CustomFormKeys.reg"   # Path of the Reg File

# Define our functions

Function Log([string]$Details, [ConsoleColor]$Colour)

{

    if ($Colour -eq $null)

    {

        $Colour = [ConsoleColor]::White

    }

    if ($verbose)

    {    Write-Host $Details -ForegroundColor $Colour }

    if ( $LogFile -eq "" ) { return    }

    (Get-Date).ToString()+" "+ $Details | Out-File $LogFile -Append

}

Function LoadEWSManagedAPI()

{

    # Find and load the managed API

    if ( ![string]::IsNullOrEmpty($EWSManagedApiPath) )

    {

        if ( Test-Path $EWSManagedApiPath )

        {

            Add-Type -Path $EWSManagedApiPath

            return $true

        }

        Write-Host ( [string]::Format("Managed API not found at specified location: {0}", $EWSManagedApiPath) ) -ForegroundColor $error

    }

    $a = Get-ChildItem -Recurse "C:\Program Files (x86)\Microsoft\Exchange\Web Services" -ErrorAction SilentlyContinue | Where-Object { ($_.PSIsContainer -eq $false) -and ( $_.Name -eq "Microsoft.Exchange.WebServices.dll" ) }

    if (!$a)

    {

        $a = Get-ChildItem -Recurse "C:\Program Files\Microsoft\Exchange\Web Services" -ErrorAction SilentlyContinue | Where-Object { ($_.PSIsContainer -eq $false) -and ( $_.Name -eq "Microsoft.Exchange.WebServices.dll" ) }

    }

    if ($a)

    {

        # Load EWS Managed API

        Write-Host ([string]::Format("Using managed API {0} found at: {1}", $a.VersionInfo.FileVersion, $a.VersionInfo.FileName)) -ForegroundColor $success

        Add-Type -Path $a.VersionInfo.FileName

        return $true

    }

    return $false

}

Function SearchOrganizationalFormsLibrary()

{

    # Set EWS URL if specified, or use autodiscover if no URL specified.

    if ($EwsUrl)

    {

        $service.URL = New-Object Uri($EwsUrl)

    }

    $LogExists = Test-Path $LogFile

    if ($LogExists){Remove-Item  $LogFile}

    $RegExists = Test-Path $RegFile

    if ($RegExists){Remove-Item  $RegFile}

    $nl = [Environment]::NewLine

    $RegFixFile = $null;

    if ($Bitness)

    {

        if ($Bitness -eq "x32on64")

        {

            $RegFixFile="Windows Registry Editor Version 5.00" + $nl + "[HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Office\16.0\Outlook\Security]" + $nl + "`"DisableCustomFormItemScript`"=dword:00000000" + $nl +

            "[HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Office\16.0\Outlook\Forms\TrustedFormScriptList]"

        }

        else

        {

            $RegFixFile="Windows Registry Editor Version 5.00" + $nl + "[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\16.0\Outlook\Security]" + $nl + "`"DisableCustomFormItemScript`"=dword:00000000" + $nl +

            "[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\16.0\Outlook\Forms\TrustedFormScriptList]"

        }

    }

        Log "Looking for Custom Forms.." $info

    #Bind to the Public Folders Root

    $PFRoot = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,[Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::PublicFoldersRoot)

    #$PFRoot

    #Get to Its Parent

    $ParentofPFRoot = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$PFRoot.ParentFolderId)

    #Folder View

    $oFolderView = new-object Microsoft.Exchange.WebServices.Data.FolderView(10)

    #Item View

    $PR_OAB_NAME = New-Object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x6800,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);

    $oItemView = New-Object Microsoft.Exchange.WebServices.Data.ItemView(500)

    $oItemView.PropertySet = New-Object Microsoft.Exchange.WebServices.Data.PropertySet(

        [Microsoft.Exchange.WebServices.Data.BasePropertySet]::IdOnly,

        [Microsoft.Exchange.WebServices.Data.ItemSchema]::Subject,

        $PR_OAB_NAME)

    $oItemView.Traversal = [Microsoft.Exchange.WebServices.Data.ItemTraversal]::Associated

    $oFindFolderResults = $service.FindFolders($ParentofPFRoot.Id,$oFolderView)

    #Now Bind to the NON_IPM_SUBTREE

    $NON_IPM_SUBTREE = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$oFindFolderResults.Folders[1].Id)

    ForEach ($subFolder in $NON_IPM_SUBTREE.FindFolders($oFolderView))

    {

        if ($subFolder.DisplayName -eq "EFORMS REGISTRY")

        {

            #Get to the "Organizational Forms Library"

            $oFindFolderResultsOFL = $service.FindFolders($subFolder.Id,$oFolderView)

            #Look at the associated contents folder..

            $results = $service.FindItems( $oFindFolderResultsOFL.Folders[0].Id, $oItemView )

            $RegFixFile | Out-File $RegFile -Append

            Log "Looping through the Messages..."

            ForEach ($item in $results.Items)

            {

                $FormMessageClass =$null;

                if ($Item.TryGetProperty($PR_OAB_NAME,[ref] $FormMessageClass))

                {

                    #Generate the RegKeys..                

                    Log([string]::Format("Creating Key for :{0}", $FormMessageClass))

                    Write-Host ([string]::Format("Creating Key for :{0}", $FormMessageClass)) -ForegroundColor $success

                    '"' + $FormMessageClass +'"'+ "=" +'"' + '"' |Out-File $RegFile -Append

                }

            }

        }

    }

    Log "Done!"

}

Function TrustAllCerts() {

    <#

    .SYNOPSIS

    Set certificate trust policy to trust self-signed certificates (for test servers).

    #>

    ## Code From https://poshcode.org/624

    ## Create a compilation environment

    $Provider=New-Object Microsoft.CSharp.CSharpCodeProvider

    $Compiler=$Provider.CreateCompiler()

    $Params=New-Object System.CodeDom.Compiler.CompilerParameters

    $Params.GenerateExecutable=$False

    $Params.GenerateInMemory=$True

    $Params.IncludeDebugInformation=$False

    $Params.ReferencedAssemblies.Add("System.DLL") | Out-Null

    $TASource=@'

        namespace Local.ToolkitExtensions.Net.CertificatePolicy {

        public class TrustAll : System.Net.ICertificatePolicy {

            public TrustAll()

            {

            }

            public bool CheckValidationResult(System.Net.ServicePoint sp,

                                                System.Security.Cryptography.X509Certificates.X509Certificate cert,

                                                System.Net.WebRequest req, int problem)

            {

                return true;

            }

        }

        }

'@

    $TAResults=$Provider.CompileAssemblyFromSource($Params,$TASource)

    $TAAssembly=$TAResults.CompiledAssembly

    ## We now create an instance of the TrustAll and attach it to the ServicePointManager

    $TrustAll=$TAAssembly.CreateInstance("Local.ToolkitExtensions.Net.CertificatePolicy.TrustAll")

    [System.Net.ServicePointManager]::CertificatePolicy=$TrustAll

}

# The following is the main script

# Check if we need to ignore any certificate errors

# This needs to be done *before* the managed API is loaded, otherwise it doesn't work consistently (i.e. usually doesn't!)

if ($IgnoreSSLCertificate)

{

    Write-Host "WARNING: Ignoring any SSL certificate errors" -foregroundColor Yellow

    TrustAllCerts

}

# Load EWS Managed API

if (!(LoadEWSManagedAPI))

{

    Write-Host "Failed to locate EWS Managed API, cannot continue" -ForegroundColor $error

    Exit

}

#Create the service Object.

$service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService([Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP1)

# Set credentials if specified, or use logged on user.

 if ($AuthUsername -and $AuthPassword)

 {

    Write-Host "Applying given Credentials for:", $AuthUsername -ForegroundColor $info

    if ($AuthDomain)

    {

        $service.Credentials = New-Object  Microsoft.Exchange.WebServices.Data.WebCredentials($AuthUsername,$AuthPassword,$AuthDomain)

    } else {

        $service.Credentials = New-Object  Microsoft.Exchange.WebServices.Data.WebCredentials($AuthUsername,$AuthPassword)

    }

} else {

    Write-Host "Using default credentials" -ForegroundColor Gray

    $service.UseDefaultCredentials = $true

 }

Write-Host ""

SearchOrganizationalFormsLibrary

By default the script will generate a .reg file for 32 bit Outlook on 64 bit Windows. If you want it for 64 bit Outlook on 64 bit Windows or 32 bit Outlook on 32 bit Windows, just specify -Bitness “x64on64” or -Bitness “x32on32” in the command like below (technically an value other than “x32on64” will work). Sample command line below: .\DumpMessageClassforForms.ps1 -AuthUsername admin –AuthPassword Pa$$w0rd –AuthDomain contoso -EwsUrl https://ex2013.contoso.com/ews/exchange.asmx -IgnoreSSLCertificate The registry file will be generated in the same folder where the script is run from. Enjoy!

[EWS]Using Oauth authentication with EWS and impersonation in Office 365

Manish Kumar - MSFT — Mon, 25 Jan 2016 11:21:11 GMT

Earlier I shared the sample script for consuming EWS using Oauth (via Azure Active Directory (AAD)) in a delegation mode. Here I’m sharing a sample PowerShell script that illustrates using Oauth authentication with EWS and impersonation to access mailboxes with an app token. The script accesses the mailboxes with email addresses presented in a text file. It then outputs the total item count in Inbox folder and prints the subject of the last five items in Inbox for each of these mailboxes. The authorization grant flow used is Client Credential grant flow and it requires the global admin to gives assent to the app. Additionally, the app must use an X.509 certificate with a public/private key pair. In this example, I’ll be using a self-issued certificate. The detailed steps for creating a self-issued certificate and uploading the details to manifest in Azure Management Portal are discussed here. Coming to permissions, since this app will be using EWS with impersonation, the app has to be provided Exchange scope permissions (Application Permissions under Office 365 Exchange Online): full_access_as_app – "Use Exchange Web Services with full access to all mailboxes”. For detailed steps related to manual app registration in AAD, please see this article. The UserAccounts.txt present in the same directory as the PowerShell script will contain the email addresses of the impersonated users as shown below:

EmailAddress

User1@domain.onmicrosoft.com

User2@domain.onmicrosoft.com

The script will need the following: 1. ADAL .NET libraries 2. EWS Managed API dll (version 2.2) 3. UserAccounts.txt file containing the email addresses as described above 4. The password required to access the X.509 certificate data 5. The certificate pfx file 6. Write permission to the directory where the EWS request and response logs will be written 7. Information related to the app you’ve registered in the Azure AD (see script for more details) There are couple of important things to note here from EWS point of view: a. Since this script is using EWS impersonation, the request must contain the ExchangeImpersonation header b. The “X-AnchorMailbox” header needs to be present with the value as the email address of the impersonated account. If the header is not present, you may get an error – “Exchange Web Services are not currently available for this request because none of the Client Access Servers in the destination site could process the request." Here is the script -

#NOTE - Disclaimer

 #Following programming examples is for illustration only, without warranty either expressed or implied,

 #including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose.

 #This sample code assumes that you are familiar with the programming language being demonstrated and the tools

 #used to create and debug procedures. This sample code is provided for the purpose of illustration only and is

 #not intended to be used in a production environment.

function GetEmailFromInbox($smtpemailaddress)

{

""

"Mailbox being accessed: " + $smtpemailaddress

""

$service.httpheaders.Add("X-AnchorMailbox", $smtpemailaddress)

$service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress,$smtpemailaddress)

$inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service, [Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox)

""

"Total Messages : " + $inbox.TotalCount

$view = New-Object Microsoft.Exchange.WebServices.Data.ItemView(5)

$findItemResults = $service.FindItems([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$view)

""

"Printing subject of last five items from Inbox:"

""

$item = [Microsoft.Exchange.WebServices.Data.Item]

$i = 1

foreach ($item in $findItemResults)

{

"Subject " + $i + ": " + $item.Subject

$i = $i + 1

""

}

$bool = $service.httpheaders.Remove("X-AnchorMailbox")

$service.ImpersonatedUserId = $null

}

$Assem = (

    "Microsoft.Exchange.WebServices, Version=15.0.0.0, Culture=neutral,  PublicKeyToken =31bf3856ad364e35" #EWS Managed API 2.2

   )

$Source = @"

using System;

using System.Text;

using Microsoft.Exchange.WebServices.Data;

public class TraceListener : Microsoft.Exchange.WebServices.Data.ITraceListener

    {

        public void Trace(string traceType, string traceMessage)

        {

            CreateXMLTextFile(traceType, traceMessage.ToString());

        }

        private void CreateXMLTextFile(string fileName, string traceContent)

        {

            //The path to the EWS request and response log. Please make sure you've write permission to the path/folder specified

            string strPath = "C:\\EWSLog.txt";

            System.IO.FileStream fs;

            if (System.IO.File.Exists(strPath) == false)

            {

                fs = System.IO.File.Create(strPath);

            }

            else

            {

                fs = System.IO.File.OpenWrite(strPath);

            }

            fs.Close();

            // Create an instance of StreamWriter to write text to a file.

            System.IO.StreamWriter sw = System.IO.File.AppendText(strPath);

            sw.WriteLine(System.DateTime.Now.ToString() + ": " + traceContent);

            sw.Close();

        }

    }

"@

Add-Type -ReferencedAssemblies $Assem -TypeDefinition $Source -Language CSharp

# Load ADAL Assemblies

$adal = "C:\Nugets\Microsoft.IdentityModel.Clients.ActiveDirectory.2.19.208020213\lib\net45\Microsoft.IdentityModel.Clients.ActiveDirectory.dll"

$adalforms = "C:\Nugets\Microsoft.IdentityModel.Clients.ActiveDirectory.2.19.208020213\lib\net45\Microsoft.IdentityModel.Clients.ActiveDirectory.WindowsForms.dll"

[System.Reflection.Assembly]::LoadFrom($adal)

[System.Reflection.Assembly]::LoadFrom($adalforms)

# Set Azure AD Tenant name (not needed here)

$adTenant = "domain.onmicrosoft.com"

# Set well-known client ID from Azure AD for this application

$clientId = "client id"

# Set redirect URI from Azure AD for this application

$redirectUri = "reply url"

# Set Resource URI to Office 365 in this case

$resourceAppIdURI = "https://outlook.office365.com/"

# Set Authority to Azure AD Tenant

#https://stackoverflow.com/questions/26384034/how-to-get-the-azure-account-tenant-id

$authority = "https://login.windows.net/<tenant-id>/oauth2/authorize"

# Create Authentication Context tied to Azure AD Tenant

$authContext = New-Object "Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext" -ArgumentList $authority

# Acquire token

#Provide the name of the certificate file

$certfile = "C:\CertPrivatekey.pfx"

$flag = [System.Security.Cryptography.X509Certificates.X509KeyStorageFlags]::MachineKeySet

#Provide the password required to access the X.509 certificate data

$cert  = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($certfile, "password", $flag )

$cac = New-Object  Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertionCertificate($clientID, $cert)

$authResult = $authContext.AcquireToken($resourceAppIdURI, $cac)

""

write-host "Access token:   " $authResult.AccessToken

# EWS

## Code From https://poshcode.org/624

## Create a compilation environment

$Provider=New-Object Microsoft.CSharp.CSharpCodeProvider

$Compiler=$Provider.CreateCompiler()

$Params=New-Object System.CodeDom.Compiler.CompilerParameters

$Params.GenerateExecutable=$False

$Params.GenerateInMemory=$True

$Params.IncludeDebugInformation=$False

$Params.ReferencedAssemblies.Add("System.DLL") | Out-Null

$TASource=@'

  namespace Local.ToolkitExtensions.Net.CertificatePolicy{

    public class TrustAll : System.Net.ICertificatePolicy {

      public TrustAll() {

      }

      public bool CheckValidationResult(System.Net.ServicePoint sp,

        System.Security.Cryptography.X509Certificates.X509Certificate cert,

        System.Net.WebRequest req, int problem) {

        return true;

      }

    }

  }

'@

$TAResults=$Provider.CompileAssemblyFromSource($Params,$TASource)

$TAAssembly=$TAResults.CompiledAssembly

## We now create an instance of the TrustAll and attach it to the ServicePointManager

$TrustAll=$TAAssembly.CreateInstance("Local.ToolkitExtensions.Net.CertificatePolicy.TrustAll")

[System.Net.ServicePointManager]::CertificatePolicy=$TrustAll

Import-Module -Name "C:\Program Files\Microsoft\Exchange\Web Services\2.2\Microsoft.Exchange.WebServices.dll"

$service = new-object Microsoft.Exchange.WebServices.Data.ExchangeService([Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2013_SP1)

$service.TraceListener = new-object TraceListener

#Set it to $false, if you want to disable this tracing

$service.TraceEnabled = $true

$service.Url = new-object System.Uri("https://outlook.office365.com/ews/exchange.asmx")

$service.Credentials  = new-object  Microsoft.Exchange.WebServices.Data.OAuthCredentials($authResult.AccessToken)

import-csv UserAccounts.txt | foreach-object {

    $EmailAddress = $_.EmailAddress.ToString()

    GetEmailFromInbox($EmailAddress)

    }

Happy scripting!

[EWS]Using Oauth authentication with EWS in Office 365

Manish Kumar - MSFT — Thu, 29 Oct 2015 11:04:47 GMT

I’m sharing a PowerShell script sample that illustrates using Oauth authentication via Azure Active Directory (AAD) and EWS to connect to Office 365 mailbox. The script outputs the total item count in Inbox folder and prints the subject of the last five items in Inbox. The authorization grant flow used is Authorization code grant flow which means the user gives assent to the app to access his own mailbox. There are couple of blogs I’m referring below that helped in putting up this script. 1. For loading Active Directory Authentication Library https://www.dushyantgill.com/blog/2013/12/27/aadgraphpowershell-a-powershell-client-for-windows-azure-ad-graph-api/ 2. Acquiring the token https://blogs.technet.com/b/keithmayer/archive/2014/12/30/authenticating-to-the-azure-service-management-rest-api-using-azure-active-directory-via-powershell-list-azure-administrators.aspx Please note that the application registered in AAD is a native client application (not a web app). For detailed steps related to manual app registration in AAD, please see this article. The permission provided is Exchange scope permissions (Delegated permissions under Office 365 Exchange Online): full_access_as_user – Access mailbox as signed in user via Exc…”

#NOTE - Disclaimer

#Following programming examples is for illustration only, without warranty either expressed or implied,

#including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose.

#This sample code assumes that you are familiar with the programming language being demonstrated and the tools

#used to create and debug procedures. This sample code is provided for the purpose of illustration only and is

#not intended to be used in a production environment.

# Load ADAL Assemblies

$adal = "C:\Nugets\Microsoft.IdentityModel.Clients.ActiveDirectory.2.19.208020213\lib\net45\Microsoft.IdentityModel.Clients.ActiveDirectory.dll"

$adalforms = "C:\Nugets\Microsoft.IdentityModel.Clients.ActiveDirectory.2.19.208020213\lib\net45\Microsoft.IdentityModel.Clients.ActiveDirectory.WindowsForms.dll"

[System.Reflection.Assembly]::LoadFrom($adal)

[System.Reflection.Assembly]::LoadFrom($adalforms)

# Set Azure AD Tenant name; not used in this script

$adTenant = "domain.onmicrosoft.com"

# Set well-known client ID from Azure AD for this application

# It is in the form of a guid 1a2b34c5-da6b-7777-ef8a-g9h001i23456

$clientId = "client-id"

# Set redirect URI from Azure AD for this application

#e.g https://myapp/reply

$redirectUri = "reply-url"

# Set Resource URI to Office 365 in this case

$resourceAppIdURI = "https://outlook.office365.com/"

# Set Authority to Azure AD Tenant

#https://stackoverflow.com/questions/26384034/how-to-get-the-azure-account-tenant-id

$authority = "https://login.windows.net/<tenant-id>/oauth2/authorize"

# Create Authentication Context tied to Azure AD Tenant

$authContext = New-Object "Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext" -ArgumentList $authority

# Acquire token

$authResult = $authContext.AcquireToken($resourceAppIdURI, $clientId, $redirectUri, "Auto")

## Code From https://poshcode.org/624

## Create a compilation environment

$Provider=New-Object Microsoft.CSharp.CSharpCodeProvider

$Compiler=$Provider.CreateCompiler()

$Params=New-Object System.CodeDom.Compiler.CompilerParameters

$Params.GenerateExecutable=$False

$Params.GenerateInMemory=$True

$Params.IncludeDebugInformation=$False

$Params.ReferencedAssemblies.Add("System.DLL") | Out-Null

$TASource=@'

  namespace Local.ToolkitExtensions.Net.CertificatePolicy{

    public class TrustAll : System.Net.ICertificatePolicy {

      public TrustAll() {

      }

      public bool CheckValidationResult(System.Net.ServicePoint sp,

        System.Security.Cryptography.X509Certificates.X509Certificate cert,

        System.Net.WebRequest req, int problem) {

        return true;

      }

    }

  }

'@

$TAResults=$Provider.CompileAssemblyFromSource($Params,$TASource)

$TAAssembly=$TAResults.CompiledAssembly

## We now create an instance of the TrustAll and attach it to the ServicePointManager

$TrustAll=$TAAssembly.CreateInstance("Local.ToolkitExtensions.Net.CertificatePolicy.TrustAll")

[System.Net.ServicePointManager]::CertificatePolicy=$TrustAll

Import-Module -Name "C:\Program Files\Microsoft\Exchange\Web Services\2.2\Microsoft.Exchange.WebServices.dll"

$service = new-object Microsoft.Exchange.WebServices.Data.ExchangeService([Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP2)

$service.Url = new-object System.Uri("https://outlook.office365.com/ews/exchange.asmx")

$service.Credentials  = new-object  Microsoft.Exchange.WebServices.Data.OAuthCredentials($authResult.AccessToken)

$inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service, [Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox)

""

"Total items in Inbox : " + $inbox.TotalCount

$view = New-Object Microsoft.Exchange.WebServices.Data.ItemView(5)

$findItemResults = $service.FindItems([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$view)

""

"Printing subject of last five items from Inbox:"

""

$item = [Microsoft.Exchange.WebServices.Data.Item]

$i = 1

foreach ($item in $findItemResults)

{

"Subject " + $i + ": " + $item.Subject

$i = $i + 1

""

}

Read more about EWS and Oauth authentication here. Happy scripting!

Get Started with Exchange Online REST APIs for Office 365 development in .NET

Manish Kumar - MSFT — Mon, 12 Oct 2015 13:48:19 GMT

If you intend to try your hands on building an application that interacts with Exchange Online and utilizes Office 365 REST APIs for mail, calendars, and contacts, the steps below should help.

Get your Office 365 tenant developer account (if you need more than one license, link your tenant to 30 days free trial of Office)
Add an Azure subscription – you can use your MSDN subscription for it

https://msdn.microsoft.com/subscriptions/manage/default.aspx

https://msdn.microsoft.com/en-us/subscriptions/dn531048.aspx

Getting Started with Your MSDN Subscription
https://msdn.microsoft.com/en-us/library/dd364989.aspx
Register your app in Azure AD and add appropriate permissions:

a. From Visual Studio 2013 using Connected service: https://msdn.microsoft.com/office/office365/HowTo/adding-service-to-your-Visual-Studio-project and https://blogs.msdn.com/b/visualstudio/archive/2014/11/19/connecting-to-cloud-services.aspx

b. From Windows Azure portal for O365 (to manually register it): https://msdn.microsoft.com/office/office365/HowTo/add-common-consent-manually

c. Outlook Dev Portal App Registration Tool
https://dev.outlook.com/AppRegistration
Build your application. If you are using Visual Studio to do so, you’ll need to install ADAL library through Nuget. Please also make sure you use .NET 4.5 or above if you are using latest ADAL library.

Tools you can use to understand how the flow works. You’ve an option to play with sample data or sign in and work with your own Office 365 tenant account.
(Only for authorization grant flow)

Understanding Permissions:

Office 365 application manifest and permission details
https://msdn.microsoft.com/office/office365/HowTo/application-manifest

Understanding Oauth grant flows:

There are two grant flows:

Authorization code grant flow – this is said to run in delegation mode. The user gives assent to the app to access his own mailbox.

Please see https://blogs.msdn.com/b/exchangedev/archive/2014/09/24/10510847.aspx and https://msdn.microsoft.com/en-us/library/azure/dn645543.aspx
Client Credential flow – this is said to run in app-only mode. Also known as Daemon app or service app. The admin (tenant administrator/ global administrator) needs to give assent to the app.

Please see https://msdn.microsoft.com/en-us/library/azure/dn645543.aspx and https://blogs.msdn.com/b/exchangedev/archive/2015/01/22/building-demon-or-service-apps-with-office-365-mail-calendar-and-contacts-apis-oauth2-client-credential-flow.aspx

Important Samples in .NET:

Authorization grant flow:
https://dev.outlook.com/RestGettingStarted/Tutorial/dotnet

Client credential flow:
https://github.com/mattleib/o365api-as-apponly-webapp

[EWS]How To enable EWS request and response tracing in PowerShell script using EWS Managed API?

Manish Kumar - MSFT — Fri, 02 Oct 2015 15:10:24 GMT

Most of the time we need to review the request and response logs when troubleshooting any application/script which is utilizing the Exchange Web Services. Although setting the TraceEnabled flag to true on the ExchangeService object outputs the trace to the PowerShell window, there is no easy way to copy the trace to a file. Below is an example of using the inbuilt tracing capabilities of the EWS Managed API to enable the logging of request and response in a text file. Here the assembly version and PublicKeyToken correspond to the Microsoft.Exchange.WebServices.dll obtained after installing EWS Managed API 2.2 from https://www.microsoft.com/en-in/download/details.aspx?id=42951. For a different Managed API version, you need to update the version and PublicKeyToken accordingly.

To-do: In the line number 17, change the log file path to your liking and also provide the file name. I’ve used C: directory as the log file path and Log as the name of the file. There could be permission issues when creating the log file in a directory. So make sure you’ve the permission to create a new file and write to it in the log file directory or run the PowerShell window as an administrator.

NOTE: Following programming examples is for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This sample code assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. This sample code is provided for the purpose of illustration only and is not intended to be used in a production environment.

        1: $Assem = ( 

       2:     "Microsoft.Exchange.WebServices, Version=15.0.0.0, Culture=neutral,  PublicKeyToken =31bf3856ad364e35"

       3:    ) 

       4:  

       5: $Source = @"

       6: using System;

       7: using System.Text;

       8: using Microsoft.Exchange.WebServices.Data;

       9: public class TraceListener : Microsoft.Exchange.WebServices.Data.ITraceListener

    {

        public void Trace(string traceType, string traceMessage)

        {

            CreateXMLTextFile(traceType, traceMessage.ToString());

        }

        private void CreateXMLTextFile(string fileName, string traceContent)

        {           

           string strPath = "C:\\Log.txt";

            System.IO.FileStream fs;

            if (System.IO.File.Exists(strPath) == false)

            {

                fs = System.IO.File.Create(strPath);

            }

            else

            {

                fs = System.IO.File.OpenWrite(strPath);

            }

            fs.Close();

            // Create an instance of StreamWriter to write text to a file.

            System.IO.StreamWriter sw = System.IO.File.AppendText(strPath);

            sw.WriteLine(System.DateTime.Now.ToString() + ": " + traceContent);

            sw.Close();

        }

    }

"@

  

Add-Type -ReferencedAssemblies $Assem -TypeDefinition $Source -Language CSharp

After you add this to the script, you need to assign the TraceListener member of the ExchangeService class to an instance of the above TraceListener class.

       1: $service = new-object Microsoft.Exchange.WebServices.Data.ExchangeService([Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP2)

       2: $service.TraceListener = new-object TraceListener

       3: #Set it to $false, if you want to disable this tracing

       4: $service.TraceEnabled = $true

In this example we’re loading the assembly into the current PowerShell session. So, if you make any changes to the TraceListener class and run the script again in the same PowerShell session, you may well see an error which indicates that the Type is already loaded [Add-Type : Cannot add type. The type name 'TraceListener' already exists.]. In that case, please restart the Windows PowerShell and run the script.

Attached at the bottom of this post is the file (EWS tracing PowerShell.txt) containing the above code snippet.

Happy scripting!

EWS tracing PowerShell.txt

NO TO MULTIPLE BODIES ON A MESSAGE!

Manish Kumar - MSFT — Thu, 07 May 2015 11:42:27 GMT

Recently I came across a case where the requirement was to send an email (using Outlook Object Model) consisting of both HTML and Plain Text body, with the idea being that, based on the View set in outlook, the appropriate body will be chosen. The cause for setting multiple bodies was that, when an email containing image icons are rendered in plain text view, additional URLs were added in the place of the image icons which made the email look clumsy!

Digging further into the issue made me try some troubleshooting to check what exactly is happening. The first test was performed using Outlook Object model with the HTML body format set. Result observed was that for HTML view, the HTML body content was displayed along with the formatting while for Plain text view, only the HTML body content was displayed without any formatting. Further, test performed using System.Net.Mail with the AlternateView set, proved that Exchange will only store one body in one format and does not support having multiple bodies on a message.

The behavior observed is expected and by design. As per the protocol document, Exchange prefers a certain format, “text/HTML”. If there is an HTML body part it will be chosen as the Primary Message Text and that is what is converted to MAPI. When a client asks for PR_BODY (i.e. plain text) it will be converted as per “Best Body” logic.

As a simple work around, rather than referencing external images for the image icons, it is suggested to add them as attachments and reference them in HTML.

Reference Links :

· Selecting the Primary Message Text MIME Element : https://msdn.microsoft.com/en-us/library/gg709700%28v=exchg.80%29.aspx

· Body Text : https://msdn.microsoft.com/en-us/library/gg672102%28v=exchg.80%29.aspx

· Determining Which MIME Element Is the Message Body : https://msdn.microsoft.com/en-us/library/gg672007%28v=exchg.80%29.aspx

· HTML Text Message Body Without Inline Attachments : https://msdn.microsoft.com/en-us/library/ee238059%28v=exchg.80%29.aspx

· Best Body Algorithm : https://msdn.microsoft.com/en-us/library/hh369831%28v=exchg.80%29.aspx

· Forum link that has a discussion thread for a similar issue https://social.msdn.microsoft.com/Forums/office/en-US/0c490364-c6f7-40cf-9f6f-b90aea443cda/outlook-email-text-or-html-format-for-recepient?forum=outlookdev

Kamala Payyapilly Thiruvenkatanathan [MSFT]

[EWS]How to retrieve the OOF (Out Of Facility) settings/message using EWS for an Exchange user?

Manish Kumar - MSFT — Mon, 02 Jun 2014 15:45:31 GMT

Technorati Tags: EWS,Exchange 2010,GetMailTips,GetUserOofSettings,Out of Facility,Out of Office,EWS Managed API,Exchange 2013,Exchange Online,Exchange Web Services,DevMsg,HTTP EWS SOAP request

Our customers have a common ask wherein they would like to check if the organization’s employees are available in office or out of office on a given day. With Exchange Web Services (EWS) being the flagship API for Exchange related development, the relevant call they come across is GetUserOofSettings in EWS Managed API.

However, when you make this call from a normal Exchange user account, you get an error message saying:
"Access is denied. Check credentials and try again".

The reason being GetUserOofSettings call works only for the users with the Exchange impersonation permissions. As for example, assume that the EWS call is made using the User A’s credential and he’s trying to access User B’s OOF settings. In that case, User A needs to have Exchange impersonation permissions on User B’s mailbox.

In case if you’re requirement is not to run the EWS application under impersonation service account then we could use Mail Tips to fetch the automatic reply set by the Exchange user.

Currently, we don’t have a EWS Managed API call to retrieve the Mail Tips. However, we have the method GetMailTips operation available with Exchange Web Services to retrieve the out of office settings.

We can create the soap request for GetMailTips operation in the following ways:

Use the Visual Studio to generate the proxy classes for EWS and then use it write the code for GetMailTips operation.
Post the request directly from your EWS managed API application.

Here is a sample using EWS Managed API:

        1: /* Disclaimer:

       2: By using the following materials or sample code you agree to be bound by the license terms below and the Microsoft Partner Program Agreement the terms of which are incorporated herein by this reference. These license terms are an agreement between Microsoft Corporation (or, if applicable based on where you are located, one of its affiliates) and you. Any materials (other than sample code) we provide to you are for your internal use only. Any sample code is provided for the purpose of illustration only and is not intended to be used in a production environment. We grant you a nonexclusive, royalty-free right to use and modify the sample code and to reproduce and distribute the object code form of the sample code, provided that you agree: (i) to not use Microsoft's name, logo, or trademarks to market your software product in which the sample code is embedded; (ii) to include a valid copyright notice on your software product in which the sample code is embedded; (iii) to provide on behalf of and for the benefit of your subcontractors a disclaimer of warranties, exclusion of liability for indirect and consequential damages and a reasonable limitation of liability; and (iv) to indemnify, hold harmless, and defend Microsoft, its affiliates and suppliers from and against any third party claims or lawsuits, including attorneys' fees, that arise or result from the use or distribution of the sample code.*/

       3:  

       4: string getMailTipssoapResponse = oofCall(service.Url.AbsoluteUri);

       5:  

       6: private static string oofCall(String urlname)

       7:         {

       8:             WebRequest webRequest = WebRequest.Create(urlname);

       9:             HttpWebRequest httpwebRequest = (HttpWebRequest)webRequest;

            httpwebRequest.Method = "POST";

            httpwebRequest.ContentType = "text/xml; charset=utf-8";

            httpwebRequest.ProtocolVersion = HttpVersion.Version11;

            httpwebRequest.Credentials = CredentialCache.DefaultCredentials;

            httpwebRequest.Timeout = 60000;

            Stream requestStream = httpwebRequest.GetRequestStream();

            StreamWriter streamWriter = new StreamWriter(requestStream, Encoding.ASCII);

  

            StringBuilder getMailTipsSoapRequest = new StringBuilder(");

            getMailTipsSoapRequest.Append(" xmlns:xsd=\"https://www.w3.org/2001/XMLSchema\" ");

            getMailTipsSoapRequest.Append("xmlns:soap=\"https://schemas.xmlsoap.org/soap/envelope/\" ");

            getMailTipsSoapRequest.Append("xmlns:t=\"https://schemas.microsoft.com/exchange/services/2006/types\">");

            getMailTipsSoapRequest.Append(" ");

            getMailTipsSoapRequest.Append("");

            getMailTipsSoapRequest.Append("");

            getMailTipsSoapRequest.Append("user1@contoso.com");

            getMailTipsSoapRequest.Append("SMTP");

            getMailTipsSoapRequest.Append("");

            getMailTipsSoapRequest.Append("user2@contoso.com");

            getMailTipsSoapRequest.Append("SMTP");

            getMailTipsSoapRequest.Append(" OutOfOfficeMessage");

            getMailTipsSoapRequest.Append("");

  

            streamWriter.Write(getMailTipsSoapRequest.ToString());

            streamWriter.Close();

            HttpWebResponse webResponse = (HttpWebResponse)httpwebRequest.GetResponse();

  

            StreamReader streamreader = new StreamReader(webResponse.GetResponseStream());

            string result = streamreader.ReadToEnd();

            return result;

        }

Here is the response that I got from server:

       1: xml version="1.0" encoding="utf-8" ?> 

       2: - <s:Envelope xmlns:s="https://schemas.xmlsoap.org/soap/envelope/">

       3: - <s:Header>

       4:   <h:ServerVersionInfo MajorVersion="14" MinorVersion="3" MajorBuildNumber="136" MinorBuildNumber="1" Version="Exchange2010_SP2" xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" xmlns="https://schemas.microsoft.com/exchange/services/2006/types" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" /> 

       5:   s:Header>

       6: - <s:Body xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">

       7: - <GetMailTipsResponse ResponseClass="Success" xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">

       8:   <ResponseCode>NoErrorResponseCode> 

       9: - <ResponseMessages>

      10: - <MailTipsResponseMessageType ResponseClass="Success">

      11:   <ResponseCode>NoErrorResponseCode> 

      12: - <m:MailTips xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages">

      13: - <t:RecipientAddress xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">

      14:   <t:Name /> 

      15:   <t:EmailAddress>user2@contoso.comt:EmailAddress> 

      16:   <t:RoutingType>SMTPt:RoutingType> 

      17:   t:RecipientAddress>

      18:   <t:PendingMailTips xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" /> 

      19: - <t:OutOfOffice xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">

      20: - <t:ReplyBody xml:lang="en-us">

      21:   <t:Message> I am Out of Office Todayt:Message> 

      22:   t:ReplyBody>

      23:   t:OutOfOffice>

      24:   m:MailTips>

      25:   MailTipsResponseMessageType>

      26:   ResponseMessages>

      27:   GetMailTipsResponse>

      28:   s:Body>

      29:   s:Envelope>

Though the GetMailTips operation is NOT yet available with EWS Managed API, with the above sample using raw HTTP EWS SOAP request we can easily retrieve the required information. For more details, refer the following articles:

GetMailTips Operation
https://msdn.microsoft.com/en-us/library/exchange/dd877060(v=exchg.150).aspx
MailTipsRequested
https://msdn.microsoft.com/en-us/library/exchange/dd899452(v=exchg.150).aspx