PowerShell-PowerShell/test/powershell/Modules/Microsoft.PowerShell.Utility/Send-MailMessage.Tests.ps1

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

# the send-mailmessage cmdlet is obsolete and will be removed in a future release.
# We will address no issues in this cmdlet, so these tests are marked as skipped.
$script:SkipTest = $true

if(-not ("netDumbster.smtp.SimpleSmtpServer" -as [type]) -and ! $script:SkipTest)
{
    Register-PackageSource -Name nuget.org -Location https://api.nuget.org/v3/index.json -ProviderName NuGet -ErrorAction SilentlyContinue

    $nugetPackage = "netDumbster"
    Install-Package -Name $nugetPackage -ProviderName NuGet -Scope CurrentUser -Force -Source 'nuget.org' -RequiredVersion 2.0.0.4

    $dll = "$(Split-Path (Get-Package $nugetPackage).Source)\lib\netstandard2.0\netDumbster.dll"
    Add-Type -Path $dll
}

$DefaultInputObject = @{
    From = "user01@example.com"
    To = "user02@example.com"
    Subject = "Subject $(Get-Date)"
    Body = "Body $(Get-Date)"
    SmtpServer = "127.0.0.1"
}

Describe "Send-MailMessage DRT Unit Tests" -Tags CI, RequireSudoOnUnix {
    BeforeAll {
        if ($script:SkipTest) {
            return
        }
        $server = [netDumbster.smtp.SimpleSmtpServer]::Start(25)

        function Read-Mail
        {
            param()

            if($server)
            {
                return $server.ReceivedEmail[0]
            }
            return $null
        }
    }

    BeforeEach {
        if ($script:SkipTest) {
            return
        }

        if($server)
        {
            $server.ClearReceivedEmail()
        }
    }

    AfterAll {
        if ($script:SkipTest) {
            return
        }

        if($server)
        {
            $server.Stop()
        }
    }

    $testCases = @(
        @{
            Name = "with mandatory parameters"
            InputObject = $DefaultInputObject
        }
        @{
            Name = "with ReplyTo"
            InputObject = @{
                From = "user01@example.com"
                To = "user02@example.com"
                ReplyTo = "noreply@example.com"
                Subject = "Subject $(Get-Date)"
                Body = "Body $(Get-Date)"
                SmtpServer = "127.0.0.1"
            }
        }
        @{
            Name = "with multiple To"
            InputObject = @{
                From = "user01@example.com"
                To = "user02@example.com","user03@example.com","user04@example.com"
                Subject = "Subject $(Get-Date)"
                Body = "Body $(Get-Date)"
                SmtpServer = "127.0.0.1"
            }
        }
        @{
            Name = "with multiple Cc"
            InputObject = @{
                From = "user01@example.com"
                To = "user02@example.com"
                Cc = "user03@example.com","user04@example.com"
                Subject = "Subject $(Get-Date)"
                Body = "Body $(Get-Date)"
                SmtpServer = "127.0.0.1"
            }
        }
        @{
            Name = "with multiple Bcc"
            InputObject = @{
                From = "user01@example.com"
                To = "user02@example.com"
                Bcc = "user03@example.com","user04@example.com"
                Subject = "Subject $(Get-Date)"
                Body = "Body $(Get-Date)"
                SmtpServer = "127.0.0.1"
            }
        }
        @{
            Name = "with No Subject"
            InputObject = @{
                From = "user01@example.com"
                To = "user02@example.com"
                Body = "Body $(Get-Date)"
                SmtpServer = "127.0.0.1"
            }
        }
    )

    It "Shows obsolete message for cmdlet" -skip:$script:SkipTest {
        $server | Should -Not -Be $null

        $powershell = [PowerShell]::Create()

        $null = $powershell.AddCommand("Send-MailMessage").AddParameters($testCases[0].InputObject).AddParameter("ErrorAction","SilentlyContinue")

        $powershell.Invoke()

        $warnings = $powershell.Streams.Warning

        $warnings.count | Should -BeGreaterThan 0
        $warnings[0].ToString() | Should -BeLike "The command 'Send-MailMessage' is obsolete. *"
    }

    It "Can send mail message using named parameters <Name>" -TestCases $testCases -skip:$script:SkipTest {
        param($InputObject)

        $server | Should -Not -Be $null

        Send-MailMessage @InputObject -ErrorAction SilentlyContinue

        $mail = Read-Mail

        $mail.FromAddress | Should -BeExactly $InputObject.From
        $mail.ToAddresses.Count | Should -BeExactly ($InputObject.To.Count + $InputObject.Cc.Count + $InputObject.Bcc.Count)
        $mail.ToAddresses | Should -BeIn ([array]$InputObject.To + $InputObject.Cc + $InputObject.Bcc)

        $mail.Headers["From"] | Should -BeExactly $InputObject.From
        $mail.Headers["To"] | Should -Not -BeNullOrEmpty
        $mail.Headers["To"].Split(", ") | Should -BeExactly $InputObject.To
        If($InputObject.Cc)
        {
            $mail.Headers["Cc"] | Should -Not -BeNullOrEmpty
            $mail.Headers["Cc"].Split(", ") | Should -BeExactly $InputObject.Cc
        }
        # BCC addresses can't be tested against mail message header, as this information is by design never included in the mail message itself.
        If($InputObject.ReplyTo)
        {
            $mail.Headers["Reply-To"] | Should -BeExactly $InputObject.ReplyTo
        }
        $mail.Headers["Subject"] | Should -BeExactly $InputObject.Subject

        $mail.MessageParts.Count | Should -BeExactly 1
        $mail.MessageParts[0].BodyData | Should -BeExactly $InputObject.Body
    }

    It "Can send mail message using pipline named parameters <Name>" -TestCases $testCases -skip:$script:SkipTest {
        param($InputObject)

        Set-TestInconclusive "As of right now the Send-MailMessage cmdlet does not support piping named parameters (see issue 7591)"

        $server | Should -Not -Be $null

        [PsCustomObject]$InputObject | Send-MailMessage -ErrorAction SilentlyContinue

        $mail = Read-Mail

        $mail.FromAddress | Should -BeExactly $InputObject.From
        $mail.ToAddresses.Count | Should -BeExactly ($InputObject.To.Count + $InputObject.Cc.Count + $InputObject.Bcc.Count)
        $mail.ToAddresses | Should -BeIn ([array]$InputObject.To + $InputObject.Cc + $InputObject.Bcc)

        $mail.Headers["From"] | Should -BeExactly $InputObject.From
        $mail.Headers["To"] | Should -Not -BeNullOrEmpty
        $mail.Headers["To"].Split(", ") | Should -BeExactly $InputObject.To
        If($InputObject.Cc)
        {
            $mail.Headers["Cc"] | Should -Not -BeNullOrEmpty
            $mail.Headers["Cc"].Split(", ") | Should -BeExactly $InputObject.Cc
        }
        # BCC addresses can't be tested against mail message header, as this information is by design never included in the mail message itself.
        If($InputObject.ReplyTo)
        {
            $mail.Headers["Reply-To"] | Should -BeExactly $InputObject.ReplyTo
        }
        $mail.Headers["Subject"] | Should -BeExactly $InputObject.Subject

        $mail.MessageParts.Count | Should -BeExactly 1
        $mail.MessageParts[0].BodyData | Should -BeExactly $InputObject.Body
    }
}

