Add Docs For Mailer Image CID (#422)

* fix tests in GH actions + docs * published mailer nuget
jamesmh · Dec 16, 2024 · bd68505 · bd68505
1 parent a389780
commit bd68505
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 42 deletions.
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("[email protected]")
 
 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/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>