Aspose.Email
24.11.0
dotnet add package Aspose.Email --version 24.11.0
NuGet\Install-Package Aspose.Email -Version 24.11.0
<PackageReference Include="Aspose.Email" Version="24.11.0" />
paket add Aspose.Email --version 24.11.0
#r "nuget: Aspose.Email, 24.11.0"
// Install Aspose.Email as a Cake Addin #addin nuget:?package=Aspose.Email&version=24.11.0 // Install Aspose.Email as a Cake Tool #tool nuget:?package=Aspose.Email&version=24.11.0
Effortless Email Management API
Aspose.Email for .NET is a comprehensive email management API designed for developers working with Microsoft Outlook® items, MIME messages, email clients, and various protocols including SMTP, POP3, IMAP, Exchange, and Microsoft Graph. It facilitates sending and receiving emails, managing appointments, contacts, and attachments, as well as converting email files between different formats. With support for platforms such as Gmail, Zimbra, Thunderbird, and IBM Notes, Aspose.Email for .NET enables developers to create interactive AMP HTML emails, handle advanced email validation, and read Outlook storage files like PST, OST, and OLM. Whether working with cloud-based email services or handling on-premises email storage, Aspose.Email provides an efficient and flexible solution for managing email data in .NET applications.
Send Email Messages via MailGun and SendGrid
- Send email messages using MailGun or SendGrid services.
- Use
DeliveryServiceOptions
to configure service-specific settings.- Code sample to send an email synchronously and asynchronously.
- Error handling for unsuccessful email deliveries.
Working with MIME Messages
- Create and set email contents in .NET.
- Work with attachments and embedded objects.
- Extract contents from MIME messages.
- Load and save messages using
MailMessage
.- Track document conversion progress and render hyperlinks with custom styles.
Working with Appointments
- Create appointments and save them as
.msg
or.ics
.- Create appointments with HTML content.
- Load appointments in ICS format.
- Convert appointments to
MailMessage
orMapiMessage
.- Read multiple events from an ICS file.
- Write multiple events to an ICS file.
- Determine the appointment version using
Appointment.Version
.
Working with Outlook Items
- Create and save MSG files.
- Load, view, and parse MSG files.
- Manage message files using
Aspose.Email.Outlook
.- Work with voting options, follow-up flags, and due dates.
- Manage attachments, contacts, tasks, notes, calendar items, distribution lists, and recurrences.
Working with Outlook Storage Files
- Create PST files and add subfolders/messages.
- Read and convert OST files.
- Work with messages, contacts, distribution lists, calendar items, MapiTasks, MapiJournal, and MapiNote in PST.
- Split and merge PST files.
- Password protect PST files.
- Read corrupted PST/OST files and convert OLM to PST.
Working with SMTP Client
- Send emails synchronously or asynchronously using
SmtpClient
.- Perform mail merge and row-wise mail merge.
- Use multiconnection mode to send multiple messages concurrently.
- Send messages in TNEF format to preserve email formatting.
- Send meeting requests via email.
Working with POP3 Client
- Delete emails by index or delete all emails using
Pop3Client
.- Cancel deletion of messages using
Pop3Client.UndeleteMessages
.- Validate mail server credentials using
ValidateCredentials
method.
Working with IMAP Client
- Support for IMAP IDLE command to wait for new email.
- List server extensions such as IDLE, UNSELECT, and QUOTA.
- Fetch messages and list attachments.
- Validate mail server credentials.
- Log IMAP activity for debugging.
Working with Exchange EWS Client
- Send meeting requests using
EWSClient
.- Create, update, and cancel appointments.
- List appointments with paging support.
- Add events to secondary calendar folders.
- Share calendar invitations via Exchange server.
Programming with Gmail
- Create, list, delete, fetch, and update Google Calendars.
- Manage calendar access control rules (list, create, update, delete).
- Retrieve client settings and color info.
- Work with appointments: add, retrieve, update, move, and delete.
Programming with Thunderbird
- Write messages to Thunderbird storage using
MboxrdStorageWriter
.- Delete emails using
MboxClient
.
Convert Email Files using C# API
- Convert
.eml
to different formats usingAspose.Email
.- Load
.eml
files and convert them intoMailMessage
.- Convert appointments to
MailMessage
orMapiMessage
.
Working with Zimbra
- Read Zimbra TGZ storage files using
TgzReader
.- Get total items count from a TGZ file.
- Save messages with directory structure.
- Export calendar and contact items from Zimbra backup files.
Email Verification with Aspose.Email
Validate email addresses, domains, and mail servers using
Aspose.Email.Verifications
. Supports syntax-only validation, domain validation, and mail server connection validation usingEmailValidator
.
AMP HTML Email Creation
Create interactive AMP HTML emails using
AmpMessage
with components likeAmpImage
,AmpCarousel
,AmpAccordion
,AmpForm
, and more for enhanced user interaction.
Adding AMP Components
Use classes such as
AmpImage
,AmpCarousel
,AmpForm
,AmpFitText
, andAmpAccordion
to embed various interactive elements in AMP emails.
Detect NSF File Format
Detect if a file is in NSF format using
FileFormatUtil.DetectFileFormat()
.
Read Messages from NSF File
Use
NotesStorageFacility
to read messages from an NSF storage file with theEnumerateMessages
method. Note: Reading folders is not supported.
Supported File Formats
Format | Description | Load | Save |
---|---|---|---|
MSG | This format is used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Aspose.Email supports reading, writing, and modifying MSG files. | ✔️ | ✔️ |
PST | Represents Outlook Personal Storage Files that store emails, calendar items, notes, contacts, and several other file formats. Aspose.Email allows working with PST files, including reading, writing, and manipulating data. | ✔️ | ✔️ |
OST | Represents the user’s mailbox data in offline mode on the local machine upon registration with Exchange Server using Microsoft Outlook. Aspose.Email allows working with OST files, including reading and manipulating data. | ✔️ | ✔️ |
OFT | Message template files created using Microsoft Outlook. Aspose.Email allows working with OFT files, including reading and writing. | ✔️ | ✔️ |
OLM | Format used by Microsoft Outlook for Mac for storing email messages, contacts, journals, calendar data, and other user application data. Aspose.Email supports the extraction, manipulation, and conversion of the data housed within these archives. | ✔️ | |
EML | Represents email messages saved using Outlook and other relevant applications. Aspose.Email provides support for reading and writing EML files, as well as converting them to other formats. | ✔️ | ✔️ |
EMLX | Format used by Apple Mail to store a single email message. Aspose.Email enables reading and writing of EMLX files. | ✔️ | ✔️ |
MBOX | Represents a container for a collection of electronic mail messages. Aspose.Email provides support for reading and writing MBOX files. | ✔️ | ✔️ |
ICS | The iCalendar format used for exchanging and deploying calendar events and scheduling. Aspose.Email provides support for reading and writing ICS files, allowing integration of calendar data into applications. | ✔️ | ✔️ |
VCF | Virtual Card Format is a digital file format for storing contact information. Aspose.Email allows users to read, write, and manipulate contact data. | ✔️ | ✔️ |
HTML | HTML (HyperText Markup Language) is the extension for web pages created for display in browsers. Aspose.Email equips developers with the capability to handle HTML files, facilitating the extraction and utilization of content from these files within their applications. | ✔️ | ✔️ |
MHTML | Web page archive format that saves the HTML code and associated resources in a single file. Aspose.Email supports reading MHTML files, allowing extraction of their content for use in applications. | ✔️ | ✔️ |
Supported Operating Systems
Windows
Windows Server (2003, 2008, 2012), XP, Vista, 7, 8, 8.1, 10, Windows Azure
Linux
Ubuntu, openSUSE, CentOS, and others
Mac
macOS
Supported Frameworks
.NET Frameworks
2.0 - 4.7.2, .NET Standard 2.0, .NET Core (2.0, 2.1)
Mono Framework
Mono 5.4+
Xamarin
Xamarin.Android, Xamarin.iOS, Xamarin.Mac
Development Environments
Microsoft Visual Studio
2010, 2011, 2012, 2013, 2015, 2017, 2019
Installation Steps for Aspose.Email for .NET
1. Install via NuGet
- Open Visual Studio → NuGet Package Manager.
- Search "aspose" and click "Install" for Aspose.Email.
2. Install or Update via Package Manager Console
- Open Package Manager Console (
Tools
→Library Package Manager
→Package Manager Console
). - To install:
Install-Package Aspose.Email -Version x.x.0
- To update:
Update-Package Aspose.Email
3. Reference Aspose.Email in Your Project
- In Solution Explorer, right-click
References
→Add Reference
. - Locate
Aspose.Email.dll
and add it.
4. Uninstall Aspose.Email for .NET
- Go to
Control Panel
→Add/Remove Programs
. - Select
Aspose.Email
and clickRemove
.
5. Target Specific .NET Framework Version
- Modify the configuration file (
.config
) to redirect references if targeting .NET 1.0 instead of 1.1.
Convert MSG File to EML and Preserve RTF Content
This code demonstrates how to load a MSG file, convert it to EML format, and preserve RTF content.
var loadOptions = new MsgLoadOptions
{
PreserveRtfContent = true
};
var eml = MailMessage.Load("my.msg", loadOptions);
var conversionOptions = new MailConversionOptions
{
PreserveRtfContent = true
};
var msg = MapiMessage.Load("my.msg");
var eml = msg.ToMailMessage(conversionOptions);
Retrieve Messages Asynchronously using ImapClient
This code demonstrates how to retrieve messages asynchronously from an IMAP server using Aspose.Email.
List<MailMessage> mailMessages = new List<MailMessage>();
// create mail messages
for (int i = 0; i < 100; i++)
mailMessages.Add(new MailMessage(senderEmail, receiverEmail, $"Message #{i}", "Text"));
using (ImapClient client = new ImapClient(host, 993, senderEmail, password, SecurityOptions.SSLImplicit))
{
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
AutoResetEvent autoResetEvent = new AutoResetEvent(false);
Exception exception = null;
ThreadPool.QueueUserWorkItem(delegate
{
try
{
// start uploading the messages
var task = client.AppendMessagesAsync(mailMessages, cancellationTokenSource.Token);
AppendMessagesResult appendMessagesResult = task.GetAwaiter().GetResult();
Console.WriteLine("All messages have been appended.");
}
catch (Exception ex)
{
exception = ex;
}
finally
{
autoResetEvent.Set();
}
});
autoResetEvent.WaitOne();
}
Extract Email Attachments
This code snippet shows how to extract attachments from an email message, save them, and print the attachment names.
var eml = MailMessage.Load("Message.eml", new MsgLoadOptions());
foreach (var attachment in eml.Attachments)
{
attachment.Save("MessageEmbedded_out.eml");
Console.WriteLine(attachment.Name);
}
Tags
Email Management API
| .NET Email API
| MIME Messages
| Outlook Integration
| SMTP Protocol
| POP3 Protocol
| IMAP Protocol
| Exchange EWS
| Microsoft Graph
| Gmail API
| Thunderbird Email
| Email Conversion
| Zimbra Integration
| AMP HTML Email
| IBM Notes
| Email Validation
| Email Attachments
| Outlook PST
| OST File
| EML Conversion
| Apple Mail
| ICS Format
| Contact Management
| Calendar Events
| Xamarin Support
| Linux Compatible
| macOS Support
| HTML Format
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. 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. net6.0-windows7.0 is compatible. 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 | net20 is compatible. net35 is compatible. net35-client is compatible. net40 is compatible. net40-client is compatible. net403 was computed. net45 is compatible. net451 was computed. net452 was computed. net46 was computed. 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. |
-
.NETFramework 2.0
- No dependencies.
-
.NETFramework 3.5
- No dependencies.
-
.NETFramework 3.5 Client
- No dependencies.
-
.NETFramework 4.0
- No dependencies.
-
.NETFramework 4.0 Client
- No dependencies.
-
.NETFramework 4.5
- No dependencies.
-
.NETStandard 2.0
- System.Security.Cryptography.Pkcs (>= 7.0.3)
- System.Text.Encoding.CodePages (>= 5.0.0)
-
net5.0
- System.Security.Cryptography.Pkcs (>= 7.0.3)
- System.Text.Encoding.CodePages (>= 5.0.0)
-
net6.0
- System.Security.Cryptography.Pkcs (>= 7.0.3)
- System.Text.Encoding.CodePages (>= 5.0.0)
-
net6.0-windows7.0
- System.Drawing.Common (>= 8.0.4)
- System.Security.Cryptography.Pkcs (>= 7.0.3)
- System.Text.Encoding.CodePages (>= 5.0.0)
NuGet packages (11)
Showing the top 5 NuGet packages that depend on Aspose.Email:
Package | Downloads |
---|---|
Aspose.Total
Aspose.Total for .NET is the most complete package of all .NET file format APIs offered by Aspose. It empowers developers to create, edit, render, print and convert between a wide range of popular document formats within any .NET, C#, ASP.NET and VB.NET applications. |
|
TresTechnologies.App.Shared
Shared components for use with applications build for the Tres API, |
|
Weavy.Core
A class library containing core business logic, data access and utility methods required by Weavy. |
|
AutomationFramework_NetCore
AT Net Core Automation Framework |
|
AsposeHelpers
Aspose helpers |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on Aspose.Email:
Repository | Stars |
---|---|
aspose-words/Aspose.Words-for-.NET
Aspose.Words for .NET examples, plugins and showcases
|
|
JasonBock/Rocks
A mocking library based on the Compiler APIs (Roslyn + Mocks)
|
Version | Downloads | Last updated |
---|---|---|
24.11.0 | 460 | 11/30/2024 |
24.10.0 | 12,490 | 10/31/2024 |
24.9.0 | 21,444 | 9/30/2024 |
24.8.0 | 28,671 | 8/30/2024 |
24.7.0 | 31,589 | 7/31/2024 |
24.6.0 | 37,836 | 6/30/2024 |
24.5.0 | 68,825 | 5/31/2024 |
24.4.0 | 50,047 | 4/30/2024 |
24.3.0 | 102,536 | 3/31/2024 |
24.2.0 | 41,525 | 2/29/2024 |
24.1.0 | 73,550 | 1/31/2024 |
23.12.0 | 112,873 | 12/30/2023 |
23.11.0 | 34,798 | 11/30/2023 |
23.10.0 | 57,532 | 10/31/2023 |
23.9.0 | 47,501 | 9/30/2023 |
23.8.0 | 37,216 | 8/31/2023 |
23.7.0 | 68,389 | 7/31/2023 |
23.6.0 | 44,444 | 6/30/2023 |
23.5.1 | 41,627 | 6/10/2023 |
23.5.0 | 25,699 | 5/31/2023 |
23.4.0 | 225,478 | 4/30/2023 |
23.3.0 | 59,609 | 3/31/2023 |
23.2.0 | 86,806 | 2/28/2023 |
23.1.0 | 76,355 | 1/31/2023 |
22.12.0 | 109,849 | 12/31/2022 |
22.11.0 | 61,127 | 11/30/2022 |
22.10.0 | 115,739 | 10/31/2022 |
22.9.0 | 93,326 | 9/30/2022 |
22.8.0 | 107,616 | 8/29/2022 |
22.7.0 | 61,499 | 7/30/2022 |
22.6.0 | 56,399 | 7/1/2022 |
22.5.0 | 83,147 | 5/30/2022 |
22.4.0 | 61,651 | 4/30/2022 |
22.3.0 | 67,022 | 3/31/2022 |
22.2.0 | 78,465 | 2/28/2022 |
22.1.0 | 92,710 | 1/31/2022 |
21.12.0 | 387,986 | 12/24/2021 |
21.11.0 | 31,907 | 11/26/2021 |
21.10.0 | 89,445 | 10/29/2021 |
21.9.0 | 85,809 | 9/30/2021 |
21.8.1 | 51,623 | 9/6/2021 |
21.8.0 | 29,246 | 8/31/2021 |
21.7.0 | 80,351 | 7/30/2021 |
21.6.0 | 75,952 | 6/29/2021 |
21.5.0 | 54,767 | 5/31/2021 |
21.4.0 | 74,245 | 4/30/2021 |
21.3.0 | 34,005 | 3/30/2021 |
21.2.0 | 39,991 | 2/26/2021 |
21.1.1 | 148,848 | 2/1/2021 |
21.1.0 | 17,604 | 1/28/2021 |
20.12.0 | 105,884 | 12/29/2020 |
20.11.0 | 56,286 | 11/24/2020 |
20.10.0 | 59,282 | 11/2/2020 |
20.9.1 | 19,869 | 10/1/2020 |
20.9.0 | 5,168 | 9/28/2020 |
20.8.0 | 41,595 | 8/29/2020 |
20.7.0 | 44,313 | 7/30/2020 |
20.6.0 | 125,759 | 6/29/2020 |
20.5.0 | 39,945 | 5/30/2020 |
20.4.0 | 41,695 | 4/30/2020 |
20.3.0 | 39,866 | 3/31/2020 |
20.2.0 | 77,024 | 2/27/2020 |
20.1.0 | 23,181 | 1/30/2020 |
19.12.0 | 40,004 | 12/27/2019 |
19.11.0 | 223,229 | 11/29/2019 |
19.10.0 | 15,679 | 10/30/2019 |
19.9.0 | 63,110 | 9/28/2019 |
19.8.0 | 34,637 | 8/28/2019 |
19.7.0 | 14,716 | 7/30/2019 |
19.6.0 | 17,957 | 6/29/2019 |
19.5.0 | 44,239 | 6/1/2019 |
19.4.0 | 9,606 | 4/26/2019 |
19.3.0 | 11,485 | 3/29/2019 |
19.2.0 | 18,926 | 2/27/2019 |
19.1.1 | 8,546 | 2/4/2019 |
19.1.0 | 5,966 | 1/31/2019 |
18.12.0 | 22,304 | 12/25/2018 |
18.11.0 | 52,644 | 11/29/2018 |
18.10.0 | 11,154 | 10/24/2018 |
18.9.0 | 8,790 | 9/27/2018 |
18.8.0 | 11,348 | 8/27/2018 |
18.7.0 | 15,293 | 7/27/2018 |
18.6.0 | 18,300 | 6/27/2018 |
18.5.1 | 12,329 | 5/25/2018 |
18.4.0 | 9,765 | 4/26/2018 |
18.3.0 | 17,870 | 3/24/2018 |
18.2.0 | 21,371 | 2/21/2018 |
18.1.0 | 14,147 | 1/18/2018 |
17.12.0 | 45,280 | 12/18/2017 |
17.11.0 | 97,017 | 11/14/2017 |
17.10.0 | 22,326 | 10/9/2017 |
17.9.0 | 10,188 | 9/11/2017 |
17.8.0 | 34,128 | 8/8/2017 |
17.7.0 | 10,241 | 7/7/2017 |
17.6.0 | 17,499 | 6/8/2017 |
17.5.0 | 13,165 | 5/9/2017 |
17.4.0 | 55,124 | 4/7/2017 |
17.3.0 | 32,656 | 3/23/2017 |
17.2.0 | 18,836 | 2/16/2017 |
17.1.0 | 21,575 | 1/17/2017 |
16.12.0 | 315,245 | 12/19/2016 |
16.11.0 | 4,280 | 11/10/2016 |
16.10.0 | 18,880 | 10/10/2016 |
6.9.0 | 9,918 | 9/9/2016 |
6.8.0 | 23,881 | 8/10/2016 |
6.7.0 | 46,470 | 7/8/2016 |
6.6.0 | 10,352 | 6/4/2016 |
6.5.0 | 4,576 | 5/6/2016 |
6.4.0 | 22,048 | 4/11/2016 |
6.3.0 | 8,216 | 3/7/2016 |
6.2.0 | 85,358 | 2/5/2016 |
6.1.0 | 8,268 | 12/31/2015 |
6.0.0 | 5,643 | 12/7/2015 |
5.9.1 | 3,872 | 11/26/2015 |
5.9.0 | 16,035 | 11/5/2015 |
5.8.0 | 41,208 | 10/7/2015 |
5.7.0 | 5,400 | 9/8/2015 |
5.6.0 | 24,075 | 8/8/2015 |
5.5.0 | 14,887 | 7/9/2015 |
5.4.0 | 4,557 | 6/9/2015 |
5.3.0 | 6,468 | 5/5/2015 |
5.2.0 | 4,138 | 4/6/2015 |
5.1.0 | 3,481 | 3/10/2015 |
5.0.0 | 6,105 | 2/9/2015 |
4.9.0 | 6,009 | 1/4/2015 |
4.8.0 | 6,224 | 12/4/2014 |
4.7.0 | 4,263 | 11/3/2014 |
4.6.0 | 3,218 | 10/6/2014 |
4.5.0 | 6,178 | 9/4/2014 |
4.4.0 | 40,015 | 7/30/2014 |
4.3.0 | 6,942 | 7/2/2014 |
4.2.0 | 3,213 | 6/2/2014 |
4.1.0 | 3,504 | 5/2/2014 |
4.0.0 | 7,564 | 3/28/2014 |
3.9.0 | 5,118 | 3/2/2014 |
3.8.0 | 7,888 | 1/28/2014 |
3.7.0 | 24,225 | 12/30/2013 |
3.6.0 | 5,979 | 11/27/2013 |
3.5.0 | 3,424 | 11/1/2013 |
3.4.0 | 3,331 | 10/1/2013 |
3.3.0 | 3,419 | 8/26/2013 |
3.2.0 | 3,142 | 7/29/2013 |
3.1.0 | 3,428 | 6/27/2013 |
3.0.0 | 4,680 | 5/29/2013 |
2.9.0 | 3,859 | 4/29/2013 |
2.8.0 | 6,085 | 3/26/2013 |
2.7.0 | 4,464 | 2/27/2013 |
2.6.0 | 3,306 | 1/28/2013 |
2.5.0 | 3,310 | 12/26/2012 |
2.4.0 | 3,251 | 11/27/2012 |
2.3.0 | 5,630 | 10/30/2012 |
2.2.0 | 3,375 | 9/27/2012 |
2.1.0 | 6,938 | 8/29/2012 |
2.0.0 | 3,284 | 7/30/2012 |
1.9.0 | 3,390 | 6/28/2012 |
1.8.0 | 3,191 | 5/27/2012 |
1.7.1 | 4,827 | 5/9/2012 |
1.7.0 | 2,996 | 4/29/2012 |
1.6.0 | 3,047 | 3/26/2012 |
1.5.0 | 3,123 | 2/24/2012 |
1.4.0.1 | 3,116 | 2/16/2012 |
1.4.0 | 3,624 | 2/2/2012 |
1.3.0 | 5,289 | 1/24/2012 |