LiteX.Email.Core 5.0.0

LiteXEmail

Abstract interface to implement any kind of basic email message services (e.g. SMTP, SendGrid, MailKit, AmazonSES, Mailgun, MailChimp, MailJet, ElasticEmail, SendinBlue)

Add a dependency

Nuget

Run the nuget command for installing the client as,

• Install-Package LiteX.Email
• Install-Package LiteX.Email.Core
• Install-Package LiteX.Email.SendGrid
• Install-Package LiteX.Email.MailKit
• Install-Package LiteX.Email.AmazonSES
• Install-Package LiteX.Email.Mailgun
• Install-Package LiteX.Email.MailChimp //COMING SOON
• Install-Package LiteX.Email.SendinBlue //COMING SOON
• Install-Package LiteX.Email.MailJet //COMING SOON
• Install-Package LiteX.Email.ElasticEmail //COMING SOON

Configuration

AppSettings

{
  //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) ---"
  },
  //LiteX SendGrid settings
  "SendGridConfig": {
    "SendGridApiKey": "--- REPLACE WITH YOUR SendGridApiKey ---"
  },
  //LiteX AmazonSES settings
  "AmazonSESConfig": {
    "AmazonSESAccessKey": "--- REPLACE WITH YOUR AmazonSESAccessKey ---",
    "AmazonSESSecretKey": "--- REPLACE WITH YOUR AmazonSESSecretKey ---"
  },
  //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
  },
  //LiteX Mailgun settings
  "MailgunConfig": {
    "MailgunApiKey": "api:key-fakeapikey",
    "MailgunApiBaseUri": "https://api.mailgun.net/v3/",
    "MailgunRequestUri": "fakesandbox.mailgun.org/messages",
    "MailgunFrom": "postmaster@fakesandbox.mailgun.org"
  },
  //LiteX MailChimp settings
  "MailChimpConfig": {
    "MailChimpApiKey": "--- REPLACE WITH YOUR MailChimpApiKey ---"
  },
  //LiteX SendinBlue settings
  "SendinBlueConfig": {
    "SendinBlueApiKey": "--- REPLACE WITH YOUR  ---"
  }
}

Startup Configuration

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 1. Use default configuration from appsettings.json's 'SmtpConfig'
        services.AddLiteXEmail();
        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXEmail(option =>
        {
            option.Host = "";
            option.Username = "";
            option.Password = "";
            option.Port = 443;
            option.Email = "";
            option.EnableSsl = true;
            option.UseDefaultCredentials = true;
            option.DisplayName = "";
        });
        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var smtpConfig = new SmtpConfig();
        services.AddLiteXEmail(smtpConfig);

        // 1. Use default configuration from appsettings.json's 'SendGridConfig'
        services.AddLiteXSendGridEmail();
        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXSendGridEmail(option =>
        {
            option.SendGridApiKey = "";
        });
        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var sendGridConfig = new SendGridConfig();
        services.AddLiteXSendGridEmail(sendGridConfig);

        // 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 = "";
        });
        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var mailKitConfig = new MailKitConfig();
        services.AddLiteXMailKitEmail(mailKitConfig);

        // 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 = "";
        });
        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var amazonSESConfig = new AmazonSESConfig();
        services.AddLiteXAmazonSESEmail(amazonSESConfig);

        // 1. Use default configuration from appsettings.json's 'MailgunConfig'
        services.AddLiteXMailgunEmail();
        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXMailgunEmail(option =>
        {
            option.MailgunApiKey = "";
            option.ApiBaseUri = "";
            option.RequestUri = "";
            option.From = "";
        });
        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var mailgunConfig = new MailgunConfig();
        services.AddLiteXMailgunEmail(mailgunConfig);
    }
}

Usage

Controller or Business layer

[Route("api/[controller]")]
public class CustomerController : Controller
{
    private readonly IEmailSender _emailSender;

    public CustomerController(IEmailSender emailSender)
    {
        _emailSender = emailSender;
    }

    [HttpGet]
    [Route("get-email-provider-type")]
    public IActionResult GetEmailProviderType()
    {
        return Ok(_emailSender.EmailProviderType.ToString());
    }

    [HttpPost]
    [Route("send-email-to-customer")]
    public IActionResult SendEmailToCustomer(Customer customer)
    {
            string subject = "Welcome!",
            body = "Welcome to LiteX!",
            fromAddress = "your@gmail.com",
            fromName = "LiteX",
            toAddress = customer.Email ?? "your@yahoo.com",
            toName = customer.FirstName ?? "Aashish Patel",
            replyToAddress = "your@gmail.com",
            replyToName = "Reply Name";

            IEnumerable<string> bcc = new List<string>() { "your@outlook.com" };
            IEnumerable<string> cc = new List<string>() { "your@gmail.com" };
            IEnumerable<Attachment> attachments = new List<Attachment>();

            _emailSender.SendEmail(subject, body, fromAddress, fromName, toAddress, toName, replyToAddress, replyToName, bcc, cc, attachments);
            //_emailSender.SendEmail(subject, body, fromAddress, fromName, toAddress, toName, replyToAddress, replyToName, bcc, cc);

            // async
            //await _emailSender.SendEmailAsync(subject, body, fromAddress, fromName, toAddress, toName, replyToAddress, replyToName, bcc, cc, attachments);
    }
}

Coming soon

• Logging