Ability to specify Port, Require SSL and SMTP Authentication Type for New-DbaDbMailAccount

[bilodeauj]

Summarize Functionality

It would be great to add the following options to the New-DbaDbMailAccount cmdlet

• Port
• RequireSSL
• SMTPAuthentication

This would allow Admins to use things like google or office 365 emails that require non standard mail port settings, SSL and would also allow for the use of windows authenticated accounts in domain

Is there a command that is similiar or close to what you are looking for?

Yes

Technical Details

No response

[butanfire]

Hey everyone, I played around with SQL SMO and managed to find the functions needed to rename the server & port.

Import-Module SqlServer

Define SQL Server instance and mail server/account/profile names

$serverName = "instance_name"
$mailProfileName = "mail_profile"
$mailAccountName = "account_name"
$mailServerName = "smtpServer_name(existing)" # The name of the MailServer object to modify

New SMTP server details

$newSmtpServer = "smtpServer_name(new)"
$newPort = new_port

Connect to SQL Server

$server = New-Object Microsoft.SqlServer.Management.Smo.Server $serverName

Find the mail profile

$mailProfile = $server.Mail.Profiles[$mailProfileName]
if (-not $mailProfile) {
Write-Host "Mail profile '$mailProfileName' not found."
}

Find the mail account

$mailAccount = $server.Mail.Accounts[$mailAccountName]
if (-not $mailAccount) {
Write-Host "Mail account '$mailAccountName' not found."
}

Find the mail server

$mailServer = $mailAccount.MailServers | Where-Object { $_.Name -eq $mailServerName }
if (-not $mailServer) {
Write-Host "Mail server '$mailServerName' not found."
}

Modify SMTP server name and port

$mailServer.rename($newSmtpServer)
$mailServer.Port = $newPort

Save changes

$mailServer.Alter()

Write-Host "Mail server '$mailServerName' updated: SMTP server set to '$newSmtpServer', port set to $newPort."

I had to do this on a couple of servers in our environment and can confirm the above works.
I will try to re-write it with the powershell, so that is aligned with the dbatools format.

[butanfire]

Updated version
#Parameters to be passed
$instance = "sqlinstance "
$MailAccountName = "MailAccountName "
$OldMailServerName = "OldMailServerName "
$NewMailServerName = "NewMailServerName "
$NewPort = newport

Get the mail account

            $mailAccount = Get-DbaDbMailAccount -SqlInstance $instance | Where-Object { $_.Name -eq $MailAccountName }
            if (-not $mailAccount) {
                Write-Warning "Mail account '$MailAccountName' not found on $instance."
                continue
            }

            # Find the mail server to update
            $mailServer = $mailAccount.MailServers | Where-Object { $_.Name -eq $OldMailServerName }
            if (-not $mailServer) {
                Write-Warning "Mail server '$OldMailServerName' not found in account '$MailAccountName' on $instance."
                continue
            }

            # Update the mail server properties
            $mailServer.Rename($NewMailServerName)
            $mailServer.Port = $NewPort

            # Save changes
            $mailServer.Alter()

Write-Host "Mail server '$OldMailServerName' updated to '$NewMailServerName' with port $NewPort on $instance."

[potatoqualitee]

agreed @claude pls implement and a complimentary command

[claude]

Claude finished @potatoqualitee's task —— View job • claude/issue-9139-20251128-1731 • Create PR ➔

---

Implementing Mail Account Enhancements ✅

Tasks

• Gather context: Read existing New-DbaDbMailAccount command
• Gather context: Read Get-DbaDbMailAccount to understand object structure
• Gather context: Read Get-DbaDbMailServer to see exposed properties
• Understand SMO mail account object model
• Update New-DbaDbMailAccount with new parameters
• Create Set-DbaDbMailAccount command
• Register commands in dbatools.psd1 and dbatools.psm1
• Create/update tests
• Commit and push changes
• Provide PR URL

Implementation Summary

Enhanced New-DbaDbMailAccount:

