Get-RMEFolder
From PowerGUI Wiki
Retrieves the folders that match the criteria you specify.
Contents |
Syntax
Get-RMEFolder [-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>]
Get-RMEFolder [-Container <IMapiContainer>] [[-Path] <String>] [<CommonParameters>]
Detailed Description
The Get-RMEFolder cmdlet retrieves the folders that match the criteria you specify. You can retrieve folders by various criteria, such as folder name, number of messages contained in folder, and time and date of folder creation.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Container | Specifies the container from which you want to retrieve folders. Enter a variable that includes the container object or type a command or expression that gets the container object. | false | false | |
| SearchFile | Specifies the full path to the Recovery Manager Search (.rmxs) file that holds search criteria for the folders you want to retrieve. The search criteria in the specified file override all other parameters of this cmdlet. | false | false | |
| ExcludeSubFolders | Causes the command to only retrieve folders from the root of the container specified in the Container parameter. If the ExcludeSubFolders parameter is omitted, folders are retrieved from the root and all subfolders of the specified container. | false | false | |
| From | Causes the command to retrieve the folders that contain messages from the senders specified in this parameter. | false | false | |
| To | Causes the command to retrieve the folders that contain messages to the recipients specified in this parameter. | false | false | |
| MessageClass | Causes the command to retrieve the folders that contain messages belonging to one or more message classes specified in this parameter. | false | false | |
| Category | Causes the command to retrieve the folders that contain messages belonging to one or more Microsoft Outlook categories specified in this parameter. | false | false | |
| Conversation | Causes the command to retrieve the folders that contain messages belonging to one or more conversation threads specified in this parameter. | false | false | |
| Importance | Causes the command to retrieve the folders containing messages that have 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. This parameter can take any of the following values for the message elements:
If using multiple values, delimit each value with a comma. | false | false | |
| AttachmentOptions | Causes the command to retrieve folders by the message attachment criteria. This parameter can take one of the following values:
| false | false | |
| MailboxNameInclude | Causes the command to retrieve folders from the mailboxes whose names include the keywords specified in this parameter. | false | false | |
| MailboxNameExclude | Causes the command to retrieve folders from the mailboxes whose names exclude the keywords specified in this parameter. | false | false | |
| MailboxServerName | Causes the command to retrieve the folders that are in the mailboxes hosted on the servers whose names include the keywords specified in this parameter. | false | false | |
| MailboxesWithMessages | This parameter cannot be used with the Get-RMEFolder cmdlet. | false | false | |
| FolderNameInclude | Causes the command to retrieve the folders whose names include the keywords specified in this parameter. | false | false | |
| FolderNameExclude | Causes the command to retrieve the folders whose names exclude the keywords specified in this parameter. | false | false | |
| FolderText | Causes the command to retrieve the folders whose elements contain 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:
If using multiple values, delimit each value with a comma. | false | false | |
| AttachmentNameInclude | Causes the command to retrieve the folders that contain message attachments whose names include the keywords specified in this parameter. | false | false | |
| AttachmentNameExclude | Causes the command to retrieve the folders that contain message attachments whose names exclude the keywords specified in this parameter. | false | false | |
| AttachmentText | Causes the command to retrieve the folders that include message attachments containing the keywords specified in this parameter. | false | false | |
| Text | Causes the command to retrieve the folders 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 folders that contain messages whose size equals the value specified in this parameter. | false | false | |
| MessageSizeLess | Causes the command to retrieve the folders that contain messages whose size is less than the value specified in this parameter. | false | false | |
| MessageSizeGreater | Causes the command to retrieve the folders that contain messages whose size is greater than the value specified in this parameter. | false | false | |
| TimeAfter | Specifies the start date of the time period when the messages contained in the folders 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 folders you want to retrieve were sent, received, created, modified, or deleted. | false | false | |
| TimeMatch | Causes the command to retrieve the folders that contain messages sent, received, created, modified, or deleted on specific date and time. This parameter can take any of the following values:
If using multiple values, delimit each value with a comma. | false | false | |
| MailboxSizeEquals | Causes the command to retrieve folders from 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 folders from 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 folders from 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 folders from the mailboxes where the number of messages equals the value specified in this parameter. | false | false | |
| MailboxMessageCountLess | Causes the command to retrieve folders from the mailboxes where the number of messages is less than the value specified in this parameter. | false | false | |
| MailboxMessageCountGreater | Causes the command to retrieve folders from 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 folders where the number of messages equals the value specified in this parameter. | false | false | |
| FolderMessageCountLess | Causes the command to retrieve the folders where the number of messages is less than the value specified in this parameter. | false | false | |
| FolderMessageCountGreater | Causes the command to retrieve the folders where the number of messages is greater than the value specified in this parameter. | false | false | |
| AttachmentSizeEquals | Causes the command to retrieve the folders 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 folders 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 folders 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 | |
| Path | Causes the command to retrieve folders located at the path specified in this parameter. | false | false |
Examples
Example 1
$target = Attach-RMEExchangeMailbox "S2K2000C" "Administrator" | Get-RMEFolder "Restored" C:\PS>Attach-RMEExchangeDB "C:\Data\Edb\EdbSearchTest\EdbSearchTest.edb" | Get-RMEFolder "John Doe\Inbox" | Get-RMEMessage | Restore-RMEMessage -TargetFolder $target
In the first line of this example, the Attach-RMEExchangeMailbox cmdlet connects to the Administrator mailbox hosted on the Exchange Server named S2K2000C. The mailbox object is then piped to the Get-RMEFolder cmdlet that retrieves the Restored folder from the mailbox. The Restored folder object is then saved in the $target variable.
In the second line of this example, a connection is established to the EdbSearchTest.edb mailbox store database, and all messages are retrieved from the Inbox folder in the John Doe mailbox. The retrieved messages are then restored to the folder saved in the $target variable.
