Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/a-patel/litexemail

LiteXEmail is simple yet powerful and very high-performance sms mechanism and incorporating both synchronous and asynchronous usage with some advanced usages which can help us to handle sending email more easier!
https://github.com/a-patel/litexemail

amazonses asp-net-core aspnet-core aspnetcore csharp email emailhelper emailutil emailutility litex mailchimp mailgun mailkit mailmessage message netcore nuget sendgrid sendinblue smtp

Last synced: 2 months ago
JSON representation

LiteXEmail is simple yet powerful and very high-performance sms mechanism and incorporating both synchronous and asynchronous usage with some advanced usages which can help us to handle sending email more easier!

Awesome Lists containing this project

README 

        
# LiteXEmail



> LiteXEmail is simple yet powerful and very high-performance email message sending mechanism and incorporating both synchronous and asynchronous usage with some advanced usages which can help us to handle sending email more easier!



Provide email message service for ASP.NET Core (2.0 and later) applications.



Small library to abstract email message functionalities. Quick setup for any email message provider and very simple wrapper for the widely used email providers. LiteXEmail uses the least common denominator of functionality between the supported providers to send email messages solution. Abstract interface to implement any kind of basic email message services. Having a default/generic implementation to wrap the SMTP, SendGrid, MailKit, Mailgun, MailChimp, AmazonSES, SendinBlue. An email message abstraction.



Very simple configuration in advanced ways. Purpose of this package is to bring a new level of ease to the developers who deal with different email message provider integration with their system and implements many advanced features. You can also write your own and extend it also extend existing providers. Easily migrate or switch between one to another provider with no code breaking changes.



LiteXEmail is an interface to unify the programming model for various email providers. The Core library contains all base interfaces and tools. One should install at least one other LiteXEmail package to get email message implementation.



## Email Providers :books:



