TestMsImap.psm1
|
using module .\AzureSettings.psm1 using module .\Analyzers.psm1 using module .\STcpClient.psm1 using module .\ImapClient.psm1 using module .\Tokens.psm1 using module .\Result.psm1 using module .\Loggers.psm1 function Test-MsImap ( [string]$Mailbox, [string]$TenantId = "", [string]$ClientId = "", [string]$ClientSecret = "", [string]$Pass = "", [string]$LoginUser = "", [Microsoft.Identity.Client.AzureCloudInstance]$AzureCloudInstance=[Microsoft.Identity.Client.AzureCloudInstance]::AzurePublic, [string]$LogPath = "" ) { <# .SYNOPSIS Test Microsot Exchange's IMAP service's connectivity. .DESCRIPTION This method tests Microsot Exchange's IMAP service's connectivity. .PARAMETER Mailbox Mailbox to connect. .PARAMETER TenantId TenantId in Azure. It is not required if the app is registered as a multiple-tenant app. .PARAMETER ClientId ClientId or AppId in Azure. .PARAMETER ClientSecret The secret of the registered app. .PARAMETER Pass The password for basic authentication. .PARAMETER LoginUser For basic authentication, if login with a different account than the target mailbox. .PARAMETER AzureCloudInstance Azure instance name. .PARAMETER LogPath The log file path of the test. Default is "logs\IMAP_{0:yyyyMMdd}.log" -f (Get-Date) .INPUTS None. You cannot pipe objects to Test-MsImap. .OUTPUTS None. It will display the result in text. .EXAMPLE PS>Test-MsImap -Mailbox user@contoso.com -TenantId $tenantId -ClientId $clientId -ClientSecret $clientSecret .EXAMPLE PS>Test-MsImap -Mailbox user@contoso.com -Pass Password1@# .EXAMPLE PS>Test-MsImap -Mailbox user@contoso.gov -TenantId $tenantId -ClientId $clientId -AzureCloudInstance AzureUsGovernment #> $server = Get-OutlookEndpoint -AzureCloudInstance $AzureCloudInstance $port = Get-Port -AppName "IMAP" if ($ClientSecret) { $scopes = @(Get-Scope -AppName "IMAP" -AccessType "AsApp" -AzureCloudInstance $AzureCloudInstance) } else { $scopes = @(Get-Scope -AppName "IMAP" -AccessType "AsUser" -AzureCloudInstance $AzureCloudInstance) } if (!$LogPath) { $LogPath = "logs\imap_{0:yyyyMMdd}.log" -f (Get-Date) } $logger = Get-Logger -FilePath $LogPath $client = Get-TcpClient -Server $server -Port $port -Logger $logger $imap = Get-ImapClient -TcpClient $client $imap.Connect() if ($Pass) { # basic auth if ($LoginUser) { $result = $imap.Login($LoginUser, $Mailbox, $Pass) } else { $result = $imap.Login($Mailbox, $Pass) } } else{ if ($ClientSecret) { $token = Get-AccessTokenWithSecret -TenantId $TenantId -ClientId $ClientId -Scopes $scopes -ClientSecret $ClientSecret -AzureCloudInstance $AzureCloudInstance $accessType = "AsApp" } else { $token = Get-AccessTokenInteractive -TenantId $TenantId -ClientId $ClientId -Scopes $scopes -AzureCloudInstance $AzureCloudInstance $accessType = "AsUser" } $result = $imap.O365Authenticate($token.AccessToken, $Mailbox) } if ($result.Success) { $result = $imap.ExecuteCommand('LIST "" *') } if (!$result.Success -and !$pass) { # failed OAuth connection. $aud = Get-Aud -AzureCloudInstance $AzureCloudInstance $scp = Get-Scp -AppName "IMAP" -AccessType $accessType $analyzer = Get-Analyzer -Name "AccessTokenAnalyzer" if ($analyzer) { $analyses = $analyzer.Analyze($Mailbox, $token.AccessToken, $scp, $aud) $analyses | ForEach-Object { $logger.Info($_) } } } $imap.Close() if ($result.Success) { $msg = "IMAP connection is successful for mailbox '{0}' on server '{1}' and port {2}." -f $Mailbox, $server, $port Write-Host $msg } else { $msg = "Something is wrong. Please review the log {0}." -f $LogPath Write-Warning $msg } } |