Edit

Set-UserBriefingConfig

  • Reference
Module:
ExchangePowerShell
Applies to:
Exchange Online

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Set-UserBriefingConfig cmdlet to enable or disable the Briefing email for a user. For more details about configuring the Briefing email, see Configure Briefing email.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Set-UserBriefingConfig
   -Identity <String>
   -Enabled <Boolean>
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

Description

This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:

  • Global Administrator
  • Exchange Administrator
  • Insights Administrator

To learn more about administrator role permissions in Microsoft Entra ID, see Role template IDs.

Examples

Example 1

Set-UserBriefingConfig -Identity lila@contoso.com -Enabled $true

This example enables the Briefing email for lila@contoso.com.

Parameters

-Enabled

The Enabled parameter specifies whether to enable or disable the Briefing email for a specified user's mailbox. Valid values are:

  • $true: The daily briefing message is enabled.
  • $false: The daily briefing message is disabled. This is the default value.
Type:Boolean
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Identity

The Identity parameter specifies the user that you want to modify (for example, lila@contoso.onmicrosoft.com).

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-ResultSize

This parameter is reserved for internal Microsoft use.

Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online