Table of Contents
Prerequisites:
Before proceeding, ensure the following requirements are met:
Exchange Online PowerShell Module is installed.
Administrator credentials with appropriate permissions.
The exact name of the PhishArm add-in.
Step 1: Connect to Exchange Online PowerShell
Open PowerShell as Administrator.
Connect to Exchange Online by running the following command:
Connect-ExchangeOnline -UserPrincipalName [email protected]
3. Replace the “your_admin” email with your actual admin email address.
4. When prompted, enter your admin credentials.
Step 2: Run the PowerShell Script
Copy and paste the following script into PowerShell and run the script.
# Connect to Exchange Online
Connect-ExchangeOnline -UserPrincipalName [email protected]
# Define the Custom Add-In Name
$customAddInName = "PhishArm"
# Initialize the results array
$results = @()
# Get all mailboxes and check for the custom add-in
Get-Mailbox -ResultSize Unlimited | ForEach-Object {
$user = $_.PrimarySmtpAddress
try {
$addIns = Get-App -Mailbox $user
foreach ($addIn in $addIns) {
if ($addIn.DisplayName -eq $customAddInName) {
$results += [PSCustomObject]@{
UserEmail = $user
AddInName = $addIn.DisplayName
Enabled = $addIn.Enabled
AppId = $addIn.AppId
}
}
}
} catch {
Write-Host "Failed to retrieve add-ins for $user" -ForegroundColor Yellow
}
}
# Export filtered results to CSV
$results | Export-Csv -Path "C:\\PhishArmAddInReport.csv" -NoTypeInformation
Step 3: Review the Report
Navigate to C:\PhishArmAddInReport.csv.
Open the CSV file to see the following details:
UserEmail → User’s email address.
AddInName → Name of the custom add-in.
Enabled → Shows if the add-in is active (True/False).
AppId → Unique identifier of the add-in.
Troubleshooting Tips
No Data in CSV?
Verify the custom add-in name matches exactly.
Ensure users have mailboxes assigned.
Permission Errors?
Ensure your admin account has proper Exchange Online permissions.
Connection Issues?
Confirm your PowerShell module is up to date.
Check network/firewall settings.
Summary:
By following this guide, you can efficiently create a report listing all users who have received a PhishArm Outlook add-in. The CSV output provides a clear view of deployment status across your organization.