Get-RMEMailbox

From PowerGUI Wiki

Retrieves the mailboxes that match the criteria you specify.

Contents 1 Syntax 2 Detailed Description 3 Related Commands 4 Parameters 5 Examples 5.1 Example 1

Syntax

Get-RMEMailbox [-Container <IMapiContainer>] [-SearchFile <String>] [-ExcludeSubFolders] [-From <String>] [-To <String>] [-MessageClass <String>] [-Category <String>] [-Conversation <String>] [-Importance <Importance>] [-SearchIn <SearchIn>] [-AttachmentOptions <AttachmentOptions>] [-MailboxNameInclude <String>] [-MailboxNameExclude <String>] [-MailboxServerName <String>] [-MailboxesWithMessages] [-FolderNameInclude <String>] [-FolderNameExclude <String>] [-FolderText <String>] [-FolderSearchIn <FolderSearchIn>] [-AttachmentNameInclude <String>] [-AttachmentNameExclude <String>] [-AttachmentText <String>] [-Text <String>] [-TextCaseSensitive] [-TextWholeWord] [-MessageSizeEquals <Int32>] [-MessageSizeLess <Int32>] [-MessageSizeGreater <Int32>] [-TimeAfter <DateTime>] [-TimeBefore <DateTime>] [-TimeMatch <MatchTime>] [-MailboxSizeEquals <Int32>] [-MailboxSizeLess <Int32>] [-MailboxSizeGreater <Int32>] [-MailboxMessageCountEquals <Int32>] [-MailboxMessageCountLess <Int32>] [-MailboxMessageCountGreater <Int32>] [-FolderMessageCountEquals <Int32>] [-FolderMessageCountLess <Int32>] [-FolderMessageCountGreater <Int32>] [-AttachmentSizeEquals <Int32>] [-AttachmentSizeLess <Int32>] [-AttachmentSizeGreater <Int32>] [<CommonParameters>]

Detailed Description

The Get-RMEMailbox cmdlet retrieves the mailboxes that match the criteria you specify. You can retrieve mailboxes by various criteria, such as mailbox name, name of the Exchange Server that hosts the mailbox you want to get, mailbox size, and the number of messages contained in the mailbox you want to retrieve .

