KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

serilog-sinks-email

★ 91 Open GitHub ↗

A Serilog sink that writes events to SMTP email

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Serilog.Sinks.Email&nbsp;[![Build status](https://github.com/serilog/serilog-sinks-email/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/serilog/serilog-sinks-email/actions)&nbsp;[![NuGet Version](http://img.shields.io/nuget/v/Serilog.Sinks.Email.svg?style=flat)](https://www.nuget.org/packages/Serilog.Sinks.Email/)

Sends log events by SMTP email.

> ℹ️ Version 3.x of this package changes the name and structure of many configuration parameters from their 2.x names; see below for detailed information.

**Package Id:** [Serilog.Sinks.Email](http://nuget.org/packages/serilog.sinks.email)

```csharp
await using var log = new LoggerConfiguration()
    .WriteTo.Email(
        from: "app@example.com",
        to: "support@example.com",
        host: "smtp.example.com")
    .CreateLogger();
```

Supported options are:

| Parameter              | Description                                                                                                                         |
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `from`                 | The email address emails will be sent from.                                                                                         |
| `to`                   | The email address emails will be sent to. Multiple addresses can be separated with commas or semicolons.                            |
| `host`                 | The SMTP server to use.                                                                                                             |
| `port`                 | The port used for the SMTP connection. The default is 25.                                                                           |
| `connectionSecurity`   | Choose the security applied to the SMTP connection. This enumeration type is supplied by MailKit. The default is `Auto`.            |
| `credentials`          | The network credentials to use to authenticate with the mail server.                                                                |
| `subject`              | A message template describing the email subject. The default is `"Log Messages"`.                                                   |
| `body`                 | A message template describing the format of the email body. The default is `"{Timestamp} [{Level}] {Message}{NewLine}{Exception}"`. |
| `formatProvider`       | Supplies culture-specific formatting information. The default is to use the current culture.                                        |

An overload accepting `EmailSinkOptions` can be used to specify advanced options such as batched and/or HTML body templates.

## Sending batch email

To send batch email, supply `WriteTo.Email` with a batch size:

```csharp
await using var log = new LoggerConfiguration()
    .WriteTo.Email(
        options: new()
        {
            From = "app@example.com",
            To = "support@example.com",
            Host = "smtp.example.com",
        },
        batchingOptions: new()
        {
            BatchSizeLimit = 10,
            BufferingTimeLimit = TimeSpan.FromSeconds(30),
        })
    .CreateLogger();
```

Batch formatting can be customized using `options.Body`.

## Sending HTML email

To send HTML email, specify a custom `IBatchTextFormatter` in `options.Body` and set `options.IsBodyHtml` to `true`:

```csharp
await using var log = new LoggerConfiguration()
    .WriteTo.Email(
        options: new()
        {
            From = "app@example.com",
            To = "support@example.com",
            Host = "smtp.example.com",
            Body = new MyHtmlBodyFormatter(),
            IsBodyHtml = true,
        },
        batchingOptions: new()
        {
            BatchSizeLimit = 10,
            BufferingTimeLimit = TimeSpan.FromSeconds(30),
        })
    .CreateLogger();
```

A simplistic HTML formatter is shown below:

```csharp
class MyHtmlBodyFormatter : IBatchTextFormatter
{
    public void FormatBatch(IEnumerable<LogEvent> logEvents, TextWriter output)
    {
        output.Write("<table>");
        foreach (var logEvent in logEvents)
        {
            output.Write("<tr>");
            Format(logEvent, output);
            output.Write("</tr>");
        }

output.Write("</table>");
    }

public void Format(LogEvent logEvent, TextWriter output)
    {
        using var buffer = new StringWriter();
        logEvent.RenderMessage(buffer);
        output.Write(WebUtility.HtmlEncode(buffer.ToString()));
    }
}
```

serilog-sinks-email

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README