Decode.Email.SendGrid 3.0.0

Decode.Email.SendGrid

SendGrid API email provider implementation with template engine, ASM unsubscribe groups, and console dev logger mode for the Decode ecosystem.

🚀 Features

• SendGrid API Integration: Native integration with SendGrid Web API v3 using official SDK.
• ASM Unsubscribe Groups: Out-of-the-box support for SendGrid unsubscribe group IDs configured via options or per-message metadata.
• Console Dev Logger Mode: Set UseConsoleLogger = true in development to log email payload without consuming API credits.
• Template Engine Integration: Full support for HTML template rendering (#TAG# or {{TAG}}).

📦 Installation

Add the package to your API or Infrastructure project:

dotnet add package Decode.Email.SendGrid

🛠️ Setup

1. Configure Services in Program.cs

// 1. Register SendGrid Email Provider bound to configuration section
builder.Services.AddDecodeSendGridEmail(builder.Configuration.GetSection("SendGridEmailOptions"));

// 2. (Optional) Register Embedded Email Templates from your Application Assembly
builder.Services.AddDecodeEmailEmbeddedTemplates(typeof(Program).Assembly, "MyApp.Domain.EmailTemplates");

2. Add Configuration in appsettings.json

{
  "SendGridEmailOptions": {
    "ApiKey": "SG.your_sendgrid_api_key",
    "DefaultFromEmail": "noreply@mydomain.com",
    "DefaultFromName": "My Application",
    "UnsubscribeGroupId": 12345,
    "UseConsoleLogger": false
  }
}

📖 Usage Example

Sending a Templated Email

using Decode.Email.Abstractions.Interfaces;
using Decode.Email.Abstractions.Models;

public class WelcomeHandler(IEmailService emailService)
{
    public async Task HandleAsync(string userEmail, string userName)
    {
        await emailService.SendTemplateAsync(
            to: new EmailAddress(userEmail, userName),
            subject: "Welcome to Our Platform",
            templateName: "WelcomeEmail",
            model: new
            {
                NOME = userName,
                CODE = "123456"
            }
        );
    }
}

Overriding Unsubscribe Group ID per Message

EmailMessage message = new()
{
    From = new EmailAddress("noreply@mydomain.com"),
    To = [new EmailAddress("user@domain.com")],
    Subject = "Special Promotion",
    BodyHtml = "<h1>Check out our offer!</h1>"
};

// Override default Unsubscribe Group ID for marketing emails
message.ProviderMetadata["UnsubscribeGroupId"] = 99887;

await emailService.SendAsync(message);

📄 License

This project is licensed under the MIT License.