Related Commands

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Container	Specifies the container from which you want to retrieve mailboxes. Enter a variable that includes the container object or type a command or expression that gets the container object.	false	false
SearchFile	This parameter cannot be used with the Get-RMEMailbox cmdlet.	false	false
ExcludeSubFolders	Causes the command to only retrieve mailboxes from the root of the container specified in the Container parameter. If the ExcludeSubFolders parameter is omitted, mailboxes are retrieved from the root and all subfolders of the specified container.	false	false
From	Causes the command to retrieve the mailboxes that contain messages from the senders specified in this parameter.	false	false
To	Causes the command to retrieve the mailboxes that contain messages to the recipients specified in this parameter.	false	false
MessageClass	Causes the command to retrieve the mailboxes that contain messages belonging to one or more message classes specified in this parameter.	false	false
Category	Causes the command to retrieve the mailboxes that contain messages belonging to one or multiple Microsoft Outlook categories specified in this parameter.	false	false
Conversation	Causes the command to retrieve the mailboxes that contain messages belonging to one or multiple conversation threads specified in this parameter.	false	false
Importance	Causes the command to retrieve the mailboxes that contain messages of the importance specified in this parameter.	false	false
SearchIn	Specifies the message elements you want to search for the keywords specified in the Text parameter. The SearchIn parameter can take any of the following values for the message elements: Subject Body Attach MimeHeader HTMLSource If using multiple values, delimit each value with a comma.	false	false
AttachmentOptions	Causes the command to retrieve mailboxes by the message attachment criteria. This parameter can take one of the following values: 'Present' - Retrieves only those mailboxes that include messages with one or more attachments. 'NotPresent' - Retrieves only those mailboxes that include messages without any attachments. 'None' - Retrieves mailboxes regardless of message attachments.	false	false
MailboxNameInclude	Causes the command to retrieve the mailboxes whose names include the keywords specified in this parameter.	false	false
MailboxNameExclude	Causes the command to retrieve the mailboxes whose names exclude the keywords specified in this parameter.	false	false
MailboxServerName	Causes the command to retrieve the mailboxes hosted on the servers whose names include the keywords specified in this parameter.	false	false
MailboxesWithMessages	Causes the command to retrieve mailboxes that contain specific messages. If you use this parameter, specify criteria for the messages that are in the mailboxes you want to retrieve. If this parameter is omitted, the command retrieves mailboxes regardless of the messages they contain.	false	false
FolderNameInclude	Causes the command to retrieve the mailboxes that contain folders whose names include the keywords specified in this parameter.	false	false
FolderNameExclude	Causes the command to retrieve the mailboxes that contain folders whose names exclude the keywords specified in this parameter.	false	false
FolderText	Causes the command to retrieve the mailboxes that contain folders whose elements include the keywords specified in this parameter. To specify the folder elements where you want to look for keywords, use the FolderSearchIn parameter.	false	false
FolderSearchIn	Use this parameter to specify the folder elements you want to search for keywords. This parameter can take any of the following values for the folder elements: Name Description Path If using multiple values, delimit each value with a comma.	false	false
AttachmentNameInclude	Causes the command to retrieve the mailboxes that contain message attachments whose names include the keywords specified in this parameter.	false	false
AttachmentNameExclude	Causes the command to retrieve the mailboxes that contain message attachments whose names exclude the keywords specified in this parameter.	false	false
AttachmentText	Causes the command to retrieve the mailboxes with message attachments that include the keywords specified in this parameter.	false	false
Text	Causes the command to retrieve the mailboxes that include the keywords specified in this parameter.	false	false
TextCaseSensitive	Enables a case-sensitive search of keywords.	false	false
TextWholeWord	Enables search for the whole matching keywords.	false	false
MessageSizeEquals	Causes the command to retrieve the mailboxes that contain messages whose size equals the value specified in this parameter. Use this parameter to specify the message size in kilobytes.	false	false
MessageSizeLess	Causes the command to retrieve the mailboxes that contain messages whose size is less than the value specified in this parameter. Use this parameter to specify the message size in kilobytes.	false	false
MessageSizeGreater	Causes the command to retrieve the mailboxes that contain messages whose size is greater than the value specified in this parameter. Use this parameter to specify the message size in kilobytes.	false	false
TimeAfter	Specifies the start date of the time period when the messages contained in the mailboxes you want to retrieve were sent, received, created, modified, or deleted.	false	false
TimeBefore	Specifies the end date of the time period when the messages contained in the mailboxes you want to retrieve were sent, received, created, modified, or deleted.	false	false
TimeMatch	Causes the command to retrieve the mailboxes that contain messages sent, received, created, modified, or deleted on specific date and time. This parameter can take any of the following values: sent received created modified deleted If using multiple values, delimit each value with a comma.	false	false
MailboxSizeEquals	Causes the command to retrieve the mailboxes whose size equals the value specified in this parameter. Use this parameter to specify the mailbox size in kilobytes.	false	false
MailboxSizeLess	Causes the command to retrieve the mailboxes whose size is less than the value specified in this parameter. Use this parameter to specify the mailbox size in kilobytes.	false	false
MailboxSizeGreater	Causes the command to retrieve the mailboxes whose size is greater than the value specified in this parameter. Use this parameter to specify the mailbox size in kilobytes.	false	false
MailboxMessageCountEquals	Causes the command to retrieve the mailboxes where the number of messages equals the value specified in this parameter.	false	false
MailboxMessageCountLess	Causes the command to retrieve the mailboxes where the number of messages is less than the value specified in this parameter.	false	false
MailboxMessageCountGreater	Causes the command to retrieve the mailboxes where the number of messages is greater than the value specified in this parameter.	false	false
FolderMessageCountEquals	Causes the command to retrieve the mailboxes that contain folders where the number of messages equals the value specified in this parameter.	false	false
FolderMessageCountLess	Causes the command to retrieve the mailboxes that contain folders where the number of messages is less than the value specified in this parameter.	false	false
FolderMessageCountGreater	Causes the command to retrieve the mailboxes that contain folders where the number of messages is greater than the value specified in this parameter.	false	false
AttachmentSizeEquals	Causes the command to retrieve the mailboxes that include message attachments whose size equals the value specified in this parameter. Use this parameter to specify the attachment size in kilobytes.	false	false
AttachmentSizeLess	Causes the command to retrieve the mailboxes that include message attachments whose size is less than the value specified in this parameter. Use this parameter to specify the attachment size in kilobytes.	false	false
AttachmentSizeGreater	Causes the command to retrieve the mailboxes that include message attachments whose size is greater than the value specified in this parameter. Use this parameter to specify the attachment size in kilobytes.	false	false

Examples

Example 1

Attach-RMEExchangeDB "C:\Data\Edb\EdbSearchTest\EdbSearchTest.edb" | Get-RMEMailbox -MailboxNameInclude "John Doe" | Restore-RMEMailbox -TargetPath "C:\Data\Exported\Pst"

The Attach-RMEExchangeDB cmdlet connects to the EdbSearchTest.edb mailbox store database and pipes it to the Get-RMEMailbox cmdlet that retrieves the mailbox whose name is John Doe. The Restore-RMEMailbox cmdlet then restores the retrieved mailbox to a new .pst file in the "C:\Data\Exported\Pst" folder.