You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Note**: This parameter is not available or functional on users objects in Exchange Online.
133
-
134
132
The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch.
135
133
136
134
After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold.
**Note**: This parameter is not available or functional on users objects in Exchange Online.
263
+
This parameter is available only in on-premises Exchange.
264
264
265
265
The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch.
266
266
@@ -270,7 +270,7 @@ After you disable or remove a mailbox, you can't include it in a discovery searc
270
270
Type: SwitchParameter
271
271
Parameter Sets: (All)
272
272
Aliases:
273
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
273
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
This cmdlet is available only in on-premises Exchange. Site mailboxes were removed from Exchange Online and SharePoint Online in 2017.
16
+
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
17
+
18
+
Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028).
17
19
18
20
Use the Get-SiteMailbox cmdlet to view information about site mailboxes. This cmdlet is primarily used by Microsoft SharePoint and Exchange to display information to users in the user interface. However, you may find it helpful for discovering information such as the site mailbox's owners, members, and lifecycle status.
19
21
@@ -61,6 +63,34 @@ This example queries for site mailboxes that are marked for deletion and removes
61
63
62
64
## PARAMETERS
63
65
66
+
### -Identity
67
+
The Identity parameter specifies the identity of the site mailbox. You can use any value that uniquely identifies the mailbox. For example:
68
+
69
+
- Name
70
+
71
+
- Alias
72
+
73
+
- Distinguished name (DN)
74
+
75
+
- Canonical DN
76
+
77
+
- Email address
78
+
79
+
- GUID
80
+
81
+
```yaml
82
+
Type: RecipientIdParameter
83
+
Parameter Sets: (All)
84
+
Aliases:
85
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
86
+
87
+
Required: False
88
+
Position: 1
89
+
Default value: None
90
+
Accept pipeline input: True
91
+
Accept wildcard characters: False
92
+
```
93
+
64
94
### -Anr
65
95
The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:
66
96
@@ -78,7 +108,7 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol
78
108
Type: String
79
109
Parameter Sets: (All)
80
110
Aliases:
81
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
111
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
82
112
83
113
Required: False
84
114
Position: Named
@@ -96,7 +126,7 @@ If you run the command without this parameter, and you aren't a member or owner
96
126
Type: SwitchParameter
97
127
Parameter Sets: (All)
98
128
Aliases:
99
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
129
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
This parameter is available only in on-premises Exchange.
140
+
109
141
The DeletedSiteMailbox switch returns site mailboxes that have been marked for pending deletion. You don't need to specify a value with this switch.
110
142
111
143
When the lifecycle application in SharePoint closes a site mailbox, the site mailbox is retained for the period specified in the lifecycle policy in the closed state. The mailbox can then be reactivated by an end user or by a SharePoint administrator. After the retention period, the Exchange site mailbox that's housed in the mailbox database will have its name prepended with MDEL: to indicate that it has been marked for deletion. To free storage space and the alias, use the Remove-Mailbox cmdlet to manually remove these site mailboxes from the mailbox database.
This parameter is available only in on-premises Exchange.
160
+
127
161
The DomainController parameter specifies the ___domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the ___domain controller by its fully qualified ___domain name (FQDN). For example, dc01.contoso.com.
128
162
129
163
```yaml
@@ -139,35 +173,9 @@ Accept pipeline input: False
139
173
Accept wildcard characters: False
140
174
```
141
175
142
-
### -Identity
143
-
The Identity parameter specifies the identity of the site mailbox. You can use any value that uniquely identifies the mailbox. For example:
144
-
145
-
- Name
146
-
147
-
- Alias
148
-
149
-
- Distinguished name (DN)
150
-
151
-
- Canonical DN
152
-
153
-
- Email address
154
-
155
-
- GUID
156
-
157
-
```yaml
158
-
Type: RecipientIdParameter
159
-
Parameter Sets: (All)
160
-
Aliases:
161
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
162
-
163
-
Required: False
164
-
Position: 1
165
-
Default value: None
166
-
Accept pipeline input: True
167
-
Accept wildcard characters: False
168
-
```
169
-
170
176
### -ReadFromDomainController
177
+
This parameter is available only in on-premises Exchange.
178
+
171
179
The ReadFromDomainController switch specifies that information should be read from a ___domain controller in the user's ___domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch.
172
180
173
181
By default, the recipient scope is set to the ___domain that hosts your Exchange servers.
@@ -192,7 +200,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y
192
200
Type: Unlimited
193
201
Parameter Sets: (All)
194
202
Aliases:
195
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
203
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
This cmdlet is available only in on-premises Exchange. Site mailboxes were removed from Exchange Online and SharePoint Online in 2017.
16
+
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
17
+
18
+
Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028).
17
19
18
20
Use the Get-SiteMailboxDiagnostics cmdlet to view important event-related data for each site mailbox. This information can be used to troubleshoot site mailbox issues.
19
21
@@ -71,7 +73,7 @@ The Identity parameter specifies the site mailbox that you want to view. You can
71
73
Type: RecipientIdParameter
72
74
Parameter Sets: (All)
73
75
Aliases:
74
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
76
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
75
77
76
78
Required: True
77
79
Position: 1
@@ -89,7 +91,7 @@ If you run the command without this parameter and you aren't a member or owner o
89
91
Type: SwitchParameter
90
92
Parameter Sets: (All)
91
93
Aliases:
92
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
94
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
93
95
94
96
Required: False
95
97
Position: Named
@@ -109,7 +111,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho
109
111
Type: SwitchParameter
110
112
Parameter Sets: (All)
111
113
Aliases: cf
112
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
114
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
113
115
114
116
Required: False
115
117
Position: Named
@@ -125,7 +127,7 @@ The SendMeEmail switch specifies that the diagnostic information is sent to the
125
127
Type: SwitchParameter
126
128
Parameter Sets: (All)
127
129
Aliases:
128
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
130
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
129
131
130
132
Required: False
131
133
Position: Named
@@ -141,7 +143,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch
141
143
Type: SwitchParameter
142
144
Parameter Sets: (All)
143
145
Aliases: wi
144
-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
146
+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
0 commit comments