Remove-HostedEmailAccount
Remove-HostedEmailAccount
Removes the hosted email account assigned to a local user account.
Syntax
Parameter Set: Default
Remove-HostedEmailAccount [-LocalAccountName] <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-HostedEmailAccount cmdlet removes the hosted email account that is assigned to a local user account. The cmdlet removes the hosted email account from Windows Server Essentials that is provided by a hosted email service.
Parameters
-LocalAccountName<String>
Specifies the name of a local Active Directory user account. The cmdlet removes the hosted email account that is assigned to the local user account that you specify.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
System.String
LocalAccountName
Type: System.String
Description: local user name
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Removes a hosted email account
This command removes the hosted email account that is assigned to the local user account named PattiFuller.
PS C:\> Remove-HostedEmailAccount -LocalAccountName "PattiFuller"
PS C:\>