Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-09-18
Use the New-JournalRule cmdlet to create a journal rule in your organization.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
New-Journalrule -JournalEmailAddress
<RecipientIdParameter> -Name <String> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-Enabled <$true | $false>] [-ExpiryDate <DateTime>]
[-FullReport <$true | $false>] [-LawfulInterception
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-Recipient <SmtpAddress>]
[-Scope <Internal | External | Global>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example creates and enables a journal rule. The rule applies to all email messages that pass through the Transport service and contain at least one recipient or sender who is a member of the brokers@contoso.com distribution list.
Copy Code | |
---|---|
New-JournalRule -Name "Brokerage Communications" -JournalEmailAddress "Brokers Journal Mailbox" -Scope Global -Recipient brokers@contoso.com -Enabled $true |
Detailed Description
The New-JournalRule cmdlet creates a journal rule in your organization.
By default, new journal rules are disabled unless the
Enabled parameter is set to $true
. For more
information about how to enable a new journal rule that was created
in a disabled state, see Enable-JournalRule.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Journaling" entry in the Messaging Policy and Compliance Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
JournalEmailAddress |
Required |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter |
The JournalEmailAddress parameter specifies a recipient object to which journal reports are sent. |
Name |
Required |
System.String |
The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters long. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
Enabled |
Optional |
System.Boolean |
The Enabled parameter specifies whether the journal rule
is enabled or disabled. If the rule is disabled, it isn't applied
to any email messages. The default value is
|
ExpiryDate |
Optional |
System.DateTime |
This parameter is reserved for internal Microsoft use. |
FullReport |
Optional |
System.Boolean |
This parameter is reserved for internal Microsoft use. |
LawfulInterception |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is reserved for internal Microsoft use. |
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
This parameter is reserved for internal Microsoft use. |
Recipient |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or from a recipient are journaled. |
Scope |
Optional |
Microsoft.Exchange.MessagingPolicies.Journaling.JournalRuleScope |
The Scope parameter specifies the scope of email messages to which the journal rule is applied. Valid values for this parameter are as follows:
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.