• Added -Port parameter (default 25) for non-standard SMTP ports like 587 (Office 365/Gmail)
• Added -EnableSSL switch for TLS/SSL encryption
• Added -UseDefaultCredentials switch for Windows Authentication using SQL Server service account
• Added -UserName and -Password parameters for Basic Authentication
• Updated help documentation with detailed examples for Office 365 and internal relay scenarios

Created Set-DbaDbMailAccount:

• New command to modify existing Database Mail accounts and mail server settings
• Supports updating account properties: DisplayName, Description, EmailAddress, ReplyToAddress
• Supports updating mail server properties: Port, EnableSSL, UseDefaultCredentials, authentication credentials
• Includes -NewMailServerName to rename/migrate to different SMTP servers
• Supports pipeline input from Get-DbaDbMailAccount
• Full WhatIf/Confirm support

Testing:

• Updated parameter validation for New-DbaDbMailAccount
• Created comprehensive integration tests for Set-DbaDbMailAccount including port/SSL updates and pipeline support

Example Usage

# Office 365 configuration
$params = @{
    SqlInstance = 'sql2017'
    Account     = 'Office365Alerts'
    EmailAddress = 'alerts@company.com'
    MailServer  = 'smtp.office365.com'
    Port        = 587
    EnableSSL   = $true
    UserName    = 'alerts@company.com'
    Password    = (ConvertTo-SecureString 'app-password' -AsPlainText -Force)
}
New-DbaDbMailAccount @params

# Update existing account to use different port/SSL
Set-DbaDbMailAccount -SqlInstance sql2017 -Account 'MaintenanceAlerts' -Port 587 -EnableSSL:$true

# Migrate to new SMTP server
$params = @{
    SqlInstance       = 'sql2017'
    Account           = 'Alerts'
    NewMailServerName = 'smtp.office365.com'
    Port              = 587
    EnableSSL         = $true
}
Set-DbaDbMailAccount @params

---

Branch |

[potatoqualitee]

@claude pls fix these issues in the same branch

Uploading artifact dbatools_messages_and_errors.xml.zip (13,415 bytes)...100%
Failed tests summary:
Path : Set-DbaDbMailAccount/Updates mail account properties/Gets results
Name : It Gets results
Result : Failed
Message : Test failed but no error message could be extracted. Result: Failed | Test Name: Gets results
StackTrace :
RawErrorRecord : No ErrorRecord
Path : Set-DbaDbMailAccount/Updates mail account properties/Should have updated Description
Name : It Should have updated Description
Result : Failed
Message : Test failed but no error message could be extracted. Result: Failed | Test Name: Should have updated Description
StackTrace :
RawErrorRecord : No ErrorRecord
Path : Set-DbaDbMailAccount/Updates mail account properties/Should have updated DisplayName
Name : It Should have updated DisplayName
Result : Failed
Message : Test failed but no error message could be extracted. Result: Failed | Test Name: Should have updated DisplayName
StackTrace :
RawErrorRecord : No ErrorRecord
Path : Set-DbaDbMailAccount/Updates mail server port and SSL settings/Gets results
Name : It Gets results
Result : Failed
Message : Test failed but no error message could be extracted. Result: Failed | Test Name: Gets results
StackTrace :
RawErrorRecord : No ErrorRecord
Path : Set-DbaDbMailAccount/Updates mail server port and SSL settings/Should have enabled SSL
Name : It Should have enabled SSL
Result : Failed
Message : Test failed but no error message could be extracted. Result: Failed | Test Name: Should have enabled SSL
StackTrace :
RawErrorRecord : No ErrorRecord
Path : Set-DbaDbMailAccount/Updates mail server port and SSL settings/Should have updated port to 587
Name : It Should have updated port to 587
Result : Failed
Message : Test failed but no error message could be extracted. Result: Failed | Test Name: Should have updated port to 587
StackTrace :
RawErrorRecord : No ErrorRecord
Path : Set-DbaDbMailAccount/Works with pipeline input/Gets results
Name : It Gets results
Result : Failed
Message : Test failed but no error message could be extracted. Result: Failed | Test Name: Gets results
StackTrace :
RawErrorRecord : No ErrorRecord
Path : Set-DbaDbMailAccount/Works with pipeline input/Should have disabled SSL
Name : It Should have disabled SSL
Result : Failed
Message : Test failed but no error message could be extracted. Result: Failed | Test Name: Should have disabled SSL
StackTrace :
RawErrorRecord : No ErrorRecord
Path : Set-DbaDbMailAccount/Works with pipeline input/Should have updated port back to 25
Name : It Should have updated port back to 25
Result : Failed
Message : Test failed but no error message could be extracted. Result: Failed | Test Name: Should have updated port back to 25
StackTrace :
RawErrorRecord : No ErrorRecord

