PSSendGrid.psm1
|
Function Send-PSSendGridMail { <# .SYNOPSIS Send an email through the SendGrid API .DESCRIPTION This function is a wrapper around the SendGrid API. It is possible to send attachments as well. .PARAMETER ToAddress Emailaddress of the receiving end .PARAMETER ToName Name of the receiving end .PARAMETER FromAddress Source email address .PARAMETER FromName Source name .PARAMETER Subject Subject of the email .PARAMETER Body Body of the email when using plain text .PARAMETER BodyAsHTML Body of the email when using HTML .PARAMETER Token SendGrid token for the API .PARAMETER AttachmentPath Path to file(s) that needs to be attached. This can be a single string or an array of strings .PARAMETER AttachmentDisposition Attachment or Inline. Use inline to add image to HTML body .PARAMETER AttachmentID AttachmentID(s) for inline attachment, to refer to from the HTML. This can be a single string or an array of strings For multiple Attachments, the IDs should be in the same order as the attachmentPaths .EXAMPLE $Parameters = @{ FromAddress = "example@example.com" ToAddress = "example2@example.com" Subject = "SendGrid example" Body = "This is a plain text email" Token = "adfdasfaihghaweoigneawfaewfawefadfdsfsd4tg45h54hfawfawfawef" FromName = "Jane Doe" ToName = "John Doe" } Send-PSSendGridMail @Parameters ======= Sends an email from example@example.com to example2@example.com .EXAMPLE $Parameters = @{ Token = "API TOKEN" ToAddress = "example@example.com" BodyAsHTML = "<h1>MetHTML</h1><img src='cid:exampleID'>" ToName = "Example2" FromName = "Example1" FromAddress = "example2@example.com" AttachmentID = "exampleID" AttachmentPath = "C:\temp\exampleimage.jpg" AttachmentDisposition = "inline" Subject = "Test" } Send-PSSendGridMail @Parameters ======= Sends an email with an inline attachment in the HTML .LINK https://github.com/Ba4bes/PSSendGrid .NOTES Created by Barbara Forbes Script has been tested for Windows PowerShell and PowerShell 7. Only has been tested on Windows. @Ba4bes https://4bes.nl #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Medium')] param ( [parameter(Mandatory = $True)] [ValidatePattern('^([\w-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$')] [string]$ToAddress, [parameter(Mandatory = $True)] [string]$ToName, [parameter(Mandatory = $True)] [ValidatePattern('^([\w-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$')] [string]$FromAddress, [parameter(Mandatory = $True)] [string]$FromName, [parameter(Mandatory = $True)] [string]$Subject, [parameter()] [string]$Body, [parameter()] [string]$BodyAsHTML, [parameter(Mandatory = $True)] [string]$Token, [parameter()] [ValidateScript( { Test-Path $_ })] [string[]]$AttachmentPath, [parameter()] [ValidateSet('attachment', 'inline')] [string]$AttachmentDisposition = "attachment", [parameter()] [string[]]$AttachmentID ) Write-Verbose "Starting Function Send-PSSendGridMail" # Set body as HTML or as text if (-not[string]::IsNullOrEmpty($BodyAsHTML)) { $MailbodyType = 'text/HTML' $MailbodyValue = $BodyAsHTML Write-Verbose "Found BodyAsHTML parameter, Type is set to text/HTML" } else { $MailbodyType = 'text/plain' $MailBodyValue = $Body Write-Verbose "Found no BodyAsHTML parameter, Type is set to text/plain" } # Check for attachments. If they are present, convert to Base64 if ($AttachmentPath) { Write-Verbose "AttachmentPath parameter was used" $AllAttachments = @() foreach ($Attachment in $AttachmentPath) { try { if ($PSVersionTable.PSVersion.Major -lt 6) { $EncodedAttachment = [convert]::ToBase64String((Get-Content $Attachment -encoding byte)) } else { $AttachmentContent = Get-Content -Path $Attachment -AsByteStream -ErrorAction Stop $EncodedAttachment = [convert]::ToBase64String($AttachmentContent) } Write-Verbose "Attachment found at $Attachment has been encoded" } Catch { Throw "Could not convert file $Attachment" } # Get the extension for the attachment type $AttachmentExtension = $Attachment.Split('.')[-1] Switch ($IsWindows) { $true { $AttachmentName = $Attachment.Split('\')[-1] } $false { $AttachmentName = $Attachment.Split('/')[-1] } $Null { $AttachmentName = $Attachment.Split('\')[-1] } default { Throw "Could not work with attachmentpath" } } Write-Verbose "AttachmentExtension: $AttachmentExtension" $ImageExtensions = @("jpg", "png", "gif") if ($ImageExtensions -contains $AttachmentExtension) { $Type = "image/$AttachmentExtension" Write-Verbose "Attachment is an image, type set to $Type" } else { $Type = "Application/$AttachmentExtension" Write-Verbose "Attachment is not an image, type set to $Type" } $Attachmentobject = [pscustomObject]@{ AttachmentName = $AttachmentName EncodedAttachment = $EncodedAttachment AttachmentType = $Type } $AllAttachments += $Attachmentobject } Write-Verbose "$($AllAttachments.Count) attachments have been processed" } # Create a body to send to the API $SendGridBody = [pscustomObject]@{ "personalizations" = @( @{ "to" = @( @{ "email" = $ToAddress "name" = $ToName } ) "subject" = $Subject } ) "content" = @( @{ "type" = $mailbodyType "value" = $MailBodyValue } ) "from" = @{ "email" = $FromAddress "name" = $FromName } } $Verbose = @" ToEmail: $($SendGridBody.personalizations.To.email) ToName: $($SendGridBody.personalizations.To.name) FromEmail: $($SendGridBody.from.email) FromName: $($SendGridBody.from.name) Subject: $($SendGridBody.personalizations.subject) ContentBody: $($SendGridBody.content.value) ContentType: $( $SendGridBody.content.type) "@ Write-Verbose "Body send to API:" Write-Verbose $Verbose # Add attachments to body if they are present if ($AttachmentPath) { $Attachments = @() $i = 0 foreach ($Attachmentobject in $AllAttachments) { Write-Verbose "Attachment is added to body" $Object = @{ content = $Attachmentobject.EncodedAttachment filename = $Attachmentobject.AttachmentName type = $Attachmentobject.AttachmentType disposition = $AttachmentDisposition } if ($AttachmentID) { # AttachmentIDs are added in the same order as the attachments $Object.add("content_id", $AttachmentID[$i]) } $Attachments += $Object $i++ Write-Verbose "Attachment Filename: $($Object.filename)" Write-Verbose "Attachment type: $($Object.type)" Write-Verbose "Attachment disposition: $($object.disposition)" Write-Verbose "Attachment ObjectID: $($object.content_id)" } $SendGridBody | Add-Member -MemberType NoteProperty -Name "Attachments" -Value $Attachments } $BodyJson = $SendGridBody | ConvertTo-Json -Depth 4 #Create the header $Header = @{ "authorization" = "Bearer $token" } #send the mail through Sendgrid $Parameters = @{ Method = "POST" Uri = "https://api.sendgrid.com/v3/mail/send" Headers = $Header ContentType = "application/json" Body = $BodyJson } if ($PSCmdlet.ShouldProcess( ("An email will be send from {0} to {1} with subject: {2}" -f $SendGridBody.from.email, $SendGridBody.personalizations.to.email, $SendGridBody.personalizations.subject), ("Do you want to send an email from {0} to {1} with subject: {2}?" -f $SendGridBody.from.email, $SendGridBody.personalizations.to.email, $SendGridBody.personalizations.subject), "Send email")) { Invoke-RestMethod @Parameters } Write-Verbose "API has been called, function is done" } |