- [Smtp](docs/Smtp.md) [![](https://img.shields.io/nuget/dt/LiteX.Email.svg)](https://www.nuget.org/packages/LiteX.Email/) [![](https://img.shields.io/nuget/v/LiteX.Email.svg)](https://www.nuget.org/packages/LiteX.Email/)

- [SendGrid](docs/SendGrid.md) [![](https://img.shields.io/nuget/dt/LiteX.Email.SendGrid.svg)](https://www.nuget.org/packages/LiteX.Email.SendGrid/) [![](https://img.shields.io/nuget/v/LiteX.Email.SendGrid.svg)](https://www.nuget.org/packages/LiteX.Email.SendGrid/)

- [AmazonSES](docs/AmazonSES.md) [![](https://img.shields.io/nuget/dt/LiteX.Email.AmazonSES.svg)](https://www.nuget.org/packages/LiteX.Email.AmazonSES/) [![](https://img.shields.io/nuget/v/LiteX.Email.AmazonSES.svg)](https://www.nuget.org/packages/LiteX.Email.AmazonSES/)

- [MailKit](docs/MailKit.md) [![](https://img.shields.io/nuget/dt/LiteX.Email.MailKit.svg)](https://www.nuget.org/packages/LiteX.Email.MailKit/) [![](https://img.shields.io/nuget/v/LiteX.Email.MailKit.svg)](https://www.nuget.org/packages/LiteX.Email.MailKit/)

- [Mailgun](docs/Mailgun.md) [![](https://img.shields.io/nuget/dt/LiteX.Email.Mailgun.svg)](https://www.nuget.org/packages/LiteX.Email.Mailgun/) [![](https://img.shields.io/nuget/v/LiteX.Email.Mailgun.svg)](https://www.nuget.org/packages/LiteX.Email.Mailgun/)

- [MailJet](docs/MailJet.md) - coming soon

- [MailChimp](docs/MailChimp.md) - coming soon

- [SendinBlue](docs/SendinBlue.md) - coming soon

- [ElasticEmail](docs/ElasticEmail.md) - coming soon



## Features :pager:



- Attachment

- ReplyTo

- Cc, Bcc (multiple)

- Async compatible

- Thread safe, concurrency ready

- Obsolete sync methods

- Multiple provider support (using provider factory)

- Interface based API to support the test driven development and dependency injection

- Leverages a provider model on top of ILiteXEmailSender under the hood and can be extended with your own implementation



## Basic Usage :page_facing_up:



### Step 1 : Install the package :package:



> Choose one kinds of email provider type that you needs and install it via [Nuget](https://www.nuget.org/profiles/iamaashishpatel).

> To install LiteXEmail, run the following command in the [Package Manager Console](http://docs.nuget.org/docs/start-here/using-the-package-manager-console)



```Powershell

PM> Install-Package LiteX.Email

PM> Install-Package LiteX.Email.SendGrid

PM> Install-Package LiteX.Email.AmazonSES

PM> Install-Package LiteX.Email.MailKit

PM> Install-Package LiteX.Email.Mailgun

```



### Step 2 : Configuration 🔨



> Different types of email provider have their own way to config.

> Here are samples that show you how to config.



##### 2.1 : AppSettings



```js

{

  //LiteX Smtp settings

  "SmtpConfig": {

    "Email": "--- REPLACE WITH YOUR Email ---",

    "DisplayName": "--- REPLACE WITH YOUR DisplayName ---",

    "Host": "--- REPLACE WITH Host Host ---",

    "Port": 587, //"--- REPLACE WITH YOUR Port (int) ---",

    "Username": "--- REPLACE WITH YOUR Username ---",

    "Password": "--- REPLACE WITH YOUR Password ---",

    "EnableSsl": true, //"--- REPLACE WITH YOUR EnableSsl (boolean) ---",

    "UseDefaultCredentials": false, //"--- REPLACE WITH YOUR UseDefaultCredentials (boolean) ---",

    "EnableLogging": true

  },



  //LiteX SendGrid settings

  "SendGridConfig": {

    "SendGridApiKey": "--- REPLACE WITH YOUR SendGridApiKey ---",

    "EnableLogging": true

  },



  //LiteX AmazonSES settings

  "AmazonSESConfig": {

    "AmazonSESAccessKey": "--- REPLACE WITH YOUR AmazonSESAccessKey ---",

    "AmazonSESSecretKey": "--- REPLACE WITH YOUR AmazonSESSecretKey ---",

    "AmazonRegion": "--- REPLACE WITH YOUR AmazonRegion ---",

    "EnableLogging": true

  },



  //LiteX MailKit settings

  "MailKitConfig": {

    "Email": "--- REPLACE WITH YOUR Email ---",

    "DisplayName": "--- REPLACE WITH YOUR DisplayName ---",

    "Host": "--- REPLACE WITH Host Host ---",

    "Port": 587, //"--- REPLACE WITH YOUR Port (int) ---",

    "Username": "--- REPLACE WITH YOUR Username ---",

    "Password": "--- REPLACE WITH YOUR Password ---",

    "EnableSsl": false,

    "UseDefaultCredentials": false,

    "EnableLogging": true

  },



  //LiteX Mailgun settings

  "MailgunConfig": {

    "ApiKey": "api:key-fakeapikey",

    "ApiBaseUri": "https://api.mailgun.net/v3/",

    "RequestUri": "fakesandbox.mailgun.org/messages",

    "From": "[email protected]",

    "EnableLogging": true

  },



  //LiteX MailChimp settings

  "MailChimpConfig": {

    "MailChimpApiKey": "--- REPLACE WITH YOUR MailChimpApiKey ---",

    "EnableLogging": true

  },



  //LiteX SendinBlue settings

  "SendinBlueConfig": {

    "SendinBlueApiKey": "--- REPLACE WITH YOUR  ---",

    "EnableLogging": true

  }

}

```



##### 2.2 : Configure Startup Class



```cs

public class Startup

{

    public void ConfigureServices(IServiceCollection services)

    {

        #region LiteX Email (SMTP)



        // 1. Use default configuration from appsettings.json's 'SmtpConfig'

        services.AddLiteXSmtpEmail();



        //OR

        // 2. Load configuration settings using options.

        services.AddLiteXSmtpEmail(option =>

        {

            option.Host = "";

            option.Username = "";

            option.Password = "";

            option.Port = 443;

            option.Email = "";

            option.EnableSsl = true;

            option.UseDefaultCredentials = true;

            option.DisplayName = "";

            option.EnableLogging = true;

        });



        //OR

        // 3. Load configuration settings on your own.

        // (e.g. appsettings, database, hardcoded)

        var smtpConfig = new SmtpConfig()

        {

            Host = "",

            Username = "",

            Password = "",

            Port = 443,

            Email = "",

            EnableSsl = true,

            UseDefaultCredentials = true,

            DisplayName = "",

            EnableLogging = true

        };

        services.AddLiteXSmtpEmail(smtpConfig);



        #endregion



        #region LiteX Email (SendGrid)



        // 1. Use default configuration from appsettings.json's 'SendGridConfig'

        services.AddLiteXSendGridEmail();



        //OR

        // 2. Load configuration settings using options.

        services.AddLiteXSendGridEmail(option =>

        {

            option.SendGridApiKey = "";

            option.EnableLogging = true;

        });



        //OR

        // 3. Load configuration settings on your own.

        // (e.g. appsettings, database, hardcoded)

        var sendGridConfig = new SendGridConfig()

        {

            SendGridApiKey = "",

            EnableLogging = true

        };

        services.AddLiteXSendGridEmail(sendGridConfig);



        #endregion



        #region LiteX Email (MailKit)



        // 1. Use default configuration from appsettings.json's 'MailKitConfig'

        services.AddLiteXMailKitEmail();



        //OR

        // 2. Load configuration settings using options.

        services.AddLiteXMailKitEmail(option =>

        {

            option.Host = "";

            option.Username = "";

            option.Password = "";

            option.Port = 443;

            option.Email = "";

            option.EnableSsl = true;

            option.UseDefaultCredentials = true;

            option.DisplayName = "";

            option.EnableLogging = true;

        });



        //OR

        // 3. Load configuration settings on your own.

        // (e.g. appsettings, database, hardcoded)

        var mailKitConfig = new MailKitConfig()

        {

            Host = "",

            Username = "",

            Password = "",

            Port = 443,

            Email = "",

            EnableSsl = true,

            UseDefaultCredentials = true,

            DisplayName = "",

            EnableLogging = true

        };

        services.AddLiteXMailKitEmail(mailKitConfig);



        #endregion



        #region LiteX Email (AmazonSES)



        // 1. Use default configuration from appsettings.json's 'AmazonSESConfig'

        services.AddLiteXAmazonSESEmail();



        //OR

        // 2. Load configuration settings using options.

        services.AddLiteXAmazonSESEmail(option =>

        {

            option.AmazonSESAccessKey = "";

            option.AmazonSESSecretKey = "";

            option.AmazonRegion = "";

            option.EnableLogging = true;

        });



        //OR

        // 3. Load configuration settings on your own.

        // (e.g. appsettings, database, hardcoded)

        var amazonSESConfig = new AmazonSESConfig()

        {

            AmazonSESAccessKey = "",

            AmazonSESSecretKey = "",

            AmazonRegion = "",

            EnableLogging = true

        };

        services.AddLiteXAmazonSESEmail(amazonSESConfig);



        #endregion



        #region LiteX Email (Mailgun)



        // 1. Use default configuration from appsettings.json's 'MailgunConfig'

        services.AddLiteXMailgunEmail();



        //OR

        // 2. Load configuration settings using options.

        services.AddLiteXMailgunEmail(option =>

        {

            option.ApiKey = "";

            option.ApiBaseUri = "";

            option.RequestUri = "";

            option.From = "";

            option.EnableLogging = true;

        });



        //OR

        // 3. Load configuration settings on your own.

        // (e.g. appsettings, database, hardcoded)

        var mailgunConfig = new MailgunConfig()

        {

            ApiKey = "",

            ApiBaseUri = "",

            RequestUri = "",

            From = "",

            EnableLogging = true

        };

        services.AddLiteXMailgunEmail(mailgunConfig);



        #endregion



        // add logging (optional)

        services.AddLiteXLogging();

    }

}

```



### Step 3 : Use in Controller or Business layer :memo:



```cs

/// 

/// Customer controller

/// 

[Route("api/[controller]")]

public class CustomerController : Controller

{

    #region Fields



    private readonly ILiteXEmailSender _emailSender;



    #endregion



    #region Ctor



    /// 

    /// Ctor

    /// 

    /// 

    public CustomerController(ILiteXEmailSender emailSender)

    {

        _emailSender = emailSender;

    }



    #endregion



    #region Methods



    /// 

    /// Get Email Provider Type

    /// 

    /// 

    [HttpGet]

    [Route("get-email-provider-type")]

    public IActionResult GetEmailProviderType()

    {

        return Ok(_emailSender.EmailProviderType.ToString());

    }



    /// 

    /// Send Email 

    /// 

    /// Email Message

    /// 

    [HttpPost]

    [Route("send-email")]

    public async Task SendEmailToCustomer(EmailMessage emailMessage)

    {

        var message = EnsureValidEmailMessage(emailMessage);



        var subject = message.Subject;

        var body = message.Body;

        var fromAddress = message.FromAddress;

        var fromName = message.FromName;

        var toAddress = message.ToAddress;

        var toName = message.ToName;

        var replyToAddress = message.ReplyToAddress;

        var replyToName = message.ReplyToName;

        var isHtml = message.IsHtml;

        var mailPriority = message.MailPriority;



        IEnumerable bcc = new List() { message.Bcc };

        IEnumerable cc = new List() { message.Cc };



        // async

        var result = await _emailSender.SendEmailAsync(subject, body, fromAddress, fromName, toAddress, toName, replyToAddress, replyToName, bcc, cc, isHtml: isHtml, priority: mailPriority);



        //// sync

        //var result = _emailSender.SendEmail(subject, body, fromAddress, fromName, toAddress, toName, replyToAddress, replyToName, bcc, cc, isHtml: isHtml, priority: mailPriority);

        //var result = _emailSender.SendEmail(subject, body, fromAddress, fromName, toAddress, toName, replyToAddress, replyToName, bcc, cc, isHtml: isHtml, priority: mailPriority);



        return Ok(result);

    }



    /// 

    /// Send email with attachment

    /// 

    /// Email Message

    /// Attachment

    /// 

    [HttpPost]

    [Route("send-email-with-attachment")]

    [AddSwaggerFileUploadButton]

    public async Task SendEmailToCustomerWithAttachment(EmailMessage emailMessage, IFormFile file)

    {

        var message = EnsureValidEmailMessage(emailMessage);



        var subject = message.Subject;

        var body = message.Body;

        var fromAddress = message.FromAddress;

        var fromName = message.FromName;

        var toAddress = message.ToAddress;

        var toName = message.ToName;

        var replyToAddress = message.ReplyToAddress;

        var replyToName = message.ReplyToName;

        var isHtml = message.IsHtml;

        var mailPriority = message.MailPriority;



        IEnumerable bcc = new List() { message.Bcc };

        IEnumerable cc = new List() { message.Cc };

        List attachments = new List

            {

                new Attachment()

                {

                    ContentType = file?.ContentType,

                    Filename = file?.FileName,

                    Data = file?.OpenReadStream()

                }

            };



        // async

        var result = await _emailSender.SendEmailAsync(subject, body, fromAddress, fromName, toAddress, toName, replyToAddress, replyToName, bcc, cc, attachments: attachments, isHtml: isHtml, priority: mailPriority);



        //// sync

        //var result = _emailSender.SendEmail(subject, body, fromAddress, fromName, toAddress, toName, replyToAddress, replyToName, bcc, cc, attachments: attachments, isHtml: isHtml, priority: mailPriority);

        //var result = _emailSender.SendEmail(subject, body, fromAddress, fromName, toAddress, toName, replyToAddress, replyToName, bcc, cc, isHtml: isHtml, priority: mailPriority);



        return Ok(result);

    }



    #endregion



    #region Utilities



    private EmailMessage EnsureValidEmailMessage(EmailMessage emailMessage)

    {

        var message = new EmailMessage()

        {

            Subject = emailMessage.Subject ?? "LiteX Email!",

            Body = emailMessage.Body ?? "Welcome to LiteX Email Service!",

            FromAddress = emailMessage.FromAddress ?? "[email protected]",

            FromName = emailMessage.FromName ?? "LiteX",

            ToAddress = emailMessage.ToAddress ?? "[email protected]",

            ToName = emailMessage.ToName ?? "Aashish Patel",

            ReplyToAddress = emailMessage.ReplyToAddress ?? "[email protected]",

            ReplyToName = emailMessage.ReplyToName ?? "Ashish Patel",

            Bcc = emailMessage.FromAddress ?? "[email protected]",

            Cc = emailMessage.FromAddress ?? "[email protected]",

            IsHtml = emailMessage.IsHtml,

            MailPriority = emailMessage.MailPriority,

        };



        message.Body = $"{message.Body} - Provider: {_emailSender.EmailProviderType.ToString()}";



        return message;

    }



    #endregion

}

```



## Todo List :clipboard:



#### Storage Providers



- [x] Smtp

- [x] SendGrid

- [x] AmazonSES

- [x] MailKit

- [x] Mailgun

- MailJet

- MailChimp

- SendinBlue

- ElasticEmail



#### Basic Storage API



- [x] SendEmail



#### Coming soon



- .NET Standard 2.1 support

- .NET 5.0 support

- Remove sync methods

- Response Result

- Bulk Email



---



## Give a Star! :star:



Feel free to request an issue on github if you find bugs or request a new feature. Your valuable feedback is much appreciated to better improve this project. If you find this useful, please give it a star to show your support for this project.



## Support :telephone:



> Reach out to me at one of the following places!



- Email :envelope: at `[email protected]`

- NuGet :package: at `@iamaashishpatel`



## Author :boy:



* **Ashish Patel** - [A-Patel](https://github.com/a-patel)



##### Connect with me



| Linkedin | Website | Medium | NuGet | GitHub | Microsoft | Facebook | Twitter | Instagram | Tumblr |

|----------|----------|----------|----------|----------|----------|----------|----------|----------|----------|

| [![linkedin](https://img.icons8.com/ios-filled/96/000000/linkedin.png)](https://www.linkedin.com/in/iamaashishpatel) | [![website](https://img.icons8.com/wired/96/000000/domain.png)](https://aashishpatel.netlify.app/) | [![medium](https://img.icons8.com/ios-filled/96/000000/medium-monogram.png)](https://medium.com/@iamaashishpatel) | [![nuget](https://img.icons8.com/windows/96/000000/nuget.png)](https://nuget.org/profiles/iamaashishpatel) | [![github](https://img.icons8.com/ios-glyphs/96/000000/github.png)](https://github.com/a-patel) | [![microsoft](https://img.icons8.com/ios-filled/90/000000/microsoft.png)](https://docs.microsoft.com/en-us/users/iamaashishpatel) | [![facebook](https://img.icons8.com/ios-filled/90/000000/facebook.png)](https://www.facebook.com/aashish.mrcool) | [![twitter](https://img.icons8.com/ios-filled/96/000000/twitter.png)](https://twitter.com/aashish_mrcool) | [![instagram](https://img.icons8.com/ios-filled/90/000000/instagram-new.png)](https://www.instagram.com/iamaashishpatel/) | [![tumblr](https://img.icons8.com/ios-filled/96/000000/tumblr--v1.png)](https://iamaashishpatel.tumblr.com/) |



## Donate :dollar:



If you find this project useful — or just feeling generous, consider buying me a beer or a coffee. Cheers! :beers: :coffee:



| PayPal | BMC | Patreon |

| ------------- | ------------- | ------------- |

| [![PayPal](https://www.paypalobjects.com/webstatic/en_US/btn/btn_donate_pp_142x27.png)](https://www.paypal.me/iamaashishpatel) | [![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/iamaashishpatel) | [![Patreon](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/iamaashishpatel) |



## License :lock:



This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.