Skip to content

Commit 33641f1

Browse files
authored
Merge branch 'master' into patch-97
2 parents ed82818 + 0e25ea1 commit 33641f1

15 files changed

+274
-64
lines changed

exchange/exchange-ps/exchange/mailboxes/Add-MailboxFolderPermission.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,9 @@ Accept wildcard characters: False
123123
```
124124
125125
### -Identity
126-
The Identity parameter specifies the target mailbox and folder. The syntax is \<Mailbox\>:\\\<Folder\>. For the value of \<Mailbox\>, you can use any value that uniquely identifies the mailbox. For example:
126+
The Identity parameter specifies the target mailbox and folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
127+
128+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
127129

128130
- Name
129131

@@ -145,7 +147,7 @@ The Identity parameter specifies the target mailbox and folder. The syntax is \<
145147

146148
- User ID or user principal name (UPN)
147149

148-
Example values for the Identity parameter are [email protected]:\\Calendar or John:\\Marketing\\Reports.
150+
Example values for this parameter are `[email protected]:\Calendar` or `John:\Inbox\Reports`.
149151

150152
```yaml
151153
Type: MailboxFolderIdParameter

exchange/exchange-ps/exchange/mailboxes/Get-MailboxCalendarFolder.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,23 +57,31 @@ This example returns all provided publishing information for the specified calen
5757
## PARAMETERS
5858

5959
### -Identity
60-
The Identity parameter specifies the mailbox and folder path or folder name to the calendar folder that has the publishing settings configured. You can use the following values:
60+
The Identity parameter specifies the calendar folder that you want to view. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
6161

62-
- GUID
62+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
63+
64+
- Name
6365

64-
- ADObjectID
66+
- Alias
6567

6668
- Distinguished name (DN)
6769

68-
- Domain\\Account
70+
- Canonical DN
71+
72+
- \<domain name\>\\\<account name\>
6973

70-
- User principal name (UPN)
74+
- Email address
75+
76+
- GUID
7177

7278
- LegacyExchangeDN
7379

74-
- SmtpAddress
80+
- SamAccountName
7581

76-
- Alias
82+
- User ID or user principal name (UPN)
83+
84+
Example values for this parameter are `[email protected]:\Calendar` or `John:\Calendar`.
7785

7886
```yaml
7987
Type: MailboxFolderIdParameter

exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolder.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,9 @@ Accept wildcard characters: False
136136
```
137137
138138
### -Identity
139-
The Identity parameter specifies the mailbox and the folder that you want to view. If you don't specify the folder, the command returns information about folders in the root hierarchy of the specified mailbox. You specify values for this parameter by using the syntax: \<Mailbox Identity\>:\<Parent\>.
139+
The Identity parameter specifies the mailbox folder that you want to view. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
140140

141-
Valid values for \<Mailbox Identity\> are unique identifiers for the mailbox. For example:
141+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
142142

143143
- Name
144144

@@ -160,7 +160,9 @@ Valid values for \<Mailbox Identity\> are unique identifiers for the mailbox. Fo
160160

161161
- User ID or user principal name (UPN)
162162

163-
Values for \<Parent\> can be both the store object ID and a path string such as \\Inbox\\Personal.
163+
If you don't specify the folder, the command returns information about folders in the root hierarchy of the specified mailbox.
164+
165+
Example values for this parameter are `[email protected]:`, `John:\Inbox`.
164166

165167
```yaml
166168
Type: MailboxFolderIdParameter

exchange/exchange-ps/exchange/mailboxes/Get-MailboxFolderPermission.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@ This example returns the permissions for the Calendar folder in John's mailbox,
5555
## PARAMETERS
5656

5757
### -Identity
58-
The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: \<Mailbox\>:\\\<Folder\>. For the value of \<Mailbox\>, you can use any value that uniquely identifies the mailbox. For example:
58+
The Identity parameter specifies the mailbox folder that you want to view. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
59+
60+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
5961

6062
- Name
6163

@@ -77,7 +79,7 @@ The Identity parameter specifies the mailbox folder that you want to view. This
7779

7880
- User ID or user principal name (UPN)
7981

80-
Example values for this parameter are [email protected]:\\Calendar or John:\\Marketing\\Reports.
82+
Example values for this parameter are `[email protected]:\Calendar` or `John:\Inbox\Reports`.
8183

8284
```yaml
8385
Type: MailboxFolderIdParameter

