Get-InboxRule
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
受信ボックス ルールのプロパティを表示するには、Get-InboxRule コマンドレットを使用します。 受信ボックス ルールを使用して、指定された条件を基に、受信ボックス内のメッセージを処理し、指定されたフォルダーへのメッセージの移動やメッセージの削除などのアクションを実行します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Get-InboxRule
[[-Identity] <InboxRuleIdParameter>]
[-BypassScopeCheck]
[-DescriptionTimeFormat <String>]
[-DescriptionTimeZone <ExTimeZoneValue>]
[-DomainController <Fqdn>]
[-IncludeHidden]
[-Mailbox <MailboxIdParameter>]
[-SweepRules]
[<CommonParameters>]
説明
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
注: このコマンドレットは、Exchange Onlineの組織管理役割グループView-Onlyメンバー、または Azure Active Directory のグローバル閲覧者ロールでは機能しません。
例
例 1
Get-InboxRule -Mailbox Joe@Contoso.com
この例では、メールボックスのすべての受信トレイ ルールを取得します Joe@Contoso.com。
例 2
Get-InboxRule "ReceivedLastYear" -Mailbox joe@contoso.com -DescriptionTimeFormat "mm/dd/yyyy" -DescriptionTimeZone "Pacific Standard Time"
次の使用例は、規則の作成時に ReceivedBeforeDate パラメーターが設定されたメールボックス joe@contoso.com から受信トレイ ルール ReceivedLastYear を取得します。 この例では、DescriptionTimeFormat パラメーターおよび DescriptionTimeZone パラメーターは、このルールの Description プロパティで、時刻およびタイムゾーンの形式を指定するために使用されます。
パラメーター
-BypassScopeCheck
BypassScopeCheck スイッチは、コマンドを実行しているユーザーの範囲チェックを省略するかどうかを指定します。 このスイッチで値を指定する必要はありません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DescriptionTimeFormat
DescriptionTimeFormat パラメーターは、ルールの説明の時刻値の形式を指定します。 例:
mm/dd/yyyy(mm は 2 桁の月)、dd は 2 桁の日、yyyy は 4 桁の年です。
Type: | String |
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 |
-DescriptionTimeZone
DescriptionTimeZone パラメーターは、ルールの説明の時刻値に使用されるタイム ゾーンを指定します。
$false: ルールまたはポリシーは無効です。
使用可能な値を確認するには、次のコマンドを実行します。 $TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display
値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。 既定値は、Exchange サーバーのタイム ゾーン設定です。
Type: | ExTimeZoneValue |
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 |
-DomainController
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、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 |
-Identity
Identity パラメーターは、表示する受信トレイ ルールを指定します。 ルールを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- RuleIdentity プロパティ (たとえば、16752869479666417665)。
- Exchange Online:
MailboxAlias\RuleIdentity
(例:rzaher\16752869479666417665
)。 - オンプレミス Exchange:
MailboxCanonicalName\RuleIdentity
(例:contoso.com/Users/Rick Zaher\16752869479666417665
)。
Type: | InboxRuleIdParameter |
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 |
-IncludeHidden
IncludeHidden スイッチは、非表示の受信トレイ ルールを結果に含めるかどうかを指定します。 このスイッチで値を指定する必要はありません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Mailbox
Mailbox パラメーターは、受信トレイ ルールを含むメールボックスを指定します。 メールボックスを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- Domain\Username
- 電子メール アドレス
- GUID
- LegacyExchangeDN
- SamAccountName
- ユーザー ID またはユーザー プリンシパル名 (UPN)
Type: | MailboxIdParameter |
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 |
-SweepRules
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
SweepRules スイッチは、結果にスイープ ルールのみを返すかどうかを指定します。 このスイッチで値を指定する必要はありません。
スイープ ルールは、受信トレイをクリーンに保つために定期的に実行されます。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。