Citrix Daas SDK

Test-MonitorNotificationEmailServerConfiguration

FIXME

Syntax

Test-MonitorNotificationEmailServerConfiguration
    [-InputObject] <MonitorNotificationEmailServerConfiguration>
    [-Credential <PSCredential>]
    -EmailAddresses <String[]>
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->
Test-MonitorNotificationEmailServerConfiguration
    -ProtocolType <EmailProtocolType>
    -ServerName <String>
    -PortNumber <Int32>
    -SenderEmailAddress <String>
    -RequiresAuthentication <Boolean>
    [-Credential <PSCredential>]
    -EmailAddresses <String[]>
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->
Test-MonitorNotificationEmailServerConfiguration
    -EmailAddresses <String[]>
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

FIXME

Examples

EXAMPLE 1

Test whether email can be sent using the specified oncfiguration

$secpasswd = ConvertTo-SecureString "PasswordHere" -AsPlainText -Force
$mycreds = New-Object System.Management.Automation.PSCredential ("username", $secpasswd)

Test-MonitorNotificationEmailServerConfiguration -ProtocolType Smtp -ServerName "mail.abc.com" -PortNumber 25 -SenderEmailAddress "user1@citrix.com" -RequiresAuthentication $true -EmailAddresses "user2@abc.com" -Credential $mycreds
<!--NeedCopy-->

Parameters

-InputObject

Configuration object to test

Type: MonitorNotificationEmailServerConfiguration
Position: 1
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-EmailAddresses

Email addresses to which the test mail to be sent

Type: String[]
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ProtocolType

Email protocol Possible values are Smtp SmtpSsl SmtpTls

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

-ServerName

Email server name

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

-PortNumber

Email server port number

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

-SenderEmailAddress

Sender’s email address

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

-RequiresAuthentication

Whether the server requires authentication

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

-Credential

Configuration credential

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

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Boolean

True - when test mail is successfully sent, otherwise false

Test-MonitorNotificationEmailServerConfiguration