IBeam.Communications.Email.SendGrid 2.9.1

dotnet add package IBeam.Communications.Email.SendGrid --version 2.9.1
                    
NuGet\Install-Package IBeam.Communications.Email.SendGrid -Version 2.9.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="IBeam.Communications.Email.SendGrid" Version="2.9.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="IBeam.Communications.Email.SendGrid" Version="2.9.1" />
                    
Directory.Packages.props
<PackageReference Include="IBeam.Communications.Email.SendGrid" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add IBeam.Communications.Email.SendGrid --version 2.9.1
                    
#r "nuget: IBeam.Communications.Email.SendGrid, 2.9.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package IBeam.Communications.Email.SendGrid@2.9.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=IBeam.Communications.Email.SendGrid&version=2.9.1
                    
Install as a Cake Addin
#tool nuget:?package=IBeam.Communications.Email.SendGrid&version=2.9.1
                    
Install as a Cake Tool

IBeam.Communications.Email.SendGrid

IBeam.Communications.Email.SendGrid implements IEmailService using SendGrid. It lets application and domain services send email through IBeam abstractions without taking a direct dependency on SendGrid SDK types.

When To Use This

  • You use SendGrid for production or staging email.
  • You want provider reliability while keeping business services provider-neutral.
  • You need SendGrid sandbox mode for staging environments.
  • You want SendGrid failures translated into IBeam communication exceptions.

What This Package Contains

Area Type(s) Purpose
Email provider SendGridEmailService Sends EmailMessage through SendGrid.
Provider options SendGridEmailOptions Holds API key, default sender, display name, and sandbox mode.
Address mapping SendGridAddressMapper Converts IBeam email addresses to SendGrid SDK addresses.
DI registration AddIBeamSendGridEmail(IConfiguration) Registers provider options and IEmailService.
Error translation EmailProviderException Wraps provider failures in an IBeam exception shape.

Architecture Fit

API <-- DTO/model object --> Service <-- Entity --> Repository

This package is a provider boundary. Domain services call IEmailService; this package performs SendGrid delivery. Controllers should not call SendGridClient, and repositories should not send email.

Quick Start

using IBeam.Communications.Abstractions;
using IBeam.Communications.Email.SendGrid;

builder.Services.AddIBeamCommunications(builder.Configuration);
builder.Services.AddIBeamSendGridEmail(builder.Configuration);

Configuration:

{
  "IBeam": {
    "Communications": {
      "Email": {
        "FromAddress": "noreply@example.com",
        "FromName": "Example App",
        "SendGrid": {
          "ApiKey": "<sendgrid-api-key>",
          "DefaultFromAddress": "noreply@example.com",
          "DefaultFromDisplayName": "Example App",
          "SandboxMode": false
        }
      }
    }
  }
}

Send email:

public sealed class InvitationService
{
    private readonly IEmailService _email;

    public InvitationService(IEmailService email)
    {
        _email = email;
    }

    public Task SendInviteAsync(string recipient, CancellationToken ct = default)
    {
        var message = new EmailMessage
        {
            Subject = "You are invited",
            HtmlBody = "<p>Open the app to accept your invite.</p>",
            TextBody = "Open the app to accept your invite."
        };
        message.To.Add(recipient);

        return _email.SendAsync(message, ct: ct);
    }
}

Configuration

Setting Default Purpose
IBeam:Communications:Email:SendGrid:ApiKey required SendGrid API key. Store this securely.
IBeam:Communications:Email:SendGrid:DefaultFromAddress required Provider-level default sender address.
IBeam:Communications:Email:SendGrid:DefaultFromDisplayName null Provider-level default sender display name.
IBeam:Communications:Email:SendGrid:SandboxMode false Sends to SendGrid sandbox mode so messages are accepted but not delivered.
IBeam:Communications:Email:FromAddress empty Shared sender fallback used by IBeam sender resolution.
IBeam:Communications:Email:FromName null Shared sender display-name fallback.

Service Operations, Auditing, And Permissions

The SendGrid provider is not the audit boundary. Tag and wrap the consuming service operation.

[IBeamOperation("accounts.invite")]
public Task InviteAsync(Guid tenantId, Guid inviteId, CancellationToken ct = default)
    => _operations.ExecuteAsync(
        this,
        token => InviteCoreAsync(tenantId, inviteId, token),
        new ServiceOperationExecutionOptions
        {
            TenantId = tenantId,
            EntityId = inviteId
        },
        ct);

Operation names such as accounts.invite can later be used by IBeam access-control rules and audit queries.

Data Storage

This package does not create database tables, Azure Table Storage tables, or local durable stores.

Storage Item Created By This Package Notes
Email outbox No Add an application-specific outbox if retries/history are required.
Provider delivery records No SendGrid owns provider-side event/activity records.
Azure Table Storage tables No No schema is owned by this package.

Extension Points

Extension Point Interface Why Replace It
Delivery provider IEmailService Replace SendGrid with SMTP, ACS, pickup directory, or a custom provider.
Template rendering IEmailTemplateRenderer Render content before it reaches SendGrid.
Retry/outbox Consuming service/repository Add durable retry behavior outside the provider.

Package Relationships

Package Relationship
IBeam.Communications Shared email abstractions and message models.
IBeam.Communications.Email.SendGrid SendGrid email provider implementation.
IBeam.Communications.Email.Templating Optional template renderer that sends through IEmailService.

Extended Examples And Agent Guidance

Troubleshooting

Problem Likely Cause Fix
Startup fails with ApiKey is required Missing SendGrid API key Configure IBeam:Communications:Email:SendGrid:ApiKey.
Startup fails with DefaultFromAddress is required Missing provider sender Configure DefaultFromAddress and verify the sender/domain in SendGrid.
SendGrid returns 4xx Invalid request, sender, recipient, or API authorization Check provider error details and SendGrid account configuration.
Messages accepted but not delivered SandboxMode is enabled Set SandboxMode to false outside staging/test.
No audit row is written Provider sends are not business operations Wrap the consuming service method with IServiceOperationExecutor.

Version Notes

  • Targets net10.0.
  • Uses SendGrid and SendGrid.Extensions.DependencyInjection.
  • Package version is assigned by the repository release workflow.
Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.9.1 41 7/23/2026
2.9.0 83 7/21/2026
2.8.2 83 7/21/2026
2.8.1 77 7/21/2026
2.8.0 83 7/21/2026
2.7.0 79 7/21/2026
2.6.0 82 7/20/2026
2.5.0 97 7/17/2026
2.4.2 87 7/16/2026
2.4.1 85 7/14/2026
2.4.0 105 6/24/2026
2.3.0 100 6/24/2026
2.2.0 109 6/23/2026
2.1.0 105 6/23/2026
2.0.68 99 6/23/2026
2.0.66 105 6/22/2026
2.0.65 102 6/22/2026
2.0.64 104 6/17/2026
2.0.63 110 6/16/2026
2.0.62 111 6/16/2026
Loading failed