Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/codesnippets/BulkSend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
uid: snippets.bulk-send-email
---

# Bulk send an email
Short example of sending email via bulk link.

```csharp
using Mailtrap;
using Mailtrap.Emails.Requests;
using Mailtrap.Emails.Responses;

try
{
var apiToken = "<API-TOKEN>";
using var mailtrapClientFactory = new MailtrapClientFactory(apiToken);
IMailtrapClient mailtrapClient = mailtrapClientFactory.CreateClient();
SendEmailRequest request = SendEmailRequest
.Create()
.From("[email protected]", "Mailtrap Test")
.To("[email protected]")
.Subject("You are awesome!")
.Category("Integration Test")
.Text("Congrats for sending test email with Mailtrap!");
SendEmailResponse? response = await mailtrapClient
.Bulk()
.Send(request);
}
catch (Exception ex)
{
Console.WriteLine("An error occurred while sending email: {0}", ex);
}
```

[!INCLUDE [api-token-caution](../includes/api-token-caution.md)]
41 changes: 41 additions & 0 deletions docs/codesnippets/BulkSendFromTemplate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
uid: snippets.bulk-send-template-email
---

# Bulk send from template
Short example of sending email using template via bulk link.

```csharp
using Mailtrap;
using Mailtrap.Emails.Requests;
using Mailtrap.Emails.Responses;

try
{
var apiToken = "<API-TOKEN>";
using var mailtrapClientFactory = new MailtrapClientFactory(apiToken);
IMailtrapClient mailtrapClient = mailtrapClientFactory.CreateClient();
SendEmailRequest request = SendEmailRequest
.Create()
.From("[email protected]", "Mailtrap Test")
.To("[email protected]")
.Template("<TEMPLATE-ID>") // ID of Email template
.TemplateVariables(new Dictionary<string, object> // Optional template parameters
{
{ "company_info_name", "Test_Company_info_name" },
{ "company_info_address", "Test_Company_info_address" },
{ "company_info_city", "Test_Company_info_city" },
{ "company_info_zip_code", "Test_Company_info_zip_code" },
{ "company_info_country", "Test_Company_info_country" }
});
SendEmailResponse? response = await mailtrapClient
.Bulk()
.Send(request);
}
catch (Exception ex)
{
Console.WriteLine("An error occurred while sending email: {0}", ex);
}
```

[!INCLUDE [api-token-caution](../includes/api-token-caution.md)]
42 changes: 42 additions & 0 deletions docs/codesnippets/SandboxSendFromTemplate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
uid: snippets.sandbox-send-template-email
---

# Sandbox send
Short example of sending email via sandbox link.

```csharp
using Mailtrap;
using Mailtrap.Emails.Requests;
using Mailtrap.Emails.Responses;

try
{
var apiToken = "<API-TOKEN>";
var sandboxId = <SANDBOX-ID>; // ID of sandbox
using var mailtrapClientFactory = new MailtrapClientFactory(apiToken);
IMailtrapClient mailtrapClient = mailtrapClientFactory.CreateClient();
SendEmailRequest request = SendEmailRequest
.Create()
.From("[email protected]", "Mailtrap Test")
.To("[email protected]")
.Template("<TEMPLATE-ID>") // ID of Email template
.TemplateVariables(new Dictionary<string, object> // Optional template parameters
{
{ "company_info_name", "Test_Company_info_name" },
{ "company_info_address", "Test_Company_info_address" },
{ "company_info_city", "Test_Company_info_city" },
{ "company_info_zip_code", "Test_Company_info_zip_code" },
{ "company_info_country", "Test_Company_info_country" }
});
SendEmailResponse? response = await mailtrapClient
.Test(sandboxId)
.Send(request);
}
catch (Exception ex)
{
Console.WriteLine("An error occurred while sending email: {0}", ex);
}
```

[!INCLUDE [api-token-caution](../includes/api-token-caution.md)]
35 changes: 35 additions & 0 deletions docs/codesnippets/SimpleSend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
uid: snippets.simple-send-email
---

