Edit

Share via

Send-FsrmTestEmail

  • Reference
Module:
FileServerResourceManager

Sends a test email message.

Syntax

Send-FsrmTestEmail
    [-AsJob]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    -ToEmailAddress <String>
    [-Confirm]
    [-WhatIf]

Description

The Send-FsrmTestEmail cmdlet sends an email message to test the email settings in File Server Resource Manager (FSRM). This cmdlet tests the SMTP server that you specify in the Set-FsrmSetting cmdlet. The subject and message body are predefined, localized text.

Examples

Example 1: Send a test email

PS C:\>Send-FsrmTestEmail -ToEmailAddress "admin@contoso.com"

This command sends a test email message to admin@contoso.com.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ToEmailAddress

Specifies a valid email address.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False