Get-MailflowStatusReport

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Module:

ExchangePowerShell

Applies to:

Exchange Online

This cmdlet is available only in the cloud-based service.

Use the Get-MailflowStatusReport cmdlet to return the message counts for a specific date range organized by the final disposition of the message for the last 90 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Get-MailflowStatusReport
   [-Direction <MultiValuedProperty>]
   [-Domain <MultiValuedProperty>]
   [-EndDate <System.DateTime>]
   [-EventType <MultiValuedProperty>]
   [-Page <Int32>]
   [-PageSize <Int32>]
   [-ProbeTag <String>]
   [-StartDate <System.DateTime>]
   [<CommonParameters>]

Description

This cmdlet returns the following information:

• Date
• Direction
• Event Type
• Count

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

Get-MailFlowStatusReport -StartDate 06-01-2020 -EndDate 06-10-2020 -Direction Inbound,Outbound -EventType GoodMail,EdgeBlockSpam

This example returns inbound and outbound messages were classified as GoodMail or EdgeBlockSpam in the specified date range.

Parameters

-Direction

The Direction parameter filters the results by the direction of the message. Valid values are:

• Inbound
• IntraOrg
• Outbound

You can specify multiple value separated by commas.

Type:	MultiValuedProperty
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-Domain

This parameter is reserved for internal Microsoft use.

Type:	MultiValuedProperty
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-EndDate

The EndDate parameter specifies the end date of the date range.

Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".

Type:	System.DateTime
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-EventType

The EventType parameter filters the report by the event type. Valid values are:

• EdgeBlockSpam
• EmailMalware
• EmailPhish
• GoodMail
• SpamDetections
• TransportRules

You can specify multiple values separated by commas.

Type:	MultiValuedProperty
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-Page

This parameter is reserved for internal Microsoft use.

Type:	Int32
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-PageSize

This parameter is reserved for internal Microsoft use.

Type:	Int32
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-ProbeTag

This parameter is reserved for internal Microsoft use.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-StartDate

The StartDate parameter specifies the start date of the date range.

Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".

Type:	System.DateTime
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

Inputs

Outputs