MailKitSimplified.Sender
0.1.2.3
See the version list below for details.
dotnet add package MailKitSimplified.Sender --version 0.1.2.3
NuGet\Install-Package MailKitSimplified.Sender -Version 0.1.2.3
<PackageReference Include="MailKitSimplified.Sender" Version="0.1.2.3" />
paket add MailKitSimplified.Sender --version 0.1.2.3
#r "nuget: MailKitSimplified.Sender, 0.1.2.3"
// Install MailKitSimplified.Sender as a Cake Addin #addin nuget:?package=MailKitSimplified.Sender&version=0.1.2.3 // Install MailKitSimplified.Sender as a Cake Tool #tool nuget:?package=MailKitSimplified.Sender&version=0.1.2.3
MailKitSimplified.Sender ![Build and Test results summary](https://github.com/danzuep/MailKitSimplified.Sender/actions/workflows/build-test.yml/badge.svg)
Sending and receiving emails sounds simple, after all, electronic mail existed decades before the Internet. If you're looking for a an all-in-one .NET solution for email, you'll quickly discover MailKit is recommended by even the likes of Microsoft. Unfortunately for new users though, MailKit can do too much, so when I first started using it I was surprised at how many configuration steps were involved in getting it set up, and on the receiving end how poorly some real-world SMTP servers out there implement the standard. The aim of this package is to make sending an email as simple as possible.
Usage
Setup
If you're not sure what dependency injection is then just use this:
using var smtpSender = MimeMessageSender.Create("smtp.example.com");
Sending Mail
var email = smtpSender.WriteEmail
.From("me@example.com", "My Name")
.To("you@example.com", "Your Name")
.To("friend1@example.com")
.To("friend2@example.com")
.Subject("Hey You")
.Body("Hello World")
.Attach("C:/Temp/attachment1.txt", "C:/Temp/attachment2.pdf")
.Attach("./attachment3.docx");
await email.SendAsync();
An email must have a From
and at least one To
address, order does not matter.
Setting a subject or body will overwrite previous ones to make things simpler.
Any issues will throw an exception, but you can also opt to just log them and continue with a false
output:
bool isSent = await smtpSender.WriteEmail
.From("me@example.com")
.To("you@example.com")
.TrySendAsync();
_logger.LogInformation("Email {result}.", isSent ? "sent" : "failed to send");
Further examples (detailed MailKit SMPT server logs etc.) can be found in MailKitSimplifiedSenderUnitTests and the example solution file.
Dependency Injection
This is recommended over manual setup as the built-in garbage collector will handle lifetime and disposal.
public class Program
{
public static async Task Main(string[] args)
{
IHost host = Host.CreateDefaultBuilder(args)
.ConfigureServices((context, services) =>
{
services.AddHostedService<Worker>();
ConfigureServices(services, context.Configuration);
})
.Build();
await host.RunAsync();
}
public static void ConfigureServices(IServiceCollection services, IConfiguration configuration)
{
// This adds IOptions<EmailSenderOptions> from appsettings.json
services.Configure<EmailSenderOptions>(configuration
.GetRequiredSection(EmailSenderOptions.SectionName));
services.AddTransient<IFileHandler, FileHandler>();
services.AddTransient<IMimeAttachmentHandler, MimeAttachmentHandler>();
services.AddTransient<IEmail, Email>();
services.AddTransient<IEmailWriter, EmailWriter>();
services.AddTransient<IEmailSender, MimeMessageSender>();
}
}
This can then be referenced with no other setup in your service as follows:
public class EmailService {
private readonly IEmailSender _smtpSender;
public EmailService(IEmailSender smtpSender) {
_smtpSender = smtpSender;
}
}
Receiving Mail
Coming in a sister package in the near future.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- MailKit (>= 3.4.1)
- MailKitSimplified.Core (>= 0.1.2.3)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.2)
- Microsoft.Extensions.Options (>= 6.0.0)
- MimeKit (>= 3.4.1)
- System.ComponentModel.Annotations (>= 5.0.0)
-
net6.0
- MailKit (>= 3.4.1)
- MailKitSimplified.Core (>= 0.1.2.3)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.2)
- Microsoft.Extensions.Options (>= 6.0.0)
- MimeKit (>= 3.4.1)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on MailKitSimplified.Sender:
Package | Downloads |
---|---|
MailKitSimplified.Email
Easy, fluent way to send, receive, forward, and reply to emails with MailKit. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.11.13-tags-v2-11-13-b0001 | 53 | 8/27/2024 |
2.11.13-tags-v2-11-13-a0001 | 56 | 8/25/2024 |
2.11.12 | 77 | 8/25/2024 |
2.11.10 | 84 | 8/21/2024 |
2.11.9 | 148 | 8/7/2024 |
2.10.0 | 1,058 | 5/1/2024 |
2.9.0 | 2,402 | 12/15/2023 |
2.8.0 | 1,864 | 10/24/2023 |
2.7.0 | 670 | 9/28/2023 |
2.6.1 | 391 | 9/20/2023 |
2.6.0 | 319 | 9/20/2023 |
2.5.8 | 287 | 9/20/2023 |
2.5.7 | 318 | 9/19/2023 |
2.5.6 | 295 | 9/18/2023 |
2.5.5 | 411 | 9/14/2023 |
2.5.4 | 564 | 8/21/2023 |
2.5.3 | 355 | 8/19/2023 |
2.5.2 | 484 | 8/11/2023 |
2.5.1 | 479 | 7/30/2023 |
2.5.0 | 446 | 7/29/2023 |
2.4.7 | 1,222 | 1/25/2023 |
2.4.6 | 594 | 1/15/2023 |
2.4.5 | 566 | 1/15/2023 |
2.4.3 | 551 | 1/14/2023 |
2.4.2 | 589 | 1/10/2023 |
2.4.1 | 634 | 1/10/2023 |
2.4.0 | 641 | 12/12/2022 |
2.3.0 | 569 | 12/9/2022 |
2.2.0 | 589 | 12/6/2022 |
2.1.0 | 646 | 12/2/2022 |
2.0.0 | 615 | 12/1/2022 |
1.1.4 | 647 | 11/25/2022 |
1.1.3 | 592 | 11/24/2022 |
1.1.2 | 621 | 11/21/2022 |
1.1.1 | 627 | 11/17/2022 |
1.0.1 | 634 | 11/16/2022 |
0.2.1 | 674 | 11/12/2022 |
0.2.0 | 646 | 11/12/2022 |
0.1.3 | 651 | 11/11/2022 |
0.1.2.3 | 743 | 10/10/2022 |