Merge branch 'master' into fix/420-exception-cron-entry-00-is-malformed

storno77 · web-flow · commit 4fdb239ca64a · 2024-12-18T21:06:47.000+01:00
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -7,42 +7,6 @@ on:
     branches: [ master ]
 
 jobs:
-  build_and_tests_on_dotnet_6:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v3
-      with:
-        dotnet-version: 6.0.x
-    - name: Restore dependencies
-      run: dotnet restore ./Src/All.sln
-    - name: Build
-      run: dotnet build ./Src/All.sln
-    - name: Mailer Tests
-      run: dotnet test ./Src/UnitTests/MailerUnitTests/MailerUnitTests.csproj
-    - name: Unit Tests
-      run: dotnet test ./Src/UnitTests/CoravelUnitTests/CoravelUnitTests.csproj
-    - name: Integration Tests
-      run: dotnet test ./Src/IntegrationTests/Tests/Tests.csproj
-  build_and_tests_on_dotnet_7:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v3
-      with:
-        dotnet-version: 7.0.x
-    - name: Restore dependencies
-      run: dotnet restore ./Src/All.sln
-    - name: Build
-      run: dotnet build ./Src/All.sln
-    - name: Mailer Tests
-      run: dotnet test ./Src/UnitTests/MailerUnitTests/MailerUnitTests.csproj
-    - name: Unit Tests
-      run: dotnet test ./Src/UnitTests/CoravelUnitTests/CoravelUnitTests.csproj
-    - name: Integration Tests
-      run: dotnet test ./Src/IntegrationTests/Tests/Tests.csproj
   build_and_tests_on_dotnet_8:
     runs-on: ubuntu-latest
     steps:
diff --git a/Demo/Demo.csproj b/Demo/Demo.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
     <AddRazorSupportForMvc>True</AddRazorSupportForMvc>
   </PropertyGroup>
diff --git a/DocsV2/docs/Mailing/README.md b/DocsV2/docs/Mailing/README.md
@@ -345,6 +345,36 @@ Sender("test@test.com")
 
 Attach multiple files by passing an `Attachment` to the `Attach()` method.
 
+Each attachment has a few fields to assign:
+
+- `Bytes`: The `byte[]` of the file you are attaching.
+- `Name`: The name of the file to attach.
+- `ContentId`: Often used for embedding images into emails. Assign a value that is unique within your email template.
+
+##### Embedding Images
+
+To embed images into your email you can assign the `ContentId` field with a unique value that will also be used in your email.
+
+For example:
+
+```csharp
+emailMessage
+    .Attach(new Attachment
+    {
+        Name = "My Image",
+        Bytes = myBytes,
+        ContentId = "my-image"
+    });
+```
+
+```html
+<html>
+    <img src="cid:my-image" />
+</html>
+```
+
+Coravel will automatically link the embedded resources to the email properly for you.
+
 #### Auto-Detect Email Address And Name
 
 Using an `object` that has a `public` field or property `Email` and `Name`, you can pass it to the `To()` method.
diff --git a/Src/Coravel.Mailer/Coravel.Mailer.csproj b/Src/Coravel.Mailer/Coravel.Mailer.csproj
@@ -4,7 +4,7 @@
     <TargetFramework>.net6.0</TargetFramework>
     <AddRazorSupportForMvc>True</AddRazorSupportForMvc>
     <PackageId>Coravel.Mailer</PackageId>
-    <Version>7.0.0</Version>
+    <Version>7.1.0</Version>
     <Authors>James Hickey</Authors>
     <Company>-</Company>
     <Title>Coravel.Mailer</Title>
diff --git a/Src/Coravel.Mailer/Mail/Attachment.cs b/Src/Coravel.Mailer/Mail/Attachment.cs
@@ -3,6 +3,7 @@ namespace Coravel.Mailer.Mail
     public class Attachment
     {
         public byte[] Bytes { get; set; }
-        public string Name { get; set; }
+        public string Name { get; set; }
+        public string ContentId { get; set; }
     }
 }
