GaEpd.EmailService 1.2.0

Prefix Reserved

dotnet add package GaEpd.EmailService --version 1.2.0

NuGet\Install-Package GaEpd.EmailService -Version 1.2.0

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="GaEpd.EmailService" Version="1.2.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="GaEpd.EmailService" Version="1.2.0" />
                    

                            Directory.Packages.props

<PackageReference Include="GaEpd.EmailService" />
                    

                            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 GaEpd.EmailService --version 1.2.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: GaEpd.EmailService, 1.2.0"

#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.

#addin nuget:?package=GaEpd.EmailService&version=1.2.0
                    

                            Install GaEpd.EmailService as a Cake Addin

#tool nuget:?package=GaEpd.EmailService&version=1.2.0
                    

                            Install GaEpd.EmailService as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Georgia EPD-IT Email Service Library

This library was created by Georgia EPD-IT to provide common email services for our web applications.

Installation

To install, search for "GaEpd.EmailService" in the NuGet package manager or run the following command:

dotnet add package GaEpd.EmailService

Usage

The IEmailService interface provides a single method, SendEmailAsync(Message message), which sends an email Message. Typical usage would look like this:

// Create the email message.
var message = Message.Create(subject, recipientEmail, textBody, htmlBody, senderName, senderEmail, [ccRecipient]);

// Send the message. There is no need to await this call.
_ = emailService.SendEmailAsync(message, token);

Configuration

The AddEmailService() extension method can be used to register the included implementation with your configuration settings. The DefaultEmailService implementation uses MailKit to send emails.

builder.Services.AddEmailService(builder.Configuration);

The following configuration section should be added to your configuration file:

{
  "EmailServiceSettings": {
    "EnableEmail": true,
    "SmtpHost": "localhost",
    "SmtpPort": 25,
    "SecureSocketOption": "Auto",
    "DefaultSenderName": "Default Sender",
    "DefaultSenderEmail": "Default.Sender@email.invalid",
    "EnableEmailAuditing": true,
    "AuditEmailRecipients": [
      "Audit.Recipient@email.invalid"
    ]
  }
}

EnableEmail: Set to true to enable sending emails.
SmtpHost: The SMTP server to use for sending emails. (Only used if EnableEmail is true.)
SmtpPort: The port to use for the SMTP server. (Only used if EnableEmail is true.)
SecureSocketOption: The MailKit SecureSocketOption to use for the SMTP server. (Only used if EnableEmail is true.) Available options are None, Auto, SslOnConnect, StartTls, and StartTlsWhenAvailable. See the MailKit documentation for a description of each option.
DefaultSenderName: The default sender name (optional, can also be set per message).
DefaultSenderEmail: The default sender email address (optional, can also be set per message).
EnableEmailAuditing: Set to true to enable sending audit emails (useful for testing purposes).
AuditEmailRecipients: A list of email addresses to send audit emails to. (Only used if EnableEmailAuditing is true.)

Note that EnableEmail and EnableEmailAuditing operate independently of each other. You can enable or disable each feature individually.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- MailKitLite (>= 4.12.1)
- Microsoft.Extensions.DependencyInjection (>= 9.0.5)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 9.0.5)
net9.0
- MailKitLite (>= 4.12.1)
- Microsoft.Extensions.DependencyInjection (>= 9.0.5)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 9.0.5)

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
1.2.0	208	6/2/2025
1.1.1	133	6/2/2025
1.1.0	955	1/28/2025
1.0.0	683	12/4/2024

# Changelog
## [1.2.0] - 2025-06-02
- **Breaking change:** The Email Log DB entity, repository interface, and associated setting have all been removed. The
benefit of having these items in the package was negligible. Any desired email logging will need to be independently
implemented by each client application. If your app relied on these items, you can find the originals here and copy
them to your own codebase:
- [EmailLog](https://github.com/gaepdit/email-service/blob/388fb6f29525a3930ba8a5e88ea83f192fdcc1ae/src/EmailService/EmailLogRepository/EmailLog.cs)
- [IEmailLogRepository](https://github.com/gaepdit/email-service/blob/388fb6f29525a3930ba8a5e88ea83f192fdcc1ae/src/EmailService/EmailLogRepository/IEmailLogRepository.cs)
## [1.1.1] - 2025-06-02
- Fixed: Audit emails were formatted incorrectly for emails with no HTML body.
## [1.1.0] - 2025-01-28
- Target .NET 8 & 9.
- Fixed: Email sender was truncated more than required when saving to the repository.
## [1.0.0] - 2024-12-04
_Initial release._
[1.2.0]: https://github.com/gaepdit/email-service/releases/tag/v1.2.0
[1.1.1]: https://github.com/gaepdit/email-service/releases/tag/v1.1.1
[1.1.0]: https://github.com/gaepdit/email-service/releases/tag/v1.1.0
[1.0.0]: https://github.com/gaepdit/email-service/releases/tag/v1.0.0