< Back
Set-CrmUserMailbox
Post
NAME Set-CrmUserMailbox
SYNOPSIS
Updates CRM user's mailibox.
SYNTAX
Set-CrmUserMailbox [-conn <CrmServiceClient>] [-UserId] <String> [-EmailAddress <String>] [-EmailServerProfile
<Guid>] [-IncomingEmailDeliveryMethod <Int32>] [-OutgoingEmailDeliveryMethod <Int32>] [-ACTDeliveryMethod <Int32>]
[<CommonParameters>]
Set-CrmUserMailbox [-conn <CrmServiceClient>] [-UserId] <String> [-EmailAddress <String>]
[-ApplyDefaultEmailSettings <SwitchParameter>] [<CommonParameters>]
Set-CrmUserMailbox [-conn <CrmServiceClient>] [-UserId] <String> [-EmailAddress <String>] [-StateCode <String>]
[-StatusCode <String>] [-ScheduleTest <SwitchParameter>] [-MarkedAsPrimaryForExchangeSync <SwitchParameter>]
[-ApproveEmail <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
The Set-CrmUserMailbox cmdlet lets you update CRM user's mailibox. Use Get-CrmUserMailbox to confirm current
values.
PARAMETERS
-conn <CrmServiceClient>
A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserId <String>
An Id of CRM user.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailAddress <String>
An EmailAddress of CRM user.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailServerProfile <Guid>
Change "Server Profile" setting of Synchronization Method. This parameter accepts Email Server Profile
record's guid. To get all profiles, use Get-CrmEmailServerProfiles command and use ProfileId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncomingEmailDeliveryMethod <Int32>
Change "Incoming Email" setting for Configure default synchronization method. This parameter accepts int. To
get all options, use Get-CrmEntityOptionSet mailbox incomingemaildeliverymethod | % Items command and use
PickListItemId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutgoingEmailDeliveryMethod <Int32>
Change "Outgoing Email" setting for Configure default synchronization method. This parameter accepts int. To
get all options, use Get-CrmEntityOptionSet mailbox outgoingemaildeliverymethod | % Items command and use
PickListItemId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ACTDeliveryMethod <Int32>
Change "Appointments, Contact, and Tasks" setting for Configure default synchronization method. This parameter
accepts int. To get all options, use Get-CrmEntityOptionSet mailbox actdeliverymethod | % Items command and
use PickListItemId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ApplyDefaultEmailSettings [<SwitchParameter>]
Specify this to apply the organization default settings
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StateCode <String>
StateCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName>
statecode | % {$_.Items}
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StatusCode <String>
StatusCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName>
statuscode | % {$_.Items}
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ScheduleTest [<SwitchParameter>]
Specify this to schedule test for the mailbox
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MarkedAsPrimaryForExchangeSync [<SwitchParameter>]
Specify this to mark the mailbox as primary mailbox to sync with Exchange Online
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ApproveEmail [<SwitchParameter>]
Specify this to approve the emailaddress.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- Example 1 --------------------------
Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -IncomingEmailDeliveryMethod 0
This example updates "Incoming Email" setting to "None".
-------------------------- Example 2 --------------------------
Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -EmailServerProfile
1b2d4b03-831e-e511-80e1-c4346bc44d24
This example updates "Server Profile" setting to specified Profile.
-------------------------- Example 3 --------------------------
Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -ApplyDefaultEmailSettings
This example updates mailbox email settings to default settings, which is in System Settings.
-------------------------- Example 4 --------------------------
Set-CrmUserMailbox -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -IncomingEmailDeliveryMethod 0
This example disables "Incoming Email" setting to "None" by omitting -conn parameter.
When omitting conn parameter, cmdlets automatically finds it.
-------------------------- Example 5 --------------------------
Set-CrmUserMailbox -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -ApplyDefaultEmailSettings
This example updates mailbox email settings to default settings, which is in System Settings by omitting -conn
parameter.
When omitting conn parameter, cmdlets automatically finds it.
-------------------------- Example 6 --------------------------
Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -StateCode Active -StatusCode Active
-ScheduleTest -MarkedAsPrimaryForExchangeSync -ApproveEmail
This example activates mailbox, approve emailaddress, schedule test and set the mailbox as primary for sync with
Exchange Online.
RELATED LINKS
SYNOPSIS
Updates CRM user's mailibox.
SYNTAX
Set-CrmUserMailbox [-conn <CrmServiceClient>] [-UserId] <String> [-EmailAddress <String>] [-EmailServerProfile
<Guid>] [-IncomingEmailDeliveryMethod <Int32>] [-OutgoingEmailDeliveryMethod <Int32>] [-ACTDeliveryMethod <Int32>]
[<CommonParameters>]
Set-CrmUserMailbox [-conn <CrmServiceClient>] [-UserId] <String> [-EmailAddress <String>]
[-ApplyDefaultEmailSettings <SwitchParameter>] [<CommonParameters>]
Set-CrmUserMailbox [-conn <CrmServiceClient>] [-UserId] <String> [-EmailAddress <String>] [-StateCode <String>]
[-StatusCode <String>] [-ScheduleTest <SwitchParameter>] [-MarkedAsPrimaryForExchangeSync <SwitchParameter>]
[-ApproveEmail <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
The Set-CrmUserMailbox cmdlet lets you update CRM user's mailibox. Use Get-CrmUserMailbox to confirm current
values.
PARAMETERS
-conn <CrmServiceClient>
A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserId <String>
An Id of CRM user.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailAddress <String>
An EmailAddress of CRM user.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailServerProfile <Guid>
Change "Server Profile" setting of Synchronization Method. This parameter accepts Email Server Profile
record's guid. To get all profiles, use Get-CrmEmailServerProfiles command and use ProfileId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncomingEmailDeliveryMethod <Int32>
Change "Incoming Email" setting for Configure default synchronization method. This parameter accepts int. To
get all options, use Get-CrmEntityOptionSet mailbox incomingemaildeliverymethod | % Items command and use
PickListItemId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutgoingEmailDeliveryMethod <Int32>
Change "Outgoing Email" setting for Configure default synchronization method. This parameter accepts int. To
get all options, use Get-CrmEntityOptionSet mailbox outgoingemaildeliverymethod | % Items command and use
PickListItemId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ACTDeliveryMethod <Int32>
Change "Appointments, Contact, and Tasks" setting for Configure default synchronization method. This parameter
accepts int. To get all options, use Get-CrmEntityOptionSet mailbox actdeliverymethod | % Items command and
use PickListItemId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ApplyDefaultEmailSettings [<SwitchParameter>]
Specify this to apply the organization default settings
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StateCode <String>
StateCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName>
statecode | % {$_.Items}
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StatusCode <String>
StatusCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName>
statuscode | % {$_.Items}
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ScheduleTest [<SwitchParameter>]
Specify this to schedule test for the mailbox
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MarkedAsPrimaryForExchangeSync [<SwitchParameter>]
Specify this to mark the mailbox as primary mailbox to sync with Exchange Online
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ApproveEmail [<SwitchParameter>]
Specify this to approve the emailaddress.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- Example 1 --------------------------
Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -IncomingEmailDeliveryMethod 0
This example updates "Incoming Email" setting to "None".
-------------------------- Example 2 --------------------------
Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -EmailServerProfile
1b2d4b03-831e-e511-80e1-c4346bc44d24
This example updates "Server Profile" setting to specified Profile.
-------------------------- Example 3 --------------------------
Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -ApplyDefaultEmailSettings
This example updates mailbox email settings to default settings, which is in System Settings.
-------------------------- Example 4 --------------------------
Set-CrmUserMailbox -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -IncomingEmailDeliveryMethod 0
This example disables "Incoming Email" setting to "None" by omitting -conn parameter.
When omitting conn parameter, cmdlets automatically finds it.
-------------------------- Example 5 --------------------------
Set-CrmUserMailbox -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -ApplyDefaultEmailSettings
This example updates mailbox email settings to default settings, which is in System Settings by omitting -conn
parameter.
When omitting conn parameter, cmdlets automatically finds it.
-------------------------- Example 6 --------------------------
Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -StateCode Active -StatusCode Active
-ScheduleTest -MarkedAsPrimaryForExchangeSync -ApproveEmail
This example activates mailbox, approve emailaddress, schedule test and set the mailbox as primary for sync with
Exchange Online.
RELATED LINKS