Public/Gmail/Remove-GSGmailFilter.ps1
|
function Remove-GSGmailFilter { <# .SYNOPSIS Removes a Gmail filter .DESCRIPTION Removes a Gmail filter .PARAMETER User The primary email of the user to remove the filter from Defaults to the AdminEmail user .PARAMETER FilterId The unique Id of the filter to remove .PARAMETER Raw If $true, returns the raw response. If not passed or -Raw:$false, response is formatted as a flat object for readability .EXAMPLE Remove-GSGmailFilter -FilterId ANe1Bmj5l3089jd3k1eQbY90g9rXswjS03LVOw Removes the Filter from the AdminEmail user after confirmation #> [cmdletbinding(SupportsShouldProcess = $true,ConfirmImpact = "High")] Param ( [parameter(Mandatory = $false,Position = 0,ValueFromPipelineByPropertyName = $true)] [Alias("PrimaryEmail","UserKey","Mail")] [ValidateNotNullOrEmpty()] [string] $User = $Script:PSGSuite.AdminEmail, [parameter(Mandatory = $true,ValueFromPipelineByPropertyName = $true)] [Alias("Id")] [string[]] $FilterId, [parameter(Mandatory = $false)] [switch] $Raw ) Begin { if ($User -ceq 'me') { $User = $Script:PSGSuite.AdminEmail } elseif ($User -notlike "*@*.*") { $User = "$($User)@$($Script:PSGSuite.Domain)" } $serviceParams = @{ Scope = 'https://www.googleapis.com/auth/gmail.settings.basic' ServiceType = 'Google.Apis.Gmail.v1.GmailService' User = $User } $service = New-GoogleService @serviceParams } Process { try { foreach ($fil in $FilterId) { if ($PSCmdlet.ShouldProcess("Deleting Filter Id '$fil' from user '$User'")) { Write-Verbose "Deleting Filter Id '$fil' from user '$User'" $request = $service.Users.Settings.Filters.Delete($User,$fil) $request.Execute() Write-Verbose "Filter Id '$fil' deleted successfully from user '$User'" } } } catch { if ($ErrorActionPreference -eq 'Stop') { $PSCmdlet.ThrowTerminatingError($_) } else { Write-Error $_ } } } } |