exchange/exchange-ps/exchange/mailboxes/New-InboxRule.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,31 @@ Accept wildcard characters: False
331331
```
332332
333333
### -CopyToFolder
334-
The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. You can specify the existing folder by name, or by the store object ID and a path string (for example, \\Inbox\\Personal).
334+
The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
335+
336+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
337+
338+
- Name
339+
340+
- Alias
341+
342+
- Distinguished name (DN)
343+
344+
- Canonical DN
345+
346+
- \<domain name\>\\\<account name\>
347+
348+
- Email address
349+
350+
- GUID
351+
352+
- LegacyExchangeDN
353+
354+
- SamAccountName
355+
356+
- User ID or user principal name (UPN)
357+
358+
Example values for this parameter are `[email protected]:\Marketing` or `John:\Inbox\Reports`.
335359

336360
```yaml
337361
Type: MailboxFolderIdParameter
@@ -1409,7 +1433,31 @@ Accept wildcard characters: False
14091433
```
14101434

14111435
### -MoveToFolder
1412-
The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. You can specify the existing folder by name, or by the store object ID and a path string (for example, \\Inbox\\Personal).
1436+
The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
1437+
1438+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
1439+
1440+
- Name
1441+
1442+
- Alias
1443+
1444+
- Distinguished name (DN)
1445+
1446+
- Canonical DN
1447+
1448+
- \<domain name\>\\\<account name\>
1449+
1450+
- Email address
1451+
1452+
- GUID
1453+
1454+
- LegacyExchangeDN
1455+
1456+
- SamAccountName
1457+
1458+
- User ID or user principal name (UPN)
1459+
1460+
Example values for this parameter are `[email protected]:\Marketing` or `John:\Inbox\Reports`.
14131461

14141462
```yaml
14151463
Type: MailboxFolderIdParameter

exchange/exchange-ps/exchange/mailboxes/New-MailboxFolder.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ Accept wildcard characters: False
7373
```
7474
7575
### -Parent
76-
The Parent parameter specifies values of the mailbox identity and the parent folder under which the new folder is to be created. If the parent folder isn't specified, the cmdlet creates the folder in the root folder hierarchy of the specified mailbox. You specify values for this parameter by using the syntax: \<Mailbox Identity\>:\<Parent\>
76+
The Parent parameter specifies where to create the new mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
7777

78-
Valid values for \<Mailbox Identity\> are unique identifiers for the mailbox. For example:
78+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
7979

8080
- Name
8181

@@ -97,7 +97,9 @@ Valid values for \<Mailbox Identity\> are unique identifiers for the mailbox. Fo
9797

9898
- User ID or user principal name (UPN)
9999

100-
Values for \<Parent\> can be both the store object ID and a path string such as "\\Inbox\\Personal".
100+
If you don't specify the parent folder, the command creates the folder in the root folder hierarchy of the specified mailbox.
101+
102+
Example values for this parameter are `[email protected]:`, `John:\Inbox`
101103

102104
```yaml
103105
Type: MailboxFolderIdParameter

exchange/exchange-ps/exchange/mailboxes/New-SweepRule.md

Lines changed: 48 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,31 @@ Accept wildcard characters: False
112112
```
113113
114114
### -DestinationFolder
115-
The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder based on the conditions of the rule.
115+
The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
116116

117-
The default value is Deleted Items.
117+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
118+
119+
- Name
120+
121+
- Alias
122+
123+
- Distinguished name (DN)
124+
125+
- Canonical DN
126+
127+
- \<domain name\>\\\<account name\>
128+
129+
- Email address
130+
131+
- GUID
132+
133+
- LegacyExchangeDN
134+
135+
- SamAccountName
136+
137+
- User ID or user principal name (UPN)
138+
139+
Example values for this parameter are `[email protected]:\Unimportant` or `John:\Inbox\Misc`. The default value is `MailboxID:\Deleted Items`.
118140

119141
```yaml
120142
Type: MailboxFolderIdParameter
@@ -336,9 +358,31 @@ Accept wildcard characters: False
336358
```
337359

338360
### -SourceFolder
339-
The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder.
361+
The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
362+
363+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
364+
365+
- Name
366+
367+
- Alias
368+
369+
- Distinguished name (DN)
370+
371+
- Canonical DN
372+
373+
- \<domain name\>\\\<account name\>
374+
375+
- Email address
376+
377+
- GUID
378+
379+
- LegacyExchangeDN
380+
381+
- SamAccountName
382+
383+
- User ID or user principal name (UPN)
340384

341-
The default value is Inbox.
385+
Example values for this parameter are `[email protected]:\Marketing` or `John:\Inbox\Reports`. The default value is `MailboxID:\Inbox`.
342386

343387
```yaml
344388
Type: MailboxFolderIdParameter

