functions/Set-MDDaemon.ps1
|
function Set-MDDaemon { <# .SYNOPSIS Configures the Daemon settings on the target computer(s) .DESCRIPTION Command that governs the Mail Daemon settings. .PARAMETER PickupPath The folder in which emails are queued for delivery. .PARAMETER SentPath The folder in which emails that were successfully sent are stored for a specified time before being deleted. .PARAMETER MailSentRetention The time to keep successfully sent emails around. .PARAMETER SmtpServer The mailserver to use for sending emails. .PARAMETER SenderDefault The default email address to use as sender. This is used for mails queued by a task that did not specify a sender. .PARAMETER RecipientDefault Default email address to send the email to, if the individual script queuing the email does not specify one. .PARAMETER SenderCredentialPath The path to where the credentials file can be found, that should be used by the daemon. .PARAMETER ComputerName The computer(s) to work against. Defaults to localhost, but can be used to update the module settings across a wide range of computers. .PARAMETER Credential The credentials to use when connecting to computers. .EXAMPLE PS C:\> Set-MDDaemon -PickupPath 'C:\MailDaemon\Pickup' Updates the configuration to now pickup incoming emails from 'C:\MailDaemon\Pickup'. Will not move pending email jobs. #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "")] [CmdletBinding()] param ( [string] $PickupPath, [string] $SentPath, [Timespan] $MailSentRetention, [string] $SmtpServer, [string] $SenderDefault, [string] $RecipientDefault, [string] $SenderCredentialPath, [Parameter(ValueFromPipeline = $true)] [PSFComputer[]] $ComputerName = $env:COMPUTERNAME, [PSCredential] $Credential ) begin { #region Configuration Script $configurationScript = { param ( $Parameters ) # Import module so settings are initialized if (-not (Get-Module MailDaemon)) { Import-Module MailDaemon } foreach ($key in $Parameters.Keys) { Write-PSFMessage -String 'Set-MDDaemon.UpdateSetting' -StringValues $key, $Parameters[$key] switch ($key) { 'PickupPath' { Set-PSFConfig -Module MailDaemon -Name 'Daemon.MailPickupPath' -Value $Parameters[$key] if (-not (Test-Path $Parameters[$key])) { $null = New-Item $Parameters[$key] -Force -ItemType Directory } } 'SentPath' { Set-PSFConfig -Module MailDaemon -Name 'Daemon.MailSentPath' -Value $Parameters[$key] if (-not (Test-Path $Parameters[$key])) { $null = New-Item $Parameters[$key] -Force -ItemType Directory } } 'MailSentRetention' { Set-PSFConfig -Module MailDaemon -Name 'Daemon.MailSentRetention' -Value $Parameters[$key] } 'SmtpServer' { Set-PSFConfig -Module MailDaemon -Name 'Daemon.SmtpServer' -Value $Parameters[$key] } 'SenderDefault' { Set-PSFConfig -Module MailDaemon -Name 'Daemon.SenderDefault' -Value $Parameters[$key] } 'SenderCredentialPath' { Set-PSFConfig -Module MailDaemon -Name 'Daemon.SenderCredentialPath' -Value $Parameters[$key] } 'RecipientDefault' { Set-PSFConfig -Module MailDaemon -Name 'Daemon.RecipientDefault' -Value $Parameters[$key] } } } Get-PSFConfig -Module MailDaemon -Name Daemon.* | Where-Object Unchanged -EQ $false | Register-PSFConfig -Scope SystemDefault } #endregion Configuration Script #region Prepare parameters to pass through $parameters = @{ } foreach ($key in $PSBoundParameters.Keys) { if ($key -in 'ComputerName', 'Credential') { continue } $parameters[$key] = $PSBoundParameters[$key] } #endregion Prepare parameters to pass through } process { #region Modules must be installed and current if ($moduleResult = Test-Module -ComputerName $ComputerName -Credential $Credential -Module @{ MailDaemon = $script:ModuleVersion PSFramework = (Get-Module -Name PSFramework).Version } | Where-Object Success -EQ $false) { Stop-PSFFunction -String 'General.ModuleMissing' -StringValues ($moduleResult.ComputerName -join ", ") -EnableException $true -Cmdlet $PSCmdlet } #endregion Modules must be installed and current Write-PSFMessage -String 'Set-MDDaemon.UpdatingSettings' -StringValues ($ComputerName -join ", ") Invoke-PSFCommand -ComputerName $ComputerName -Credential $Credential -ScriptBlock $configurationScript -ArgumentList $parameters } } |