Export the GAL or Address list with EWS to Vcards in 2013 MEC sample 1

This is the first of the sample scripts I included in my MEC talk last Monday. This script uses 3 of the new operations in EWS in Exchange 2013 to export all the address list entries of a particular Addresslist to individual Vcards (including the user photo) using just EWS. None of these operations are included in the EWS Managed API, so to use these operations I'm using some Raw SOAP and posting the EWS request using the standard httpwebrequest class in .Net and processing the response in XML.

The FindPeople Operation is used firstly to page through all the entries in an Address list in groups of 100 entries at a time. To use this operation you first need to get the GUID for the address list you want to export and hard code this in the $ABGUID variable eg.

$ABGUID = "6c118670-2f72-4213-944c-ab1e97d63f9b";

To get the GUID for your Global Address List you need to use the Get-GlobalAddressList Cmdlet http://technet.microsoft.com/en-us/library/aa996579%28v=exchg.150%29.aspx or if you want to export one of the other Address lists you can use the Get-AddressList cmdlet http://technet.microsoft.com/en-us/library/aa996782(v=exchg.150).aspx .

eg

To use these cmdlet's in Office365 you need to make sure you are assigned the Address Lists Role in RBAC

eg run

New-ManagementRoleAssignment -Role 'Address Lists' -User username

The FindPeople operation returns the PersonaId for each of the AddressList entries so the next part of the script uses the GetPersona Operation to get all the Address list entries details. Personas are a different way of representing contact data this is outlined in http://msdn.microsoft.com/en-us/library/office/jj190895(v=exchg.150).aspx . This particular script just uses this operation to grab the contact details stored in Active Directory (or Azure AD) for the particular persona (or Address list Entry in question). Currently I haven't worked out a way to batch this operation in EWS (if anyone knows please ping me) so its executing one OP per entry(which is kind of slow).

The last operation the script uses is the GerUserPhoto operation which is just a REST endpoint so it's nice and easy to use. It returns a ByteArray which then gets converted to a Base64 string with LineBreaks so its properly formatted in the VCard file.

To run this script you need to pass it in a Mailbox to run as and as I mentioned before you need to hardcode the GUID of the AddressList you want to export. While none of the operations used to do the export are in the Managed API, I've included in the usually Managed API Autodiscovery routines. You can also set the location of the export directory in

$exportFolder = "c:\temp\"

I've put a download of this script here the code itself looks like