diff --git a/Src/Coravel.Mailer/Mail/Mailers/SmtpMailer.cs b/Src/Coravel.Mailer/Mail/Mailers/SmtpMailer.cs
@@ -89,7 +89,16 @@ private static void SetMailBody(MessageBody message, IEnumerable<Attachment> att
             {
                 foreach (var attachment in attachments)
                 {
-                    bodyBuilder.Attachments.Add(attachment.Name, attachment.Bytes);
+                    if (string.IsNullOrWhiteSpace(attachment.ContentId) == false)
+                    {
+                        var image = bodyBuilder.LinkedResources.Add(attachment.Name, attachment.Bytes);
+                        // We do this instead of using their value because RFC states the Content-Id value MUST be in the message id format.
+                        image.ContentId = MimeKit.Utils.MimeUtils.GenerateMessageId();
+                        // Now replace where they applied it in the html template with the updated correct version
+                        bodyBuilder.HtmlBody = bodyBuilder.HtmlBody.Replace($"\"cid:{attachment.ContentId}\"", $"\"cid:{image.ContentId}\"", System.StringComparison.OrdinalIgnoreCase);
+                    }
+                    else
+                        bodyBuilder.Attachments.Add(attachment.Name, attachment.Bytes);
                 }
             }
 
diff --git a/Src/IntegrationTests/TestMvcApp/TestMvcApp.csproj b/Src/IntegrationTests/TestMvcApp/TestMvcApp.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>.net6.0</TargetFramework>
+    <TargetFramework>.net8.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/Src/IntegrationTests/Tests/Tests.csproj b/Src/IntegrationTests/Tests/Tests.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>.net6.0</TargetFramework>
+    <TargetFramework>.net8.0</TargetFramework>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
diff --git a/Src/UnitTests/CoravelUnitTests/CoravelUnitTests.csproj b/Src/UnitTests/CoravelUnitTests/CoravelUnitTests.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>.net6.0</TargetFramework>
+    <TargetFramework>.net8.0</TargetFramework>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
diff --git a/Src/UnitTests/MailerUnitTests/MailerUnitTests.csproj b/Src/UnitTests/MailerUnitTests/MailerUnitTests.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>.net6.0</TargetFramework>
+    <TargetFramework>.net8.0</TargetFramework>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ namespace Coravel.Mailer.Mail`
`3`	`3`	`public class Attachment`
`4`	`4`	`{`
`5`	`5`	`public byte[] Bytes { get; set; }`
`6`		`- public string Name { get; set; }`
	`6`	`+ public string Name { get; set; }`
	`7`	`+ public string ContentId { get; set; }`
`7`	`8`	`}`
`8`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,16 @@ private static void SetMailBody(MessageBody message, IEnumerable<Attachment> att`
`89`	`89`	`{`
`90`	`90`	`foreach (var attachment in attachments)`
`91`	`91`	`{`
`92`		`- bodyBuilder.Attachments.Add(attachment.Name, attachment.Bytes);`
	`92`	`+ if (string.IsNullOrWhiteSpace(attachment.ContentId) == false)`
	`93`	`+ {`
	`94`	`+ var image = bodyBuilder.LinkedResources.Add(attachment.Name, attachment.Bytes);`
	`95`	`+ // We do this instead of using their value because RFC states the Content-Id value MUST be in the message id format.`
	`96`	`+ image.ContentId = MimeKit.Utils.MimeUtils.GenerateMessageId();`
	`97`	`+ // Now replace where they applied it in the html template with the updated correct version`
	`98`	`+ bodyBuilder.HtmlBody = bodyBuilder.HtmlBody.Replace($"\"cid:{attachment.ContentId}\"", $"\"cid:{image.ContentId}\"", System.StringComparison.OrdinalIgnoreCase);`
	`99`	`+ }`
	`100`	`+ else`
	`101`	`+ bodyBuilder.Attachments.Add(attachment.Name, attachment.Bytes);`
`93`	`102`	`}`
`94`	`103`	`}`
`95`	`104`