Summary

This script is primarily intended to find specific appointments in mailbox calendar folders. Information about the appointments found can be exported to CSV.

Examples

Exchange Online examples assume that the mailbox and Azure AD application registration details have been stored in PowerShell variables e.g.

$Mailbox = "mailbox@domain.com"
$clientId = "Application Id"
$tenantId = "Tenant Id"
$secretKey = "Secret key" # App only auth

Exchange on-premises examples assume that the mailbox, credential and EWS URL are stored in PowerShell variables:

$Mailbox = "mailbox@domain.com"
$credential = Get-Credential # Collect credentials that the script will use when connecting to Exchange Web Services
$ewsUrl = "https://e1.e19.local/EWS/Exchange.asmx"

Export appointments from on-premises mailbox

.\Search-Appointments.ps1 -Mailbox $Mailbox -Credential $credential -EwsUrl $ewsUrl -ExportCSV "c:\temp\appointments.csv"

The above will export all calendar items to the specified file in CSV format. These fields are currently exported: Mailbox, Subject, Sent, Received, Organizer, Start, End, IsAllDay, AppointmentType.

Export appointments from multiple on-premises mailboxes

$mailboxes = @("1@domain.com", "2@domain.com")
foreach ($mailbox in $mailboxes) {
    .\Search-Appointments.ps1 -Mailbox $Mailbox -Credential $credential -EwsUrl $ewsUrl -ExportCSV "c:\temp\$mailbox appointments.csv" -Impersonate
}

The above will export all calendar items from the two specified mailboxes, creating a new CSV file for each.

Parameters

-Mailbox: Specifies the mailbox to be accessed..

-FolderPath: Folder to search - if omitted, the mailbox calendar folder is assumed.

-PublicFolders: If this switch is present, folder path is required and the path points to a public folder.

-Subject: Subject of the appointment(s) being searched.

-Organizer: Organizer of the appointment(s) being searched.

-Location: Location of the appointment(s) being searched.

-Category: Category of the appointment(s) being searched.

-StartsAfter: Start date for the appointment(s) must be after this date.

-StartsBefore: Start date for the appointment(s) must be before this date.

-EndsAfter: End date for the appointment(s) must be after this date.

-EndsBefore: End date for the appointment(s) must be before this date.

-CreatedBefore: Only appointments created before the given date will be returned.

-CreatedAfter: Only appointments created after the given date will be returned.

-LastOccurrenceBefore: Only recurring appointments with a last occurrence date before the given date will be returned.

-LastOccurrenceAfter: Only recurring appointments with a last occurrence date after the given date will be returned.

-HasExceptions: If specified, only appointments with at least this number of exceptions will be returned. Exceptions include both modified and deleted occurrences.

-IsRecurring: If this switch is present, only recurring appointments are returned.

-HasNoEndDate: If this switch is present, only recurring appointments that have no end date are returned (must be used with -IsRecurring).

-IsAllDay: If this switch is present, only all-day appointments are returned.

-Delete: If specified, any matched appointments will be deleted.

-SendCancellationsMode: The SendCancellationsMode option that will be used when deleting items.

-MoveToFolder: Folder path to which matching appointments will be moved.

-ExportCSV: CSV Export - appointments are exported to this file..

-ExportUTC: If this parameter is specified, exported times are in UTC.

-Credential: Credentials used to authenticate with EWS (provided as PSCredential).

-OAuth: when specified, will use OAuth to access the mailbox (required for MFA enabled accounts) - this requires the ADAL dlls to be available.

-OAuthClientId: The application Id as registered in Azure AD. If not specified, a global registration will be used that supports delegated access only (and will need consent to be able to access mailboxes).

-OAuthTenantId: The tenant Id in which the application is registered. If missing, application is assumed to be multi-tenant and the common log-in URL will be used.

-OAuthRedirectUri: The redirect Uri of the Azure registered application (defaults to http://localhost/code).

-OAuthSecretKey: Secret key to be used when obtaining access token. If this is specified, then application permissions are requested and no user log-on will be required.

-OAuthCertificate: The OAuth certificate to be used when obtaining access token. Application permissions are requested in this scenario. You can obtain a certificate from your own certificate store using the thumbprint: Get-Item Cert:\CurrentUser\My\50B510B4AE120D9B0EE3F059B6DD494469CD6D3B.

-Impersonate: If set, ApplicationImpersonation is used to access the mailbox(es).

-EwsUrl: EWS Url (if omitted, and -Office365 not specified, then autodiscover is used).

-Office365: If set, requests are directed to Office 365 endpoint (overrides -EwsUrl).

-EWSManagedApiPath: Path to managed API (if omitted, a search of standard paths is performed).

-IgnoreSSLCertificate: If set, invalid SSL certificates will be ignored and the connection made regardless. Use with care, required for self-signed certificates.

-AllowInsecureRedirection: If set, insecure redirection will be allowed during AutoDiscover.

-LogFile: Logs script activity to the specified file.

-VerboseLogFile: Logs verbose information to the specified file.

-DebugLogFile: Logs debug information to the specified file.

-FastFileLogging: If set, an optimised log file creator is used that should be signficantly faster (but may leave file lock applied if script is cancelled).

-TraceFile: Write all EWS traffic (requests/responses/headers) to the specified file.