Merge pull request KelvinTegelaar#1392 from Zacgoose/dev

feat: Create Invoke-ExecSetRetentionHold function

Author: KelvinTegelaar

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Email-Exchange/Administration/Invoke-ExecSetRetentionHold.ps1

@@ -0,0 +1,50 @@
+function Invoke-ExecSetRetentionHold {
+    <#
+    .FUNCTIONALITY
+        Entrypoint
+    .ROLE
+        Exchange.Mailbox.ReadWrite
+    #>
+    [CmdletBinding()]
+    param($Request, $TriggerMetadata)
+
+    $APIName = $Request.Params.CIPPEndpoint
+    $Headers = $Request.Headers
+    Write-LogMessage -Headers $Headers -API $APIName -tenant $TenantFilter -message 'Accessed this API' -Sev 'Debug'
+
+    # Interact with the query or body of the request
+    $TenantFilter = $Request.Body.tenantFilter
+    $RetentionHoldState = -not $Request.Body.disable -as [bool]
+    $Identity = $Request.Body.Identity
+    $UserPrincipalName = $Request.Body.UPN
+
+    # Set the parameters for the EXO request
+    $ExoRequest = @{
+        tenantid  = $TenantFilter
+        cmdlet    = 'Set-Mailbox'
+        cmdParams = @{
+            Identity              = $Identity
+            RetentionHoldEnabled = $RetentionHoldState
+        }
+    }
+
+    # Execute the EXO request
+    try {
+        $null = New-ExoRequest @ExoRequest
+        $Results = "Retention hold for $UserPrincipalName with Id $Identity has been set to $RetentionHoldState"
+        
+        Write-LogMessage -API $APIName -tenant $TenantFilter -message $Results -sev Info
+        $StatusCode = [HttpStatusCode]::OK
+    } catch {
+        $ErrorMessage = Get-CippException -Exception $_
+        $Results = "Could not set retention hold for $UserPrincipalName with Id $Identity to $RetentionHoldState. Error: $($ErrorMessage.NormalizedError)"
+        Write-LogMessage -API $APIName -tenant $TenantFilter -message $Results -sev Error -LogData $ErrorMessage
+        $StatusCode = [HttpStatusCode]::InternalServerError
+    }
+
+    # Associate values to output bindings by calling 'Push-OutputBinding'.
+    Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
+            StatusCode = $StatusCode
+            Body       = @{ Results = $Results }
+        })
+}

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Email-Exchange/Administration/Invoke-ListMailboxes.ps1

@@ -17,7 +17,7 @@ Function Invoke-ListMailboxes {
     # Interact with query parameters or the body of the request.
     $TenantFilter = $Request.Query.tenantFilter
     try {
-        $Select = 'id,ExchangeGuid,ArchiveGuid,UserPrincipalName,DisplayName,PrimarySMTPAddress,RecipientType,RecipientTypeDetails,EmailAddresses,WhenSoftDeleted,IsInactiveMailbox,ForwardingSmtpAddress,DeliverToMailboxAndForward,ForwardingAddress,HiddenFromAddressListsEnabled,ExternalDirectoryObjectId,MessageCopyForSendOnBehalfEnabled,MessageCopyForSentAsEnabled,PersistedCapabilities,LitigationHoldEnabled,LitigationHoldDate,LitigationHoldDuration,ComplianceTagHoldApplied,RetentionHoldEnabled'
+        $Select = 'id,ExchangeGuid,ArchiveGuid,UserPrincipalName,DisplayName,PrimarySMTPAddress,RecipientType,RecipientTypeDetails,EmailAddresses,WhenSoftDeleted,IsInactiveMailbox,ForwardingSmtpAddress,DeliverToMailboxAndForward,ForwardingAddress,HiddenFromAddressListsEnabled,ExternalDirectoryObjectId,MessageCopyForSendOnBehalfEnabled,MessageCopyForSentAsEnabled,PersistedCapabilities,LitigationHoldEnabled,LitigationHoldDate,LitigationHoldDuration,ComplianceTagHoldApplied,RetentionHoldEnabled,InPlaceHolds'
         $ExoRequest = @{
             tenantid  = $TenantFilter
             cmdlet    = 'Get-Mailbox'
@@ -76,6 +76,7 @@ Function Invoke-ListMailboxes {
         @{ Name = 'LicensedForLitigationHold'; Expression = { ($_.PersistedCapabilities -contains 'BPOS_S_DlpAddOn' -or $_.PersistedCapabilities -contains 'BPOS_S_Enterprise') } },
         ComplianceTagHoldApplied,
         RetentionHoldEnabled,
+        InPlaceHolds,
 
         $StatusCode = [HttpStatusCode]::OK
     } catch {

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Identity/Administration/Users/Invoke-ListUserMailboxDetails.ps1

@@ -177,13 +177,50 @@ function Invoke-ListUserMailboxDetails {
         $TotalArchiveItemCount = try { [math]::Round($ArchiveSizeRequest.ItemCount, 2) } catch { 0 }
     }
 
+    # Parse InPlaceHolds to determine hold types if avaliable
+    $InPlaceHold             = $false
+    $EDiscoveryHold          = $false
+    $PurviewRetentionHold    = $false
+    $ExcludedFromOrgWideHold = $false
+
+    # Check if InPlaceHolds property exists and has values
+    if ($MailboxDetailedRequest.InPlaceHolds) {
+        foreach ($hold in $MailboxDetailedRequest.InPlaceHolds) {
+            # eDiscovery hold - starts with UniH
+            if ($hold -like 'UniH*') {
+                $EDiscoveryHold = $true
+            }
+            # In-Place Hold - no prefix or starts with cld
+            # Check if it doesn't match any of the other known prefixes
+            elseif (($hold -like 'cld*' -or 
+                    ($hold -notlike 'UniH*' -and 
+                    $hold -notlike 'mbx*' -and 
+                    $hold -notlike 'skp*' -and 
+                    $hold -notlike '-mbx*'))) {
+                $InPlaceHold = $true
+            }
+            # Microsoft Purview retention policy - starts with mbx or skp
+            elseif ($hold -like 'mbx*' -or $hold -like 'skp*') {
+                $PurviewRetentionHold = $true
+            }
+            # Excluded from organization-wide Microsoft Purview retention policy - starts with -mbx
+            elseif ($hold -like '-mbx*') {
+                $ExcludedFromOrgWideHold = $true
+            }
+        }
+    }
+
     # Build the GraphRequest object
     $GraphRequest = [ordered]@{
         ForwardAndDeliver        = $MailboxDetailedRequest.DeliverToMailboxAndForward
         ForwardingAddress        = $ForwardingAddress
         LitigationHold           = $MailboxDetailedRequest.LitigationHoldEnabled
         RetentionHold            = $MailboxDetailedRequest.RetentionHoldEnabled
         ComplianceTagHold        = $MailboxDetailedRequest.ComplianceTagHoldApplied
+        InPlaceHold              = $InPlaceHold
+        EDiscoveryHold           = $EDiscoveryHold
+        PurviewRetentionHold     = $PurviewRetentionHold
+        ExcludedFromOrgWideHold  = $ExcludedFromOrgWideHold
         HiddenFromAddressLists   = $MailboxDetailedRequest.HiddenFromAddressListsEnabled
         EWSEnabled               = $CASRequest.EwsEnabled
         MailboxMAPIEnabled       = $CASRequest.MAPIEnabled