Skip to content

Commit d2e7c21

Browse files
committed
EWS related parameter updates
Per Issue #1572
1 parent 82c8b40 commit d2e7c21

File tree

3 files changed

+79
-549
lines changed

3 files changed

+79
-549
lines changed

exchange/exchange-ps/exchange/client-access/Set-CASMailbox.md

Lines changed: 38 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Set-CASMailbox [-Identity] <MailboxIdParameter> [-ActiveSyncAllowedDeviceIDs <Mu
2222
[-ActiveSyncBlockedDeviceIDs <MultiValuedProperty>] [-ActiveSyncDebugLogging <$true | $false>]
2323
[-ActiveSyncEnabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Confirm]
2424
[-DisplayName <String>] [-DomainController <Fqdn>] [-ECPEnabled <$true | $false>]
25-
[-EmailAddresses <ProxyAddressCollection>] [-EmwsEnabled <$true | $false>]
25+
[-EmailAddresses <ProxyAddressCollection>]
2626
[-EwsAllowEntourage <$true | $false>] [-EwsAllowList <MultiValuedProperty>]
2727
[-EwsAllowMacOutlook <$true | $false>] [-EwsAllowOutlook <$true | $false>]
2828
[-EwsApplicationAccessPolicy <EnforceAllowList | EnforceBlockList>] [-EwsBlockList <MultiValuedProperty>]
@@ -320,27 +320,14 @@ Accept pipeline input: False
320320
Accept wildcard characters: False
321321
```
322322
323-
### -EmwsEnabled
324-
This parameter is available or functional only in Exchange Server 2010.
323+
### -EwsAllowEntourage
324+
The EwsAllowEntourage parameter enables or disables Exchange Web Services (EWS) access to the mailbox by Microsoft Entourage clients (for example, Entourage 2008 for Mac, Web Services Edition). Valid values are:
325325
326-
The EmwsEnabled parameter specifies whether the Exchange Management Web Service is enabled on this Client Access server.
326+
- $true: EWS access to the mailbox by Entourage clients is enabled.
327327
328-
```yaml
329-
Type: $true | $false
330-
Parameter Sets: (All)
331-
Aliases:
332-
Applicable: Exchange Server 2010
333-
Required: False
334-
Position: Named
335-
Default value: None
336-
Accept pipeline input: False
337-
Accept wildcard characters: False
338-
```
339-
340-
### -EwsAllowEntourage
341-
The EwsAllowEntourage parameter enables or disables access to the mailbox by Microsoft Entourage clients that use Exchange Web Services (for example, Entourage 2008 for Mac, Web Services Edition).
328+
- $false: EWS access to the mailbox by Entourage clients is disabled.
342329
343-
Valid input for this parameter is $true or $false. The default value is $true.
330+
- $null (blank): The setting isn't configured. This is the default value. EWS access to the mailbox by Entourage clients is controlled by the EwsAllowEntourage parameter on the Set-OrganizationConfig cmdlet (blank or $true for the organization equals enabled for the mailbox; $false for the organization equals disabled for the mailbox).
344331
345332
```yaml
346333
Type: $true | $false
@@ -355,14 +342,14 @@ Accept wildcard characters: False
355342
```
356343
357344
### -EwsAllowList
358-
The EwsAllowList parameter specifies the Exchange Web Services applications (user agent strings) that are allowed to access the mailbox.
345+
The EwsAllowList parameter specifies the applications that are allowed to access the mailbox by using EWS or REST when the EwsApplicationAccessPolicy parameter is set to EwsAllowList. Other applications that aren't specified by this parameter aren't allowed to access the mailbox by using EWS or REST. You identify the application by its user agent string value. Wildcard characters (\*) are supported.
346+
347+
The default value is $null (blank), which means no EWS or REST applications are specified.
359348
360349
To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">.
361350
362351
To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}.
363352
364-
This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceAllowList.
365-
366353
```yaml
367354
Type: MultiValuedProperty
368355
Parameter Sets: (All)
@@ -376,9 +363,13 @@ Accept wildcard characters: False
376363
```
377364
378365
### -EwsAllowMacOutlook
379-
The EwsAllowMacOutlook parameter enables or disables access to the mailbox by Outlook for Mac clients that use Exchange Web Services (for example, Outlook for Mac 2011 or later).
366+
The EwsAllowMacOutlook parameter enables or disables EWS access to the mailbox by Microsoft Outlook for Mac clients (for example, Outlook for Mac 2011 or later). Valid values are:
380367
381-
Valid input for this parameter is $true or $false. The default value is $true.
368+
- $true: EWS access to the mailbox by Outlook for Mac clients is enabled.
369+
370+
- $false: EWS access to the mailbox by Outlook for Mac clients is disabled.
371+
372+
- $null (blank): The setting isn't configured. This is the default value. EWS access to the mailbox by Outlook for Mac is controlled by the EwsAllowMacOutlook parameter on the Set-OrganizationConfig cmdlet (blank or $true on the organization equals enabled for the mailbox; $false on the organization equals disabled for the mailbox).
382373
383374
```yaml
384375
Type: $true | $false
@@ -393,7 +384,13 @@ Accept wildcard characters: False
393384
```
394385
395386
### -EwsAllowOutlook
396-
The EwsAllowOutlook parameter enables or disables access to the mailbox by Outlook clients that use Exchange Web Services. Outlook uses Exchange Web Services for free/busy, out-of-office settings, and calendar sharing.
387+
The EwsAllowOutlook parameter enables or disables EWS access to the mailbox by Microsoft Outlook clients (for example, Outlook 2007 or later for free/busy, out-of-office settings, and calendar sharing). Valid values are:
388+
389+
- $true: EWS access to the mailbox by Outlook clients is enabled.
390+
391+
- $false: EWS access to the mailbox by Outlook clients is disabled.
392+
393+
- $null (blank): The setting isn't configured. This is the default value. EWS access to the mailbox by Outlook clients is controlled by the EwsAllowOutlook parameter on the Set-OrganizationConfig cmdlet (blank or $true for the organization equals enabled for the mailbox; $false for the organization equals disabled for the mailbox).
397394
398395
```yaml
399396
Type: $true | $false
@@ -408,15 +405,15 @@ Accept wildcard characters: False
408405
```
409406
410407
### -EwsApplicationAccessPolicy
411-
The EwsApplicationAccessPolicy parameter controls access to the mailbox by using Exchange Web Services applications.
408+
The EwsApplicationAccessPolicy parameter specifies the access control method for client applications that access the mailbox by using EWS and REST. Valid values are:
412409
413-
Valid values for this parameter are:
410+
- EnforceAllowList: Specify the EWS and REST applications to allow by using the EwsAllowList parameter. EWS and REST access to the mailbox by all other applications is blocked.
414411
415-
- EnforceAllowList: Only applications specified in the EwsAllowList parameter are allowed to access the mailbox.
412+
- EnforceBlockList: Specify the EWS and REST application to block by using the EwsBlockList parameter. EWS and REST access to the mailbox by all other applications is allowed.
416413
417-
- EnforceBlockList: Applications specified in the EwsBlockList parameter aren't allowed to access the mailbox, but any other applications can access the mailbox.
414+
- $null (blank): The setting isn't configured. This is the default value. The access control method for the mailbox is defined by the EwsApplicationAccessPolicy parameter on the Set-OrganizationConfig cmdlet (blank for the organization means no EWS or REST applications are blocked from accessing the mailbox; EnforceAllowList for the organization means the EwsAllowList parameter on the organization specifies the applications that are allowed to access the mailbox; EnforceBlockList for the organization means the EwsBlockList parameter on the organization specifies the applications that are blocked from accessing the mailbox).
418415
419-
This parameter doesn't affect access to the mailbox by using Entourage, Outlook for Mac, and Outlook. Access to the mailbox by using these clients is controlled by the EwsAllowEntourage, EwsAllowMacOutlook and EwsAllowOutlook parameters.
416+
This parameter doesn't affect EWS access to the mailbox by Entourage, Outlook for Mac, and Outlook clients (access by these applications is controlled by the EwsAllowEntourage, EwsAllowMacOutlook and EwsAllowOutlook parameters).
420417
421418
```yaml
422419
Type: EnforceAllowList | EnforceBlockList
@@ -431,14 +428,14 @@ Accept wildcard characters: False
431428
```
432429
433430
### -EwsBlockList
434-
The EwsBlockList parameter specifies the Exchange Web Services applications (user agent strings) that aren't allowed to access the mailbox by using Exchange Web Services.
431+
The EwsBlockList parameter specifies the applications that aren't allowed to access the mailbox by using EWS or REST when the EwsApplicationAccessPolicy parameter is set to EnforceBlockList. All other applications that aren't specified by this parameter are allowed to access the mailbox by using EWS or REST. You identify the application by its user agent string value. Wildcard characters (\*) are supported.
432+
433+
The default value is $null (blank), which means no EWS or REST applications are specified.
435434
436435
To enter multiple values and overwrite any existing entries, use the following syntax: \<value1\>,\<value2\>,...\<valueN\>. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\<value1\>","\<value2\>",..."\<valueN\">.
437436
438437
To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\<value1\>","\<value2\>"...; Remove="\<value1\>","\<value2\>"...}.
439438
440-
This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceBlockList.
441-
442439
```yaml
443440
Type: MultiValuedProperty
444441
Parameter Sets: (All)
@@ -452,9 +449,15 @@ Accept wildcard characters: False
452449
```
453450
454451
### -EwsEnabled
455-
The EwsEnabled parameter enables or disables access to the mailbox by using Exchange Web Services clients.
452+
The EwsEnabled parameter specifies whether to globally enable or disable EWS access to the mailbox, regardless of the application that's making the request. Valid values are:
453+
454+
- $true: All EWS to the mailbox is enabled.
455+
456+
- $false: All EWS access to the mailbox is disabled. The other EWS settings in this cmdlet are ignored.
457+
458+
- $null (blank): The setting isn't configured. This is the default value. EWS access to the mailbox is controlled by the other EWS parameters (for example EwsAllowEntourage).
456459
457-
Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other Exchange Web Services settings in this cmdlet are ignored.
460+
This parameter has no affect on access to the mailbox by using REST.
458461
459462
```yaml
460463
Type: $true | $false

0 commit comments

Comments
 (0)