CPIT.SMTPEmailSender.Core 1.0.1

EmailSender

A flexible email sending library for .NET with template support.

Features

• SMTP email sending with secure connections
• Multiple email providers
• Template support (Razor or HTML)
• Embedded resource templates support
• Attachment support
• Error handling with retries
• DI integration with ASP.NET Core

Installation

dotnet add package CPIT.SMTPEmailSender.Core

Quick Start

Configure in appsettings.json

{
  "SmtpSettings": {
    "Server": "smtp.example.com",
    "EmailAddress": "noreply@example.com",
    "EmailDisplayName": "Application Name",
    "Port": 587,
    "Username": "smtp_username",
    "Password": "smtp_password",
    "SecurityOption": "StartTlsWhenAvailable",
    "LocalDomain": "optional_domain"
  },
  "EmailSender": {
    "AddFooter": true,
    "TemplateLocation": "EmailTemplates"
  }
}

Register services

builder.Services.AddEmailSender(builder.Configuration);

Use in code

public class EmailService
{
    private readonly IEmailSender _emailSender;
    
    public EmailService(IEmailSender emailSender)
    {
        _emailSender = emailSender;
    }
    
    public async Task SendWelcomeEmailAsync(string userEmail, string userName)
    {
        var message = EmailMessage.CreateFromTemplate(
            "WelcomeEmail.cshtml", 
            "Welcome to our application!"
        ) with
        {
            Recipients = new[] { EmailRecipient.Create(userEmail, userName) }
        };
        
        var model = new WelcomeEmailModel
        {
            UserName = userName,
            CurrentDate = DateTime.Now
        };
        
        var options = new EmailSendOptions
        {
            BaseUrl = "https://example.com",
            RetryCount = 3
        };
        
        var result = await _emailSender.SendEmailAsync(message, model, options);
        
        if (!result.IsSuccess)
        {
            Console.WriteLine($"Failed to send email: {result.ErrorMessage}");
        }
    }
}

Template Options

File-based Templates

Templates can be stored in the file system:

// Simple template with extension
var message = EmailMessage.CreateFromTemplate("WelcomeEmail.cshtml", "Welcome!");

// Template in configured template location
var message = EmailMessage.CreateFromTemplate("Newsletter.cshtml", "Newsletter");

Embedded Resource Templates

Templates can also be embedded in assemblies:

// Fully qualified embedded resource path
var message = EmailMessage.CreateFromTemplate(
    "Company.Project.EmailTemplates.WelcomeEmail.cshtml", 
    "Welcome!"
);

To use embedded resources:

1. Add template files to the project
2. Set their Build Action to "Embedded Resource"
3. Reference them using the full namespace path

Advanced Configuration

Builder Pattern

services.AddEmailSender(builder =>
{
    builder.UseSmtp(options =>
    {
        options.Server = "smtp.example.com";
        options.Port = 587;
        options.EmailAddress = "noreply@example.com";
        options.EmailDisplayName = "Application Name";
        options.Username = "smtp_username";
        options.Password = "smtp_password";
    });
    
    builder.Configure(options =>
    {
        options.AddFooter = true;
        options.TemplateLocation = "EmailTemplates";
    });
});

Custom Implementations

services.AddEmailSender(builder =>
{
    builder.UseProvider<CustomEmailProvider>();
    builder.UseTemplateRenderer<CustomTemplateRenderer>();
});

License

This project is licensed under the MIT License.