If statement in PowerShell cmdlet parameter list

Question

Send-Message `
    -From $emailAuthUser `
    -To $($emailTo -split ',') `
    if($emailCC -ne "NA") { -CC $($emailCC -split ',') } `
    -Subject $emailSubject `
    -Body $emailBody `
    -Attachments $attachments `
    -ReplyTo $($emailReplyTo -split ',') `
    -SmtpServer $emailSmtpServer `
    -Port $emailSmtpPort `
    -Credential $creds `
    -UseSsl

Error: A positional parameter cannot be found that accepts argument 'if'.

Is there an easy way to optionally include a parameter in a "built-in" cmdlet like I am trying to accomplish above? If so, how?

You can use Powershell "parameter splatting" to build a hashtable of parameters, and then just add entries for the ones you want to use in any particular invocation. That's pretty easy to do... — mclayton
– mclayton, Commented Nov 22, 2019 at 16:07

Peter Kay · Accepted Answer · 2019-11-22 16:55:52Z

2

Splatting is the preferred way of performing complex parameter passing. You can store the parameters in a hash table and then add to the hash table using IF blocks. Then splat the hash into your command.

$Params = @{
    From = $emailAuthUser;
    To = $($emailTo -split ',');
    Subject = $emailSubject;
    Body = $emailBody;
    Attachments = $attachments;
    ReplyTo = $($emailReplyTo -split ',');
    SmtpServer = $emailSmtpServer;
    Port = $emailSmtpPort;
    Credential = $creds;
    UseSsl = $True;
}

if($emailCC -ne "NA") { $Params['CC'] = ($emailCC -split ',') }

Send-Message @Params

answered Nov 22, 2019 at 16:55

Peter Kay

1,0061 gold badge8 silver badges19 bronze badges

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

Comments

Bevan · Accepted Answer · 2024-08-08 02:02:38Z

0

I know this is old but just came across this looking for something else. For reference to others you can also slightly modify your existing command.

Send-Message `
    -From $emailAuthUser `
    -To $($emailTo -split ',') `
    -CC $(if($emailCC -ne "NA") { $($emailCC -split ',') }) `
    -Subject $emailSubject `
    -Body $emailBody `
    -Attachments $attachments `
    -ReplyTo $($emailReplyTo -split ',') `
    -SmtpServer $emailSmtpServer `
    -Port $emailSmtpPort `
    -Credential $creds `
    -UseSsl

answered Aug 8, 2024 at 2:02

Bevan

1,4542 gold badges12 silver badges19 bronze badges

Collectives™ on Stack Overflow

If statement in PowerShell cmdlet parameter list

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related