exports/Send-CVTestMailReq.ps1
|
# ---------------------------------------------------------------------------------- # # Copyright Microsoft Corporation # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ---------------------------------------------------------------------------------- <# .Synopsis To test Email settings .Description To test Email settings .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Commvault.Powershell.Models.ISendTestMailReq .Outputs Commvault.Powershell.Models.IGenericResp .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. BODY <ISendTestMailReq>: . SenderEmail <String>: The sender email address used for emails sent from the software. SenderName <String>: The sender name used for emails sent from the software. SmtpPort <Int64>: The port number that connects to the mail server. SmtpServerName <String>: The name of the mail server that sends alerts, scheduled reports, log files, and additional information. [EncryptionAlgorithm <String>]: [Password <String>]: If password is specified, username must also be specified. password should be a base 64 encoded string. To use previoulsy saved username and password, leave out username and password in payload. [UseAuthentication <Boolean?>]: The option to use authentication on the mail server. This is typically used in external or internet mail server configurations. [Username <String>]: If username is specified, password field must also be specified. To use previously saved username and password, leave out username and password in payload. .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/send-cvtestmailreq #> function Send-CVTestMailReq { [OutputType([Commvault.Powershell.Models.IGenericResp])] [CmdletBinding(DefaultParameterSetName='SendExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Send', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.ISendTestMailReq] # . # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='SendExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # The sender email address used for emails sent from the software. ${SenderEmail}, [Parameter(ParameterSetName='SendExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # The sender name used for emails sent from the software. ${SenderName}, [Parameter(ParameterSetName='SendExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.Int64] # The port number that connects to the mail server. ${SmtpPort}, [Parameter(ParameterSetName='SendExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # The name of the mail server that sends alerts, scheduled reports, log files, and additional information. ${SmtpServerName}, [Parameter(ParameterSetName='SendExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${EncryptionAlgorithm}, [Parameter(ParameterSetName='SendExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # If password is specified, username must also be specified. # password should be a base 64 encoded string. # To use previoulsy saved username and password, leave out username and password in payload. ${Password}, [Parameter(ParameterSetName='SendExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # The option to use authentication on the mail server. # This is typically used in external or internet mail server configurations. ${UseAuthentication}, [Parameter(ParameterSetName='SendExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # If username is specified, password field must also be specified. # To use previously saved username and password, leave out username and password in payload. ${Username}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter()] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds ${PassThru}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ Send = 'CommvaultPowershell.private\Send-CVTestMailReq_Send'; SendExpanded = 'CommvaultPowershell.private\Send-CVTestMailReq_SendExpanded'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |