Get-MailboxFolder

Referência

Módulo:: ExchangePowerShell

Aplica-se a:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ou outro ambiente.

Use o cmdlet Get-MailboxFolder para exibir pastas em seu própria caixa de correio. Os administradores não podem usar esse cmdlet para exibir pastas em outras caixas de correio (o cmdlet está disponível apenas na função de usuário MyBaseOptions).

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Syntax

Get-MailboxFolder
   [[-Identity] <MailboxFolderIdParameter>]
   [-GetChildren]
   [-DomainController <Fqdn>]
   [-MailFolderOnly]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

Get-MailboxFolder
   [[-Identity] <MailboxFolderIdParameter>]
   [-Recurse]
   [-DomainController <Fqdn>]
   [-MailFolderOnly]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

Description

Esse comando verifica se a caixa de correio especificada no parâmetro Identity é uma caixa de correio válida do Exchange antes de recuperar as pastas solicitadas. O cmdlet retorna todas as pastas quando a opção MailFolderOnly não é especificada.

Para executar esse cmdlet, você precisa ter permissões. Embora este tópico liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.

Exemplos

Exemplo 1

Get-MailboxFolder -Identity :\Inbox | Format List

Este exemplo retorna informações detalhadas sobre a pasta Caixa de Entrada em sua própria caixa de correio.

Exemplo 2

Get-MailboxFolder

Este exemplo retorna uma lista de resumo das pastas raiz em sua própria caixa de correio.

Exemplo 3

Get-MailboxFolder -GetChildren -MailFolderOnly

Este exemplo retorna o primeiro nível de pastas de email em sua própria caixa de correio.

Exemplo 4

Get-MailboxFolder -Identity :\Inbox -GetChildren

Este exemplo retorna informações sobre todas as subpastas em Caixa de entrada em sua própria caixa de correio.

Exemplo 5

Get-MailboxFolder -Identity :\Inbox -Recurse

Este exemplo retorna uma lista de resumo de todos os níveis de pastas em Caixa de entrada em sua própria caixa de correio.

Parâmetros

-DomainController

Este parâmetro está disponível somente no Exchange local.

O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, dc01.contoso.com.

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-GetChildren

A opção GetChildren especifica se somente o primeiro nível de subpastas sob a pasta pai especificada deverá ser retornado. Não é preciso especificar um valor com essa opção.

Não é possível usar essa opção com a opção Recurse.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Identity

O parâmetro Identidade especifica a pasta de caixa de correio que você deseja exibir. A sintaxe é [MailboxID]:[\ParentFolder][\SubFolder].

Você só pode executar esse cmdlet em sua própria caixa de correio, portanto, não precisa (ou não pode) especificar um MailboxID valor.

Para o valor de MailboxID, você pode usar qualquer valor que identifique exclusivamente a caixa de correio. Por exemplo:

Nome
Alias
Nome diferenciado (DN)
Nome diferenciado (DN)
Domain\username
Endereço de email
GUID
LegacyExchangeDN
SamAccountName
ID de usuário ou nome UPN

Se você não especificar a pasta, o comando retornará informações sobre as pastas na raiz da hierarquia da caixa de correio especificada.

Os valores de exemplo para este parâmetro são john@contoso.com:, John:\Inbox.

Type:	MailboxFolderIdParameter
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-MailFolderOnly

A opção MailFolderOnly especifica se somente as pastas de email na caixa de correio especificada deverão ser retornadas. Não é preciso especificar um valor com essa opção.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Recurse

A opção Recurse especifica se a pasta pai especificada deverá ser retornada com todas suas subpastas. Não é preciso especificar um valor com essa opção.

Não é possível usar essa opção com a opção GetChildren.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-ResultSize

O parâmetro ResultSize especifica o número máximo de resultados a serem retornados. Caso pretenda retornar todas as solicitações correspondentes à consulta, use unlimited como valor desse parâmetro. O valor padrão é 1000.

Type:	Unlimited
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

Entradas

Input types

Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.

Saídas

Output types

Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.