# Send an email
Short example of sending a simple email.

```csharp
using Mailtrap;
using Mailtrap.Emails.Requests;
using Mailtrap.Emails.Responses;

try
{
var apiToken = "<API-TOKEN>";
using var mailtrapClientFactory = new MailtrapClientFactory(apiToken);
IMailtrapClient mailtrapClient = mailtrapClientFactory.CreateClient();
SendEmailRequest request = SendEmailRequest
.Create()
.From("[email protected]", "Mailtrap Test")
.To("[email protected]")
.Subject("You are awesome!")
.Category("Integration Test")
.Text("Congrats for sending test email with Mailtrap!");
SendEmailResponse? response = await mailtrapClient
.Email()
.Send(request);
}
catch (Exception ex)
{
Console.WriteLine("An error occurred while sending email: {0}", ex);
}
```

[!INCLUDE [api-token-caution](../includes/api-token-caution.md)]
40 changes: 40 additions & 0 deletions docs/codesnippets/SimpleSendFromTemplate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
uid: snippets.simple-send-template-email
---

# Send an email from template
Short example of sending an email from a template.

```csharp
using Mailtrap;
using Mailtrap.Emails.Requests;
using Mailtrap.Emails.Responses;

try
{
var apiToken = "<API-TOKEN>";
using var mailtrapClientFactory = new MailtrapClientFactory(apiToken);
IMailtrapClient mailtrapClient = mailtrapClientFactory.CreateClient();
SendEmailRequest request = SendEmailRequest
.Create()
.From("[email protected]", "Mailtrap Test")
.To("[email protected]")
.Template("<TEMPLATE-ID>") // ID of Email template
.TemplateVariables(new Dictionary<string, object> // Optional template parameters
{
{ "company_info_name", "Test_Company_info_name" },
{ "company_info_address", "Test_Company_info_address" },
{ "company_info_city", "Test_Company_info_city" },
{ "company_info_zip_code", "Test_Company_info_zip_code" },
{ "company_info_country", "Test_Company_info_country" }
});
SendEmailResponse? response = await mailtrapClient
.Email()
.Send(request);
}
catch (Exception ex)
{
Console.WriteLine("An error occurred while sending email: {0}", ex);
}
```
[!INCLUDE [api-token-caution](../includes/api-token-caution.md)]
17 changes: 17 additions & 0 deletions docs/codesnippets/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
uid: snippets.index
title: Code Snippets
---
# Code Snippets

Here you can find short, practical examples of how to use the Mailtrap .NET client.

Each snippet demonstrates a specific use case, from basic email sending to advanced template usage.

## Available Snippets

- [Simple Send Email](xref:snippets.simple-send-email)
- [Send Email from Template](xref:snippets.simple-send-template-email)
- [Bulk Send Email](xref:snippets.bulk-send-email)
- [Bulk Send Template Email](xref:snippets.bulk-send-template-email)
- [Sandbox Template Example](xref:snippets.sandbox-send-template-email)
5 changes: 5 additions & 0 deletions docs/codesnippets/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- uid: snippets.simple-send-email
- uid: snippets.simple-send-template-email
- uid: snippets.bulk-send-email
- uid: snippets.bulk-send-template-email
- uid: snippets.sandbox-send-template-email
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ Repository with sample projects with different usage scenarios.
- [API Reference](xref:Mailtrap)
Detailed API reference.

- [Code Snippets](xref:snippets.index)
Code snippets for base send mail operations


<!-- ## Contributing
We believe in the power of OSS and welcome any contributions to the library.
Expand Down
9 changes: 9 additions & 0 deletions docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,14 @@
- name: Examples
href: https://github.com/mailtrap/mailtrap-dotnet/tree/main/examples

- name: CodeSnippets
href: codesnippets/
items:
- uid: snippets.simple-send-email
- uid: snippets.simple-send-template-email
- uid: snippets.bulk-send-email
- uid: snippets.bulk-send-template-email
- uid: snippets.sandbox-send-template-email

- name: GitHub
href: https://github.com/mailtrap/mailtrap-dotnet