Export (0) Print
Expand All

New-JournalRule

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the NewJournalRule cmdlet to create a journal rule on a Hub Transport server.


new-journalrule -Name <String> -JournalEmailAddress <RecipientIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-Organization <OrganizationIdParameter>] [-Recipient <Nullable>] [-Scope <Internal | External | Global>] [-WhatIf [<SwitchParameter>]]

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 e-mail messages. The default value is $false.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

Recipient

Optional

System.Nullable

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 e-mail messages to which the journal rule is applied. Valid values for this parameter are as follows:

  • Global   Global rules process all e-mail messages that pass through a Hub Transport server. This includes e-mail messages that were already processed by the external and internal rules. The default value is Global.
  • Internal   Internal rules process e-mail messages sent and received by recipients in the Microsoft Exchange Server 2010 organization.
  • External   External rules process e-mail messages sent to recipients or from senders outside the Exchange 2010 organization.

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.

The New-JournalRule cmdlet creates a journal rule for use with the Journaling agent.

By default, new journal rules are enabled unless the Enabled parameter is set to $false. 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.

Error Description

 

Exceptions Description

This example shows how to create a new enabled journal rule. The rule applies to all e-mail messages that pass through the Hub Transport server and contain at least one recipient or sender who is a member of the brokers@contoso.com distribution list.

New-JournalRule -Name "Brokerage Communications" -JournalEmailAddress "Brokers Journal Mailbox" -Scope Global -Recipient brokers@contoso.com -Enabled $True
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft