EmpireReportSenderSettings 1.0.1
dotnet add package EmpireReportSenderSettings --version 1.0.1
NuGet\Install-Package EmpireReportSenderSettings -Version 1.0.1
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="EmpireReportSenderSettings" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EmpireReportSenderSettings --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: EmpireReportSenderSettings, 1.0.1"
#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.
// Install EmpireReportSenderSettings as a Cake Addin #addin nuget:?package=EmpireReportSenderSettings&version=1.0.1 // Install EmpireReportSenderSettings as a Cake Tool #tool nuget:?package=EmpireReportSenderSettings&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Settings for Empire Report Sending
This is a C# library class to store common settings for Empire report projects - database connections, SQL query, recipients, etc.
Expected usage
Create a settings blob as an environment variable
SettingsBlob:
{
"SqlQuery": "SELECT * FROM ReportData",
"ReportTemplateFileName": "reports/ReportTemplateFileName.rpt"
}
Consume data
using EmpireReportSenderSettings;
IEmpireReportSenderSettingsBase settings = new EmailReportSettings();
List<MailAddress> recipients = settings.EmailRecipients;
string connectionString = settings.GetConnectionString();
Expected values
The following values are expected in the settings blob.
Report Base Settings
Base class intending to be inherited to various report types based on their presentation.
- SqlQuery: The SQL query to run to get the data for the report
- ReportTemplateFileName: The name of the report template file
- ReportDataFile: The name of the report data file
- DatabaseConnectionString: The connection string to the database
- DatabaseUsername: The username to connect to the database
- DatabasePassword: The password to connect to the database
- LogWebhookUri: The URI to send logs to
Email Report Settings
For reports that are to be sent via email.
- OutputFileName: The name of the output file
- OutputFilePat: The path to the output file
- EmailList: A comma separated list of email addresses to send the report to (e.g. "nb@empireindustries.com,jaris@empireindustries.com" or "nb@empireindustries.com")
- EmailApiKey: The API key for sending emails
- ReportEmailSenderName: The name of the sender of the email
- ReportEmailSenderAddress: The email address of the sender of the email
- ReportEmailSubject: The subject of the email
- ReportEmailPlainTextBody: The plain text body of the email
- ReportEmailHtmlBody: The HTML body of the email
| Product | Versions 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Microsoft.Data.SqlClient (>= 5.2.1)
- MimeMapping (>= 3.0.1)
- Newtonsoft.Json (>= 13.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.