Public/Remove-DwImportMailbox.ps1
|
#Requires -Version 7 function Remove-DwImportMailbox { <# .SYNOPSIS Deletes a mailbox in the import API. .DESCRIPTION Deletes a mailbox in the import API. Takes the ImportId and UniqueIdentifier as an input. .PARAMETER Instance Dashworks instance. For example, https://myinstance.dashworks.app:8443 .PARAMETER APIKey Dashworks API Key. .PARAMETER UniqueIdentifier UniqueIdentifier for the mailbox. .PARAMETER ImportId ImportId for the mailbox. .EXAMPLE PS> Remove-DwImportMailbox -ImportId 1 -UniqueIdentifier "w123abc" -Instance "https://myinstance.dashworks.app:8443" -APIKey "xxxxx" #> [CmdletBinding(SupportsShouldProcess)] param ( [Parameter(Mandatory=$true)] [string]$Instance, [Parameter(Mandatory=$true)] [string]$APIKey, [parameter(Mandatory=$true)] [string]$UniqueIdentifier, [parameter(Mandatory=$true)] [int]$ImportId ) $uri = "{0}/apiv2/imports/mailboxes/{1}/items/{2}" -f $Instance, $ImportId, $UniqueIdentifier $headers = @{'x-api-key' = $APIKey} try { if ($PSCmdlet.ShouldProcess($UniqueIdentifier)) { $result = Invoke-WebRequest -Uri $uri -Method DELETE -Headers $headers return $result } } catch { Write-Error $_ } } |