mailslurp_netstandard_2x.Api.TemplateControllerApi
All URIs are relative to https://csharp.api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
CreateTemplate | POST /templates | Create a Template |
DeleteTemplate | DELETE /templates/{templateId} | Delete email template |
GetAllTemplates | GET /templates/paginated | List templates |
GetTemplate | GET /templates/{templateId} | Get template |
GetTemplatePreviewHtml | GET /templates/{templateId}/preview/html | Get template preview HTML |
GetTemplatePreviewJson | GET /templates/{templateId}/preview/json | Get template preview Json |
GetTemplates | GET /templates | List templates |
UpdateTemplate | PUT /templates/{templateId} | Update template |
TemplateDto CreateTemplate (CreateTemplateOptions createTemplateOptions)
Create a Template
Create an email template with variables for use with templated transactional emails.
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;
namespace Example
{
public class CreateTemplateExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new TemplateControllerApi(config);
var createTemplateOptions = new CreateTemplateOptions(); // CreateTemplateOptions |
try
{
// Create a Template
TemplateDto result = apiInstance.CreateTemplate(createTemplateOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateControllerApi.CreateTemplate: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
createTemplateOptions | CreateTemplateOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
void DeleteTemplate (Guid templateId)
Delete email template
Delete template
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;
namespace Example
{
public class DeleteTemplateExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new TemplateControllerApi(config);
var templateId = new Guid(); // Guid | Template ID
try
{
// Delete email template
apiInstance.DeleteTemplate(templateId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateControllerApi.DeleteTemplate: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
templateId | Guid | Template ID |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | No Content | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageTemplateProjection GetAllTemplates (int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null)
List templates
Get all templates in paginated format
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;
namespace Example
{
public class GetAllTemplatesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new TemplateControllerApi(config);
var page = 56; // int? | Optional page in list pagination (optional) (default to 0)
var size = 56; // int? | Optional page size in list pagination (optional) (default to 20)
var sort = sort_example; // string | Optional createdAt sort direction ASC or DESC (optional) (default to ASC)
var since = 2013-10-20T19:20:30+01:00; // DateTime? | Filter by created at after the given timestamp (optional)
var before = 2013-10-20T19:20:30+01:00; // DateTime? | Filter by created at before the given timestamp (optional)
try
{
// List templates
PageTemplateProjection result = apiInstance.GetAllTemplates(page, size, sort, since, before);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateControllerApi.GetAllTemplates: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | int? | Optional page in list pagination | [optional] [default to 0] |
size | int? | Optional page size in list pagination | [optional] [default to 20] |
sort | string | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] |
since | DateTime? | Filter by created at after the given timestamp | [optional] |
before | DateTime? | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
TemplateDto GetTemplate (Guid templateId)
Get template
Get email template
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;
namespace Example
{
public class GetTemplateExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new TemplateControllerApi(config);
var templateId = new Guid(); // Guid | Template ID
try
{
// Get template
TemplateDto result = apiInstance.GetTemplate(templateId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateControllerApi.GetTemplate: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
templateId | Guid | Template ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
string GetTemplatePreviewHtml (Guid templateId)
Get template preview HTML
Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;
namespace Example
{
public class GetTemplatePreviewHtmlExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new TemplateControllerApi(config);
var templateId = new Guid(); // Guid | Template ID
try
{
// Get template preview HTML
string result = apiInstance.GetTemplatePreviewHtml(templateId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateControllerApi.GetTemplatePreviewHtml: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
templateId | Guid | Template ID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/html;charset=utf-8, text/html
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
TemplatePreview GetTemplatePreviewJson (Guid templateId)
Get template preview Json
Get email template preview with passed template variables in JSON format. Pass template variables as query params.
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;
namespace Example
{
public class GetTemplatePreviewJsonExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new TemplateControllerApi(config);
var templateId = new Guid(); // Guid | Template ID
try
{
// Get template preview Json
TemplatePreview result = apiInstance.GetTemplatePreviewJson(templateId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateControllerApi.GetTemplatePreviewJson: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
templateId | Guid | Template ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
List
GetTemplates ()
List templates
Get all templates
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;
namespace Example
{
public class GetTemplatesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new TemplateControllerApi(config);
try
{
// List templates
List<TemplateProjection> result = apiInstance.GetTemplates();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateControllerApi.GetTemplates: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
TemplateDto UpdateTemplate (Guid templateId, CreateTemplateOptions createTemplateOptions)
Update template
Update email template
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;
namespace Example
{
public class UpdateTemplateExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new TemplateControllerApi(config);
var templateId = new Guid(); // Guid | Template ID
var createTemplateOptions = new CreateTemplateOptions(); // CreateTemplateOptions |
try
{
// Update template
TemplateDto result = apiInstance.UpdateTemplate(templateId, createTemplateOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateControllerApi.UpdateTemplate: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
templateId | Guid | Template ID | |
createTemplateOptions | CreateTemplateOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]