MailKitSimplified.Receiver 2.10.0-tags-v2-10-0-rc-0001

This is a prerelease version of MailKitSimplified.Receiver.
There is a newer version of this package available.
See the version list below for details.
dotnet add package MailKitSimplified.Receiver --version 2.10.0-tags-v2-10-0-rc-0001
NuGet\Install-Package MailKitSimplified.Receiver -Version 2.10.0-tags-v2-10-0-rc-0001
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MailKitSimplified.Receiver" Version="2.10.0-tags-v2-10-0-rc-0001" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MailKitSimplified.Receiver --version 2.10.0-tags-v2-10-0-rc-0001
#r "nuget: MailKitSimplified.Receiver, 2.10.0-tags-v2-10-0-rc-0001"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MailKitSimplified.Receiver as a Cake Addin
#addin nuget:?package=MailKitSimplified.Receiver&version=2.10.0-tags-v2-10-0-rc-0001&prerelease

// Install MailKitSimplified.Receiver as a Cake Tool
#tool nuget:?package=MailKitSimplified.Receiver&version=2.10.0-tags-v2-10-0-rc-0001&prerelease

MailKitSimplified Code Size

Sending and receiving emails sounds simple, after all, electronic mail existed decades before the Internet. If you're looking for an all-in-one .NET solution for email, you'll quickly discover MailKit is recommended by even the likes of Microsoft due to how it implements the RFC standard. Unfortunately the downside of doing it all is that MailKit can be difficult to set up and use, especially the first time you go to try something like working with attachments or writing a reply. The aim of this package is to make sending and receiving emails as simple as possible!

SMTP with MailKitSimplified.Sender NuGet Downloads

Sending an email with MailKitSimplified.Sender is as easy as:

using var smtpSender = SmtpSender.Create("localhost");
await smtpSender.WriteEmail.To("test@localhost").SendAsync();

IMAP with MailKitSimplified.Receiver NuGet Downloads

Receiving emails with MailKitSimplified.Receiver is as easy as:

using var imapReceiver = ImapReceiver.Create("localhost");
var mimeMessages = await imapReceiver.ReadMail.Top(1).GetMimeMessagesAsync();

You can even monitor an email folder for new messages asynchronously, never before has it been this easy!

await imapReceiver.MonitorFolder.OnMessageArrival(m => Console.WriteLine(m.UniqueId)).IdleAsync();

Once you've got either a mime message or a message summary, replying is now equally as intuitive.

var mimeReply = mimeMessage.GetReplyMessage("<p>Reply here.</p>").From("noreply@example.com");

You're welcome. 🥲

Example Usage Development Release

The examples above will actually work with no other setup if you use something like smtp4dev (e.g. docker run -d -p 3000:80 -p 25:25 -p 143:143 rnwood/smtp4dev), but below are some more realistic examples. The cancellation token is recommended but not required.

Sending Mail

using var smtpSender = SmtpSender.Create("smtp.example.com:587")
    .SetCredential("user@example.com", "App1icati0nP455w0rd")
    .SetProtocolLog("Logs/SmtpClient.txt");
await smtpSender.WriteEmail
    .From("my.name@example.com")
    .To("YourName@example.com")
    .Bcc("admin@example.com")
    .Subject("Hello World")
    .BodyHtml("<p>Hi</p>")
    .Attach("appsettings.json")
    .TryAttach(@"Logs\ImapClient.txt")
    .SendAsync(cancellationToken);

See the MailKitSimplified.Sender wiki for more information.

Receiving Mail

using var imapReceiver = ImapReceiver.Create("imap.example.com:993")
    .SetCredential("user@example.com", "App1icati0nP455w0rd")
    .SetProtocolLog("Logs/ImapClient.txt")
    .SetFolder("INBOX");
var mimeMessages = await imapReceiver.ReadMail.Top(10)
    .GetMimeMessagesAsync(cancellationToken);

To only download the message parts you want to use:

var reader = imapReceiver.ReadMail
    .Skip(0).Take(250, continuous: true)
    .Items(MessageSummaryItems.Envelope);
var messageSummaries = await reader.GetMessageSummariesAsync(cancellationToken);

Note: MailKit returns results in ascending order by default, use messageSummaries.Reverse() to get descending results or imapReceiver.ReadMail.Top(#) to get the newest results.

To query unread emails from the IMAP server:

var messageSummaries = await imapReceiver.ReadFrom("INBOX/Subfolder")
    .Query(SearchQuery.NotSeen)
    .ItemsForMimeMessages()
    .GetMessageSummariesAsync(cancellationToken);

To asynchronously monitor the mail folder for incoming messages:

await imapReceiver.MonitorFolder
    .SetMessageSummaryItems()
    .SetIgnoreExistingMailOnConnect()
    .OnMessageArrival(OnArrivalAsync)
    .IdleAsync(cancellationToken);

To asynchronously forward or reply to message summaries as they arrive:

async Task OnArrivalAsync(IMessageSummary messageSummary)
{
    var mimeForward = await messageSummary.GetForwardMessageAsync(
        "<p>FYI.</p>", includeMessageId: true);
    mimeForward.From.Add("from@example.com");
    mimeForward.To.Add("to@example.com");
    //logger.LogInformation($"Reply: \r\n{mimeForward.HtmlBody}");
    //await smtpSender.SendAsync(mimeForward, cancellationToken);
}

See the MailKitSimplified.Receiver wiki for more information.

See Also License

Examples of things like dependency injection, a hosted service, or an ASP.NET API can also be found in the GitHub samples.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on MailKitSimplified.Receiver:

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.10.1-tags-v2-10-1-rc-0001 59 5/17/2024
2.10.0 210 5/1/2024
2.10.0-tags-v2-10-0-rc-0001 129 1/9/2024
2.9.0 1,535 12/15/2023
2.8.3-tags-v2-8-3-rc1-0001 82 12/15/2023
2.8.2-tags-v2-8-2-rc1-0001 95 11/20/2023
2.8.0 293 10/24/2023
2.7.0 312 9/28/2023
2.6.1 207 9/20/2023
2.5.5 201 9/14/2023
2.5.4 369 8/21/2023
2.5.3 131 8/19/2023
2.5.2 173 8/11/2023
2.5.1 155 7/30/2023
2.5.0 127 7/29/2023
2.4.7 782 1/25/2023
2.4.6 267 1/15/2023
2.4.5 268 1/15/2023
2.4.0 342 12/12/2022
2.3.0 255 12/9/2022
2.2.0 275 12/6/2022
2.1.0 297 12/2/2022
2.0.0 297 12/1/2022
1.1.4 303 11/25/2022
1.1.3 283 11/24/2022
1.1.2 297 11/21/2022
1.1.1 315 11/17/2022
1.0.1 326 11/16/2022

2.9.0 .NET 8.0 Target Framework added
     2.7.0 Non-fluent usages marked obsolete
     2.5.0 Reuse existing IImapClient
     2.4.0 MailReader Query
     2.0.0 MailFolderMonitor IdleClient
     1.1.0 ImapReceiver and MailReader