exchange/exchange-ps/exchange/mailboxes/Set-InboxRule.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,31 @@ Accept wildcard characters: False
283283
```
284284
285285
### -CopyToFolder
286-
The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. You can specify the existing folder by name, or by the store object ID and a path string (for example, \\Inbox\\Personal).
286+
The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
287+
288+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
289+
290+
- Name
291+
292+
- Alias
293+
294+
- Distinguished name (DN)
295+
296+
- Canonical DN
297+
298+
- \<domain name\>\\\<account name\>
299+
300+
- Email address
301+
302+
- GUID
303+
304+
- LegacyExchangeDN
305+
306+
- SamAccountName
307+
308+
- User ID or user principal name (UPN)
309+
310+
Example values for this parameter are `[email protected]:\Marketing` or `John:\Inbox\Reports`.
287311

288312
```yaml
289313
Type: MailboxFolderIdParameter
@@ -1377,7 +1401,31 @@ Accept wildcard characters: False
13771401
```
13781402

13791403
### -MoveToFolder
1380-
The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. You can specify the existing folder by name, or by the store object ID and a path string (for example, \\Inbox\\Personal).
1404+
The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
1405+
1406+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
1407+
1408+
- Name
1409+
1410+
- Alias
1411+
1412+
- Distinguished name (DN)
1413+
1414+
- Canonical DN
1415+
1416+
- \<domain name\>\\\<account name\>
1417+
1418+
- Email address
1419+
1420+
- GUID
1421+
1422+
- LegacyExchangeDN
1423+
1424+
- SamAccountName
1425+
1426+
- User ID or user principal name (UPN)
1427+
1428+
Example values for this parameter are `[email protected]:\Marketing` or `John:\Inbox\Reports`.
13811429

13821430
```yaml
13831431
Type: MailboxFolderIdParameter

exchange/exchange-ps/exchange/mailboxes/Set-MailboxCalendarFolder.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,23 +62,31 @@ This example enables the calendar in Kai's mailbox to be searchable on the web.
6262
## PARAMETERS
6363

6464
### -Identity
65-
The Identity parameter specifies the mailbox and folder path or folder name to the calendar folder that has the publishing settings configured. You can use the following values:
65+
The Identity parameter specifies the calendar folder that you want to modify. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
6666

67-
- GUID
67+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
68+
69+
- Name
6870

69-
- ADObjectID
71+
- Alias
7072

7173
- Distinguished name (DN)
7274

73-
- Domain\\Account
75+
- Canonical DN
76+
77+
- \<domain name\>\\\<account name\>
7478

75-
- User principal name (UPN)
79+
- Email address
80+
81+
- GUID
7682

7783
- LegacyExchangeDN
7884

79-
- SmtpAddress
85+
- SamAccountName
8086

81-
- Alias
87+
- User ID or user principal name (UPN)
88+
89+
Example values for this parameter are `[email protected]:\Calendar` or `John:\Calendar`
8290

8391
```yaml
8492
Type: MailboxFolderIdParameter

exchange/exchange-ps/exchange/mailboxes/Set-MailboxFolderPermission.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,9 @@ Accept wildcard characters: False
145145
```
146146
147147
### -Identity
148-
The Identity parameter specifies the target mailbox and folder. The syntax is \<Mailbox\>:\\\<Folder\>. For the value of \<Mailbox\>, you can use any value that uniquely identifies the mailbox. For example:
148+
The Identity parameter specifies the target mailbox and folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`.
149+
150+
For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example:
149151

150152
- Name
151153

@@ -167,7 +169,7 @@ The Identity parameter specifies the target mailbox and folder. The syntax is \<
167169

168170
- User ID or user principal name (UPN)
169171

170-
Example values for the Identity parameter are [email protected]:\\Calendar or John:\\Marketing\\Reports.
172+
Example values for this parameter are `[email protected]:\Calendar` or `John:\Inbox\Reports`.
171173

172174
```yaml
173175
Type: MailboxFolderIdParameter

0 commit comments

Comments
 (0)