Skip to content

FEAT: Add support for auto-expanding archive in mailbox management #1331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
using namespace System.Net

Function Invoke-ExecEnableArchive {
<#
.FUNCTIONALITY
Entrypoint
.ROLE
Exchange.Mailbox.ReadWrite
#>
[CmdletBinding()]
param($Request, $TriggerMetadata)

$APIName = $Request.Params.CIPPEndpoint
$Headers = $Request.Headers
Write-LogMessage -headers $Headers -API $APIName -message 'Accessed this API' -Sev 'Debug'

# Interact with query parameters or the body of the request.
$TenantFilter = $Request.Query.tenantFilter ?? $Request.Body.tenantFilter
$ID = $Request.Query.id ?? $Request.Body.id
$UserName = $Request.Query.username ?? $Request.Body.username

Try {
$ResultsArch = Set-CIPPMailboxArchive -userid $ID -tenantFilter $TenantFilter -APIName $APIName -Headers $Headers -ArchiveEnabled $true -Username $UserName
if ($ResultsArch -like 'Failed to set archive*') { throw $ResultsArch }
$StatusCode = [HttpStatusCode]::OK
} catch {
$ResultsArch = $_.Exception.Message
$StatusCode = [HttpStatusCode]::InternalServerError
}
$Results = [pscustomobject]@{'Results' = "$ResultsArch" }
# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
StatusCode = $StatusCode
Body = $Results
})

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
function Invoke-ExecEnableAutoExpandingArchive {
<#
.FUNCTIONALITY
Entrypoint
.ROLE
Exchange.Mailbox.ReadWrite
#>
[CmdletBinding()]
param($Request, $TriggerMetadata)

$APIName = $Request.Params.CIPPEndpoint
$Headers = $Request.Headers
Write-LogMessage -headers $Headers -API $APIName -message 'Accessed this API' -Sev 'Debug'

# Interact with query parameters or the body of the request.
$ID = $Request.Body.ID
$TenantFilter = $Request.Body.tenantFilter
$Username = $Request.Body.username

try {
$Result = Set-CIPPMailboxArchive -TenantFilter $TenantFilter -UserID $ID -Username $Username -Headers $Headers -AutoExpandingArchive
$StatusCode = [HttpStatusCode]::OK
} catch {
$Result = $_.Exception.Message
$StatusCode = [HttpStatusCode]::InternalServerError
}

Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
StatusCode = $StatusCode
Body = @{Results = "$Result" }
})
}
24 changes: 16 additions & 8 deletions Modules/CIPPCore/Public/Set-CIPPMailboxArchive.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,27 @@ function Set-CIPPMailboxArchive {
$Username,
$APIName = 'Mailbox Archive',
$TenantFilter,
[bool]$ArchiveEnabled
[bool]$ArchiveEnabled,
[switch]$AutoExpandingArchive
)

try {
if (!$Username) { $Username = $UserID }
$null = New-ExoRequest -tenantid $TenantFilter -cmdlet 'Enable-Mailbox' -cmdParams @{Identity = $UserID; Archive = $ArchiveEnabled }
$Message = "Successfully set archive for $Username to $ArchiveEnabled"
Write-LogMessage -Headers $Headers -API $APINAME -tenant $TenantFilter -message $Message -Sev 'Info'
if ([string]::IsNullOrWhiteSpace($Username)) { $Username = $UserID }
$OperationType = if ($AutoExpandingArchive.IsPresent -eq $true) { 'auto-expanding archive' } else { 'archive' }
if ($AutoExpandingArchive.IsPresent -eq $true) {
$null = New-ExoRequest -tenantid $TenantFilter -cmdlet 'Enable-Mailbox' -cmdParams @{Identity = $UserID; AutoExpandingArchive = $true }
$Message = "Successfully enabled $OperationType for $Username"
} else {
$null = New-ExoRequest -tenantid $TenantFilter -cmdlet 'Enable-Mailbox' -cmdParams @{Identity = $UserID; Archive = $ArchiveEnabled }
$Message = "Successfully set $OperationType for $Username to $ArchiveEnabled"
}

Write-LogMessage -Headers $Headers -API $APIName -tenant $TenantFilter -message $Message -Sev 'Info'
return $Message
} catch {
$ErrorMessage = Get-CippException -Exception $_
$Message = "Failed to set archive for $Username. Error: $($ErrorMessage.NormalizedError)"
Write-LogMessage -Headers $Headers -API $APINAME -tenant $TenantFilter -message $Message -Sev 'Error' -LogData $ErrorMessage
return $Message
$Message = "Failed to set $OperationType for $Username. Error: $($ErrorMessage.NormalizedError)"
Write-LogMessage -Headers $Headers -API $APIName -tenant $TenantFilter -message $Message -Sev 'Error' -LogData $ErrorMessage
throw $Message
}
}