fMail 0.1.0

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher. 
dotnet add package fMail --version 0.1.0
                    


                    

                
NuGet\Install-Package fMail -Version 0.1.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="fMail" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="fMail" Version="0.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="fMail" />
                    


                            Project file
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 fMail --version 0.1.0
                    


                    

                
#r "nuget: fMail, 0.1.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 fMail@0.1.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=fMail&version=0.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=fMail&version=0.1.0
                    


                            Install as a Cake Tool

fMail

Easy to use self-hosted mail api.

Installation/Startup

(Docker images in future)

At first startup, when no config.json is presented it will generate new config with random generated password!

Default username: admin

Usage

// Setup first (Only once)
await FMailConnector.SetupConnection("url-to-api", "username", "password");


// Then you can send emails like that:
var fMailObject = new FMailConnector.fMailObject()
{
    Content = "<h1>test</h1>",
    DisplayName = "Test",
    Emails = new []
    {
        "example@example.com"
    },
    Subject = "Test Mail",
    IsBodyHtml = true
};

// Set your id same as id in your config.json
await FMailConnector.SendMessage("smtpID", fMailObject);

API Reference

It's gonna be changed!

Sets new config
  POST /api/config
Json Field Name Type Description
CurrentUsername string Required. Your admin username
CurrentPassword string Required. Your admin password
Config config Required. New config
Auth
  POST /api/auth
Json Field Name Type Description
Username string Required. Your admin username
Password string Required. Your admin password
Send mail(s)
  POST /api/send
Json Field Name Type Description
CurrentUsername string Required. Your admin username
CurrentPassword string Required. Your admin password
SmtpId string Required. Id of smtp server you would like to use
Emails string[] Required. List of emails to send email
IsBodyHtml bool Required. Indicates if body is written in HTML
Subject string Required. Subject of email
Content string Required. Content of email
DisplayName string Required. Display name
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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.

  • net7.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.0 372 11/24/2022