[claude]

Claude finished @potatoqualitee's task —— View job

---

Fixing Set-DbaDbMailAccount Test Failures

Permission Issues Blocking Progress

I'm unable to proceed due to several permission constraints:

1. Branch Access: I'm on claude/issue-9139-20251129-1836 but the failing tests are from claude/issue-9139-20251128-1731
2. Git Operations: git checkout and git fetch require approval
3. Web Fetch: WebFetch tool requires approval to download files from the remote branch
4. File I/O: Cannot write to /tmp to extract files from git

What I Need

To fix the test failures, I need one of the following:

Option A (Recommended): Approve these tools:

• git checkout or git fetch - to switch to/pull the correct branch
• OR approve WebFetch - to download the files from GitHub

Option B: Manually provide the content of these files from branch claude/issue-9139-20251128-1731:

• public/Set-DbaDbMailAccount.ps1
• tests/Set-DbaDbMailAccount.Tests.ps1

Once I can access the files, I can analyze the test failures and implement fixes.

---

[andreasjordan]

@claude please use your analysis from #9139 (comment) and rebuild a pr based on the current development branch and you current guidelines.

[claude]

Claude finished @andreasjordan's task in 7m 27s —— View job • claude/issue-9139-20260317-0856 • Create PR ➔

---

Rebuilding PR for Issue #9139

Tasks:

• Understand the request
• Read existing New-DbaDbMailAccount command
• Read Get-DbaDbMailAccount to understand object structure
• Read Get-DbaDbMailServer to understand mail server properties
• Update New-DbaDbMailAccount with Port, EnableSSL, and authentication parameters
• Create Set-DbaDbMailAccount command
• Update tests for New-DbaDbMailAccount (parameter validation)
• Create tests for Set-DbaDbMailAccount
• Register Set-DbaDbMailAccount in dbatools.psd1 and dbatools.psm1
• Commit and push changes

Summary

Enhanced New-DbaDbMailAccount (public/New-DbaDbMailAccount.ps1):

• Added -Port for non-standard SMTP ports (e.g. 587 for Office 365/Gmail)
• Added -EnableSSL switch for TLS/SSL encryption
• Added -UseDefaultCredentials switch for Windows integrated authentication
• Added -UserName / -Password (SecureString) for Basic SMTP authentication
• Refactored mail server setup to conditionally rename only when -MailServer is provided, fixing a latent bug where Rename("") was always called

New Set-DbaDbMailAccount (public/Set-DbaDbMailAccount.ps1):

• Modifies existing mail accounts: DisplayName, Description, EmailAddress, ReplyToAddress
• Updates mail server settings: Port, EnableSSL, UseDefaultCredentials, UserName, Password
• Supports -NewMailServerName to rename/migrate to a different SMTP server
• Accepts pipeline input from Get-DbaDbMailAccount
• Full WhatIf/Confirm support

Tests (tests/New-DbaDbMailAccount.Tests.ps1, tests/Set-DbaDbMailAccount.Tests.ps1):

• Updated parameter validation for New-DbaDbMailAccount
• Created unit + integration tests for Set-DbaDbMailAccount covering property updates, port/SSL changes, and pipeline input

| Branch