Describe "Send-MailMessage Feature Tests" -Tags Feature, RequireSudoOnUnix {
    BeforeAll {
        if ($script:SkipTest) {
            return
        }

        function Read-Mail
        {
            param()

            if($server)
            {
                return $server.ReceivedEmail[0]
            }
            return $null
        }
    }

    BeforeEach {
        if ($script:SkipTest) {
            return
        }

        if($server)
        {
            $server.ClearReceivedEmail()
        }
    }

    Context "Default Port 25" {
        BeforeAll {
            if ($script:SkipTest) {
                return
            }

            $server = [netDumbster.smtp.SimpleSmtpServer]::Start(25)
        }

        AfterAll {
            if ($script:SkipTest) {
                return
            }

            if($server)
            {
                $server.Stop()
            }
        }

        It "Can throw on wrong mail addresses" -skip:$script:SkipTest {
            $server | Should -Not -Be $null

            $obj = $DefaultInputObject.Clone()
            $obj.To = "not_a_valid_mail.address"

            { Send-MailMessage @obj -ErrorAction Stop } | Should -Throw -ErrorId "FormatException,Microsoft.PowerShell.Commands.SendMailMessage"
        }

        It "Can send mail with free-form email address" -skip:$script:SkipTest {
            $server | Should -Not -Be $null

            $obj = $DefaultInputObject.Clone()
            $obj.From = "User01 <user01@example.com>"
            $obj.To = "User02 <user02@example.com>"

            Send-MailMessage @obj -ErrorAction SilentlyContinue

            $mail = Read-Mail

            $mail.FromAddress | Should -BeExactly "user01@example.com"
            $mail.ToAddresses | Should -BeExactly "user02@example.com"
        }

        It "Can send mail with high priority" -skip:$script:SkipTest {
            $server | Should -Not -Be $null

            Send-MailMessage @DefaultInputObject -Priority High -ErrorAction SilentlyContinue

            $mail = Read-Mail
            $mail.Priority | Should -BeExactly "urgent"
        }

        It "Can send mail with HTML content as body" -skip:$script:SkipTest {
            $server | Should -Not -Be $null

            $obj = $DefaultInputObject.Clone()
            $obj.Body = "<html><body><h1>PowerShell</h1></body></html>"

            Send-MailMessage @obj -BodyAsHtml -Encoding utf8 -ErrorAction SilentlyContinue

            $mail = Read-Mail
            $mail.Headers["content-type"] | Should -BeLike "text/html*"
            $mail.MessageParts.Count | Should -BeExactly 1
            $mail.MessageParts[0].BodyData | Should -Be $obj.Body
        }

        It "Can send mail with UTF8 encoding" -skip:$script:SkipTest {
            $server | Should -Not -Be $null

            $obj = $DefaultInputObject.Clone()
            $obj.Body = "We ❤ PowerShell"

            Send-MailMessage @obj -Encoding utf8Bom -ErrorAction SilentlyContinue

            $mail = Read-Mail
            $mail.MessageParts.Count | Should -BeExactly 1
            $mail.Headers["content-transfer-encoding"] | Should -BeExactly "base64"
            $utf8Text = [System.Text.Encoding]::UTF8.GetString([Convert]::FromBase64String($mail.MessageParts[0].BodyData))
            $utf8Text | Should -Be $obj.Body
        }

        It "Can send mail with attachments" -skip:$script:SkipTest {
            $attachment1 = "TestDrive:\attachment1.txt"
            $attachment2 = "TestDrive:\attachment2.txt"

            $pngBase64 = "iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAYAAABw4pVUAAAAnElEQVR42u3RAQ0AAAgDoL9/aK3hHFSgyUw4o0KEIEQIQoQgRAhChAgRghAhCBGCECEIEYIQhAhBiBCECEGIEIQgRAhChCBECEKEIAQhQhAiBCFCECIEIQgRghAhCBGCECEIQYgQhAhBiBCECEEIQoQgRAhChCBECEIQIgQhQhAiBCFCEIIQIQgRghAhCBGCECFChCBECEKEIOS7BU5Hx50BmcQaAAAAAElFTkSuQmCC"

            Set-Content $attachment1 -Value "First attachment"
            Set-Content $attachment2 -AsByteStream -Value ([Convert]::FromBase64String($pngBase64))

            $server | Should -Not -Be $null

            Send-MailMessage @DefaultInputObject -Attachments $attachment1,$attachment2 -ErrorAction SilentlyContinue

            $mail = Read-Mail
            $mail.MessageParts.Count | Should -BeExactly 3

            $txt = [System.Text.Encoding]::UTF8.GetString([Convert]::FromBase64String($mail.MessageParts[1].BodyData)) -replace "`n|`r"
            $txt | Should -BeExactly "First attachment"

            ($mail.MessageParts[2].BodyData -replace "`n|`r") | Should -BeExactly $pngBase64
        }
    }

    Context "Custom Port 2525" {
        BeforeAll {
            if ($script:SkipTest) {
                return
            }

            $server = [netDumbster.smtp.SimpleSmtpServer]::Start(2525)
        }

        AfterAll {
            if ($script:SkipTest) {
                return
            }

            if($server)
            {
                $server.Stop()
            }
        }

        It "Can send mail message using custom port 2525" -skip:$script:SkipTest {
            $server | Should -Not -Be $null
            $server.ReceivedEmailCount | Should -BeExactly 0

            Send-MailMessage @DefaultInputObject -Port 2525 -ErrorAction SilentlyContinue

            $server.ReceivedEmailCount | Should -BeExactly 1
        }
    }
}