Skip to content

Commit 0fcf297

Browse files
committed
chore: Update Set-CIPPAlwaysShowFrom function documentation
1 parent c836ef6 commit 0fcf297

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

Modules/CIPPCore/Public/Set-CIPPAlwaysShowFrom.ps1

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ Function Set-CIPPAlwaysShowFrom {
88
The Set-CIPPAlwaysShowFrom function is used to set the "Always Show From" property for a specified user or all users in a specified tenant. The "Always Show From" property determines whether the from field is always shown in Outlook.
99
1010
.PARAMETER UserID
11-
Specifies the user ID for which to set the "Always Show From" property. This parameter is mandatory unless the RunOnAllUsersInTenant switch is used.
11+
Specifies the user ID for which to set the "Always Show From" property. This can be UserPrincipalName, SamAccountName, GUID or Email address.
12+
This parameter is mandatory unless the RunOnAllUsersInTenant switch is used.
1213
1314
.PARAMETER TenantFilter
14-
Specifies the tenant for which to set the "Always Show From" property.
15+
Specifies the tenant for which to set the "Always Show From" property. This parameter is mandatory.
1516
1617
.PARAMETER APIName
1718
Specifies the name of the API. The default value is "Always Show From".
@@ -20,7 +21,7 @@ Function Set-CIPPAlwaysShowFrom {
2021
Specifies the user who is executing the function.
2122
2223
.PARAMETER AlwaysShowFrom
23-
Specifies whether to set the "Always Show From" property to true or false.
24+
Specifies whether to set the "Always Show From" property to true or false. This parameter is mandatory.
2425
2526
.PARAMETER RunOnAllUsersInTenant
2627
If this switch is present, the function will set the "Always Show From" property for all users in the specified tenant.
@@ -67,7 +68,7 @@ Function Set-CIPPAlwaysShowFrom {
6768
foreach ($User in $AllUsers) {
6869
try {
6970
$null = New-ExoRequest -tenantid $TenantFilter -cmdlet 'Set-MailboxMessageConfiguration' -anchor $User.UserPrincipalName -cmdParams @{AlwaysShowFrom = $AlwaysShowFrom; Identity = $User.UserPrincipalName }
70-
Write-Host "Set Always Show From to $AlwaysShowFrom for $($User.UserPrincipalName)"
71+
# Write-Information "Set Always Show From to $AlwaysShowFrom for $($User.UserPrincipalName)"
7172
} catch {
7273
$ErrorCount++
7374
}

0 commit comments

Comments
 (0)