LiteX.Email.Mailgun 5.2.0

Wrapper around Mailgun api to send mail messages from any type of application (ASP.NET Core, .Net Standard 2.x).

There is a newer version of this package available.
See the version list below for details.
Install-Package LiteX.Email.Mailgun -Version 5.2.0
dotnet add package LiteX.Email.Mailgun --version 5.2.0
<PackageReference Include="LiteX.Email.Mailgun" Version="5.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add LiteX.Email.Mailgun --version 5.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

LiteX Email Mailgun

LiteX.Email.Mailgun is a email message library which is based on LiteX.Email.Core and Mailgun.

Add a dependency

Nuget

Run the nuget command for installing the client as,

  • Install-Package LiteX.Email.Core
  • Install-Package LiteX.Email.Mailgun

Configuration

AppSettings

{
  //LiteX Mailgun settings
  "MailgunConfig": {
    "MailgunApiKey": "api:key-fakeapikey",
    "MailgunApiBaseUri": "https://api.mailgun.net/v3/",
    "MailgunRequestUri": "fakesandbox.mailgun.org/messages",
    "MailgunFrom": "postmaster@fakesandbox.mailgun.org"
  }
}

Startup Configuration

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        #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.MailgunApiKey = "";
            option.ApiBaseUri = "";
            option.RequestUri = "";
            option.From = "";
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var mailgunConfig = new MailgunConfig()
        {
            MailgunApiKey = "",
            ApiBaseUri = "",
            RequestUri = "",
            From = ""
        };
        services.AddLiteXMailgunEmail(mailgunConfig);

        #endregion
    }
}

Usage

Controller or Business layer

/// <summary>
/// Customer controller
/// </summary>
[Route("api/[controller]")]
public class CustomerController : Controller
{
    #region Fields

    private readonly IEmailSender _emailSender;

    #endregion

    #region Ctor

    /// <summary>
    /// Ctor
    /// </summary>
    /// <param name="emailSender"></param>
    public CustomerController(IEmailSender emailSender)
    {
        _emailSender = emailSender;
    }

    #endregion

    #region Methods

    /// <summary>
    /// Get Email Provider Type
    /// </summary>
    /// <returns></returns>
    [HttpGet]
    [Route("get-email-provider-type")]
    public IActionResult GetEmailProviderType()
    {
        return Ok(_emailSender.EmailProviderType.ToString());
    }

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

            IEnumerable<string> bcc = new List<string>() { "abc@outlook.com" };
            IEnumerable<string> cc = new List<string>() { "abc@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);


            return Ok();
        }
        catch (Exception ex)
        {

            return BadRequest(ex);
        }
    }

    #endregion

    #region Utilities

    private IList<Customer> GetCustomers()
    {
        IList<Customer> customers = new List<Customer>();

        customers.Add(new Customer() { Id = 1, Username = "ashish", Email = "abc@outlook.com" });

        return customers;
    }

    private Customer GetCustomerById(int id)
    {
        Customer customer = null;

        customer = GetCustomers().ToList().FirstOrDefault(x => x.Id == id);

        return customer;
    }

    #endregion
}

Coming soon

  • Logging

LiteX Email Mailgun

LiteX.Email.Mailgun is a email message library which is based on LiteX.Email.Core and Mailgun.

Add a dependency

Nuget

Run the nuget command for installing the client as,

  • Install-Package LiteX.Email.Core
  • Install-Package LiteX.Email.Mailgun

Configuration

AppSettings

{
  //LiteX Mailgun settings
  "MailgunConfig": {
    "MailgunApiKey": "api:key-fakeapikey",
    "MailgunApiBaseUri": "https://api.mailgun.net/v3/",
    "MailgunRequestUri": "fakesandbox.mailgun.org/messages",
    "MailgunFrom": "postmaster@fakesandbox.mailgun.org"
  }
}

Startup Configuration

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        #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.MailgunApiKey = "";
            option.ApiBaseUri = "";
            option.RequestUri = "";
            option.From = "";
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var mailgunConfig = new MailgunConfig()
        {
            MailgunApiKey = "",
            ApiBaseUri = "",
            RequestUri = "",
            From = ""
        };
        services.AddLiteXMailgunEmail(mailgunConfig);

        #endregion
    }
}

Usage

Controller or Business layer

/// <summary>
/// Customer controller
/// </summary>
[Route("api/[controller]")]
public class CustomerController : Controller
{
    #region Fields

    private readonly IEmailSender _emailSender;

    #endregion

    #region Ctor

    /// <summary>
    /// Ctor
    /// </summary>
    /// <param name="emailSender"></param>
    public CustomerController(IEmailSender emailSender)
    {
        _emailSender = emailSender;
    }

    #endregion

    #region Methods

    /// <summary>
    /// Get Email Provider Type
    /// </summary>
    /// <returns></returns>
    [HttpGet]
    [Route("get-email-provider-type")]
    public IActionResult GetEmailProviderType()
    {
        return Ok(_emailSender.EmailProviderType.ToString());
    }

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

            IEnumerable<string> bcc = new List<string>() { "abc@outlook.com" };
            IEnumerable<string> cc = new List<string>() { "abc@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);


            return Ok();
        }
        catch (Exception ex)
        {

            return BadRequest(ex);
        }
    }

    #endregion

    #region Utilities

    private IList<Customer> GetCustomers()
    {
        IList<Customer> customers = new List<Customer>();

        customers.Add(new Customer() { Id = 1, Username = "ashish", Email = "abc@outlook.com" });

        return customers;
    }

    private Customer GetCustomerById(int id)
    {
        Customer customer = null;

        customer = GetCustomers().ToList().FirstOrDefault(x => x.Id == id);

        return customer;
    }

    #endregion
}

Coming soon

  • Logging

Release Notes

Async support.
     Added new extensions methods.
     Other configuration level code changes.
     Bug fixes.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
8.1.0 286 4/5/2020
8.0.0 933 9/19/2019
7.1.0 438 11/25/2018
7.0.0 295 8/19/2018
6.1.0 342 7/14/2018
6.0.0 344 7/2/2018
5.3.0 362 6/21/2018
5.2.0 326 6/20/2018
5.1.0 354 6/18/2018
5.0.0 349 6/10/2018
4.0.0 317 5/7/2018
3.0.1 376 4/30/2018
3.0.0 340 4/30/2018
Show less