How to handle optional parameters in powershell cmdlet

Question

Question:

I am writing a cmdlet that will accept parameters and send emails. "Cc" is one of the parameters; and is non-mandatory. Today the code shows TWO lines invoking Send-MailMessage (like the following paragraph), but i am sure there is a better way to write it:

if( $cc -eq $null){  
    Send-MailMessage -From $from ...    ## call without -Cc  
} else {  
    Send-MailMessage -From $from ... -Cc $cc...     ## call WITH -Cc  
}

I would like to avoid branching and writing the line twice.

Or even worse than "twice", writing all the combinations for each optional parameter.

(Of course, the fact that the cmdlet sends email is not important here. The problem will stand for any cmdlet that needs to avoid optional parameters)

What is the best-practice way to do this?

THANK YOU

user4003407 · Accepted Answer · 2016-07-03 14:42:14Z

4

Use splatting:

$Params = @{}
if($ShouldUseCc) {
    $Params.Add('Cc', $CcValue)
}
if($ShouldUseBcc) {
    $Params.Add('Bcc', $BccValue)
}
Send-MailMessage -From $from ... @Params

answered Jul 3, 2016 at 14:42

user4003407

22.3k4 gold badges54 silver badges62 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to handle optional parameters in powershell cmdlet

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related