## Get the Mailbox to Access from the 1st commandline argument
$MailboxName = $args[0]
$exportFolder = "c:\temp\"
$ABGUID = "6c118670-2f72-4213-944c-ab1e97d63f9b";
## Load Managed API dll
Add-Type -Path "C:\Program Files\Microsoft\Exchange\Web Services\2.0\Microsoft.Exchange.WebServices.dll"
## Set Exchange Version
$ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP2
## Create Exchange Service Object
$service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService($ExchangeVersion)
## Set Credentials to use two options are availible Option1 to use explict credentials or Option 2 use the Default (logged On) credentials
#Credentials Option 1 using UPN for the windows Account
$psCred = Get-Credential
$creds = New-Object System.Net.NetworkCredential($psCred.UserName.ToString(),$psCred.GetNetworkCredential().password.ToString())
$service.Credentials = $creds
#Credentials Option 2
#service.UseDefaultCredentials = $true
## Choose to ignore any SSL Warning issues caused by Self Signed Certificates
## Code From http://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
## end code from http://poshcode.org/624
## Set the URL of the CAS (Client Access Server) to use two options are availbe to use Autodiscover to find the CAS URL or Hardcode the CAS to use
#CAS URL Option 1 Autodiscover
$service.AutodiscoverUrl($MailboxName,{$true})
"Using CAS Server : " + $Service.url
#CAS URL Option 2 Hardcoded
#$uri=[system.URI] "https://casservername/ews/exchange.asmx"
#$service.Url = $uri
## Optional section for Exchange Impersonation
#$service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName)
function getPeopleRequest($offset){
$request = @"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<RequestServerVersion Version="Exchange2013" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" />
</soap:Header><soap:Body>
<FindPeople xmlns="http://schemas.microsoft.com/exchange/services/2006/messages"><PersonaShape>
<BaseShape xmlns="http://schemas.microsoft.com/exchange/services/2006/types">Default</BaseShape>
</PersonaShape><IndexedPageItemView MaxEntriesReturned="100" Offset="$offset" BasePoint="Beginning" />
<ParentFolderId>
<AddressListId Id="$ABGUID" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" />
</ParentFolderId></FindPeople></soap:Body></soap:Envelope>
"@
return $request
}
function getPersonaRequest($PersonalId){
$request = @"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013"/>
</soap:Header>
<soap:Body xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<GetPersona>
<PersonaId Id="$PersonalId"/>
</GetPersona>
</soap:Body>
</soap:Envelope>
"@
return $request
}
function AutoDiscoverPhotoURL{
param (
$EmailAddress="$( throw 'Email is a mandatory Parameter' )",
$Credentials="$( throw 'Credentials is a mandatory Parameter' )"
)
process{
$version= [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2013
$adService= New-Object Microsoft.Exchange.WebServices.Autodiscover.AutodiscoverService($version);
$adService.Credentials = $Credentials
$adService.EnableScpLookup=$false;
$adService.RedirectionUrlValidationCallback= {$true}
$adService.PreAuthenticate=$true;
$UserSettings= new-object Microsoft.Exchange.WebServices.Autodiscover.UserSettingName[] 1
$UserSettings[0] = [Microsoft.Exchange.WebServices.Autodiscover.UserSettingName]::ExternalPhotosUrl
$adResponse=$adService.GetUserSettings($EmailAddress, $UserSettings)
$PhotoURI= $adResponse.Settings[[Microsoft.Exchange.WebServices.Autodiscover.UserSettingName]::ExternalPhotosUrl]
return $PhotoURI.ToString()
}
}
$Script:PhotoURL = AutoDiscoverPhotoURL -EmailAddress $MailboxName -Credentials $creds
Write-host ("Photo URL : " + $Script:PhotoURL)
function ProcessPersona($PersonalId){
$personalRequest = getPersonaRequest ($PersonalId)
$mbMailboxFolderURI = New-Object System.Uri($service.url)
$wrWebRequest = [System.Net.WebRequest]::Create($mbMailboxFolderURI)
$wrWebRequest.CookieContainer = New-Object System.Net.CookieContainer
$wrWebRequest.KeepAlive = $false;
$wrWebRequest.Headers.Set("Pragma", "no-cache");
$wrWebRequest.Headers.Set("Translate", "f");
$wrWebRequest.Headers.Set("Depth", "0");
$wrWebRequest.ContentType = "text/xml";
$wrWebRequest.ContentLength = $expRequest.Length;
$wrWebRequest.Timeout = 90000;
$wrWebRequest.Method = "POST";
$wrWebRequest.Credentials = $creds
$wrWebRequest.UserAgent = "EWS Script"
$bqByteQuery = [System.Text.Encoding]::ASCII.GetBytes($personalRequest);
$wrWebRequest.ContentLength = $bqByteQuery.Length;
$rsRequestStream = $wrWebRequest.GetRequestStream();
$rsRequestStream.Write($bqByteQuery, 0, $bqByteQuery.Length);
$rsRequestStream.Close();
$wrWebResponse = $wrWebRequest.GetResponse();
$rsResponseStream = $wrWebResponse.GetResponseStream()
$sr = new-object System.IO.StreamReader($rsResponseStream);
$rdResponseDocument = New-Object System.Xml.XmlDocument
$rdResponseDocument.LoadXml($sr.ReadToEnd());
$Persona =@($rdResponseDocument.getElementsByTagName("Persona"))
$Persona
$DisplayName = "";
if($Persona.DisplayName -ne $null){
$DisplayName = $Persona.DisplayName."#text"
}
$fileName = $exportFolder + $DisplayName + "-" + [Guid]::NewGuid().ToString() + ".vcf"
add-content -path $filename "BEGIN:VCARD"
add-content -path $filename "VERSION:2.1"
$givenName = ""
if($Persona.GivenName -ne $null){
$givenName = $Persona.GivenName."#text"
}
$surname = ""
if($Persona.Surname -ne $null){
$surname = $Persona.Surname."#text"
}
add-content -path $filename ("N:" + $surname + ";" + $givenName)
add-content -path $filename ("FN:" + $Persona.DisplayName."#text")
$Department = "";
if($Persona.Department -ne $null){
$Department = $Persona.Department."#text"
}
if($Persona.EmailAddress -ne $null){
add-content -path $filename ("EMAIL;PREF;INTERNET:" + $Persona.EmailAddress.EmailAddress)
}
$CompanyName = "";
if($Persona.CompanyName -ne $null){
$CompanyName = $Persona.CompanyName."#text"
}
add-content -path $filename ("ORG:" + $CompanyName + ";" + $Department)
if($Persona.Titles -ne $null){
add-content -path $filename ("TITLE:" + $Persona.Titles.StringAttributedValue.Value)
}
if($Persona.MobilePhones -ne $null){
add-content -path $filename ("TEL;CELL;VOICE:" + $Persona.MobilePhones.PhoneNumberAttributedValue.Value.Number)
}
if($Persona.HomePhones -ne $null){
add-content -path $filename ("TEL;HOME;VOICE:" + $Persona.HomePhones.PhoneNumberAttributedValue.Value.Number)
}
if($Persona.BusinessPhoneNumbers -ne $null){
add-content -path $filename ("TEL;WORK;VOICE:" + $Persona.BusinessPhoneNumbers.PhoneNumberAttributedValue.Value.Number)
}
if($Persona.WorkFaxes -ne $null){
add-content -path $filename ("TEL;WORK;FAX:" + $Persona.WorkFaxes.PhoneNumberAttributedValue.Value.Number)
}
if($Persona.BusinessHomePages -ne $null){
add-content -path $filename ("URL;WORK:" + $Persona.BusinessHomePages.StringAttributedValue.Value)
}
if($Persona.BusinessAddresses -ne $null){
$Country = $Persona.BusinessAddresses.PostalAddressAttributedValue.Value.Country
$City = $Persona.BusinessAddresses.PostalAddressAttributedValue.Value.City
$Street = $Persona.BusinessAddresses.PostalAddressAttributedValue.Value.Street
$State = $Persona.BusinessAddresses.PostalAddressAttributedValue.Value.State
$PCode = $Persona.BusinessAddresses.PostalAddressAttributedValue.Value.PostalCode
$addr = "ADR;WORK;PREF:;" + $Country + ";" + $Street + ";" +$City + ";" + $State + ";" + $PCode + ";" + $Country
add-content -path $filename $addr
}
try{
$PhotoSize = "HR96x96"
$PhotoURL= $Script:PhotoURL + "/GetUserPhoto?email=" + $Persona.EmailAddress.EmailAddress + "&size=" + $PhotoSize;
$wbClient = new-object System.Net.WebClient
$wbClient.Credentials = $creds
$photoBytes = $wbClient.DownloadData($PhotoURL);
add-content -path $filename "PHOTO;ENCODING=BASE64;TYPE=JPEG:"
$ImageString = [System.Convert]::ToBase64String($photoBytes,[System.Base64FormattingOptions]::InsertLineBreaks)
add-content -path $filename $ImageString
add-content -path $filename "`r`n"
}
catch{
}
add-content -path $filename "END:VCARD"
}
$peopleCollection = @()
$offset = 0;
do{
$mbMailboxFolderURI = New-Object System.Uri($service.url)
$wrWebRequest = [System.Net.WebRequest]::Create($mbMailboxFolderURI)
$wrWebRequest.CookieContainer = New-Object System.Net.CookieContainer
$wrWebRequest.KeepAlive = $false;
$wrWebRequest.Useragent = "EWS Script"
$wrWebRequest.Headers.Set("Pragma", "no-cache");
$wrWebRequest.Headers.Set("Translate", "f");
$wrWebRequest.Headers.Set("Depth", "0");
$wrWebRequest.ContentType = "text/xml";
$wrWebRequest.ContentLength = $expRequest.Length;
$wrWebRequest.Timeout = 60000;
$wrWebRequest.Method = "POST";
$wrWebRequest.Credentials = $creds
$fpRequest = getPeopleRequest ($offset)
$bqByteQuery = [System.Text.Encoding]::ASCII.GetBytes($fpRequest);
$wrWebRequest.ContentLength = $bqByteQuery.Length;
$rsRequestStream = $wrWebRequest.GetRequestStream();
$rsRequestStream.Write($bqByteQuery, 0, $bqByteQuery.Length);
$rsRequestStream.Close();
$wrWebResponse = $wrWebRequest.GetResponse();
$rsResponseStream = $wrWebResponse.GetResponseStream()
$sr = new-object System.IO.StreamReader($rsResponseStream);
$rdResponseDocument = New-Object System.Xml.XmlDocument
$rdResponseDocument.LoadXml($sr.ReadToEnd());
$totalCount = @($rdResponseDocument.getElementsByTagName("TotalNumberOfPeopleInView"))
$Personas =@($rdResponseDocument.getElementsByTagName("Persona"))
Write-Host ("People Count : " + $Personas.Count)
$offset += $Personas.Count
foreach($persona in $Personas){
if($persona.PersonaType -eq "Person"){
ProcessPersona($persona.PersonaId.Id.ToString())
}
}
[Int32]$tc = $totalCount."#text"
Write-Host ("Offset: " + $offset)
Write-Host ("Total count: " + $tc)
}while($tc -gt $offset)

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/filen...

Glen's Exchange and Office 365 Dev Blog

Search This Blog

Export the GAL or Address list with EWS to Vcards in 2013 MEC sample 1

Labels

Popular posts from this blog

Export calendar Items to a CSV file using Microsoft Graph and Powershell

Downloading a shared file from Onedrive for business using Powershell

Sending a MimeMessage via the Microsoft Graph using the Graph SDK, MimeKit and MSAL