MailHub.Client
2.6.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package MailHub.Client --version 2.6.0
NuGet\Install-Package MailHub.Client -Version 2.6.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="MailHub.Client" Version="2.6.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MailHub.Client" Version="2.6.0" />
<PackageReference Include="MailHub.Client" />
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 MailHub.Client --version 2.6.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MailHub.Client, 2.6.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.
#:package MailHub.Client@2.6.0
#: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=MailHub.Client&version=2.6.0
#tool nuget:?package=MailHub.Client&version=2.6.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MailHub.Client
.NET client library for the MailHub email delivery service by BPM BI INC.
Installation
dotnet add package MailHub.Client
Configuration
Add your MailHub credentials to appsettings.json:
{
"MailHubClientSetting": {
"ApplicationId": 0,
"ApplicationKey": "your-application-key",
"SecretKey": "your-secret-key"
}
}
Register the settings in Program.cs (or Startup.cs):
services.Configure<MailHubClientSetting>(configuration.GetSection("MailHubClientSetting"));
Initialization
Initialize MailHub once at startup, passing your settings and a Serilog logger:
await MailHub.Initialize(mailHubClientSetting, logger);
Sending Email
var envelope = new EmailApiEnvelope
{
EmailFrom = "sender@example.com",
EmailTo = "recipient@example.com",
EmailSubject = "Hello",
EmailBody = "<p>Hello from MailHub!</p>"
};
int emailQueueId = await MailHub.SendEmail(envelope);
Returns the EmailQueueId on success, or 0 on failure.
Other Methods
| Method | Description |
|---|---|
GetByEmailQueueId(int id) |
Retrieve a queued email record by ID |
GetAllByApplicationId() |
List all email records for your application |
GetFilteredEmailListByApplicationId() |
Retrieve a paged/filtered email list |
UpdateEmailQueue(EmailQRecord record) |
Update an existing queue record |
HelloWorld() |
Connectivity test |
License
MIT — see LICENSE for details.
| Product | Versions 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.
-
net10.0
- Microsoft.Extensions.Options (>= 10.0.8)
- Newtonsoft.Json (>= 13.0.4)
- Serilog (>= 4.3.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.