Citrix Virtual Apps and Desktops SDK

Test-Monitornotificationemailserverconfiguration

August 3, 2023

Contributed by:

FIXME

Syntax

Test-MonitorNotificationEmailServerConfiguration [-InputObject] <MonitorNotificationEmailServerConfiguration> -EmailAddresses <String[]> [-Credential <PSCredential>] [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Test-MonitorNotificationEmailServerConfiguration -ProtocolType <EmailProtocolType> -ServerName <String> -PortNumber <Int32> -SenderEmailAddress <String> -RequiresAuthentication <Boolean> -EmailAddresses <String[]> [-Credential <PSCredential>] [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Test-MonitorNotificationEmailServerConfiguration -EmailAddresses <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

FIXME

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Configuration object to test	true	false
EmailAddresses	Email addresses to which the test mail to be sent	true	true (ByValue)
ProtocolType	Email protocol Possible values are Smtp SmtpSsl SmtpTls	true	false
ServerName	Email server name	true	false
PortNumber	Email server port number	true	false
SenderEmailAddress	Sender’s email address	true	false
RequiresAuthentication	Whether the server requires authentication	true	false
Credential	Configuration credential	false	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.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a Citrix Virtual Apps and Desktops 7 controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

System.Boolean

True - when test mail is successfully sent, otherwise false

Examples

Example 1

$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-->

Description

Test whether email can be sent using the specified oncfiguration

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Test-Monitornotificationemailserverconfiguration

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Test-Monitornotificationemailserverconfiguration

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

System.Boolean

Examples

Example 1

Description

In this article