README.md

eazy-sms

This library aims to provide easy way in sending sms using mnotify sms gateway , etc.. in your .netcore >= 3.1 applications.

SMS Providers

• Mnotify

• Dashboard - Resend failed SMS Message.

• SMS Dashboard

• SMS Dashboard 2

• SMS DB Connection Error

• SMS Info Details

SMS Channel

• SMS

eazy-sms repository is work in progress...

Get Started

(Not Yet) Installation

- Install-Package eazy-sms

Getting Started

AddEazySms(Configuration) & UseEazySmsUI(Configuration) which accepts IConfiguration object must be injected in ConfigureServices and Configure method in the Startup class.

ConfigureServices

 //ConfigureServices Method.
 public void ConfigureServices(IServiceCollection services)
 {
     services.AddEazySms(Configuration);
 }

 // Configure Method.
 public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 {
     app.UseEazySmsUI(Configuration);;
 }

Once you have configured the AddEazySms() and UseEazySms middleware in the Program.cs file, you're ready to define the EazyOptions in the app.settings.json.

appsettings

   "EazyOptions": {
    "SMS": {
      "Enable": true,
      "Database": {
        "Persist": true,
        "Name": "CacheSMS",
        "Instance": "DESKTOP-6BR1LOC",
        "UserName": "sa",
        "Password": "root",
        "Encrypt": "False",
        "TrustedConnection": "False",
        "TrustServerCertificate": "True"
      },
      "ApiKey": "4n4uhOxPhvTeesTlC3ef7jLCGX5mLEIU1MpiAW8Ss16GtZ",
      "ApiSecret": "",
      "From": "Melteck"
    }
  }

• Options

1. Enable -- Enable SMS option. which takes either a true or fale.
2. Database -- Enabled by default. SMS are been stored in a database table before they are sent to the recepient.
3. ApiKey -- unique api key.
4. ApiSecret -- unique api secret. Not required by other providers.
5. From -- Name of the server. visit provider for senderId or Name.

Example

Every notification class has a Boot method for building the notification message and each notification is represented by a single class and stored in the Notifications directory.

public class AccountCreatedNotifiable : Notifiable<AccountDto>
{
        
    protected override void Boot()
    {
        //logic...
        From("Melteck")
            .Subject("Account Created")
            .Recipient(new[]
                {
                    "0276002658",
                    "0553771219"
                }
            )
            //.Content(new Content("message body}"))
            .Schedule(false, "2021-04-08 06:00")
            .Attach(new Attachment {File = "ringtone.mp3"})
            .Template("AccountRegistration.txt", "pass dto to a template")
            .Channel(SMSChannel.Mnotify);
    }
}

• Available Methods that can be used in the boot method of every notification class.

1. From - sender name or sender Id
2. Subject - message title
3. Recipient - an array of number to recieve the sms message
4. Schedule - accept the state & a date [YYY-MM-DD h:mm] for scheduling sms.
5. Content - body of the message
6. Attach - voice file (path: wwwroot/Template/Voice).
7. Template - template name (path : wwwroot/Template)
8. Channel - specifying delivery channels

Using The Notifiable

The NotifyAsync method that is provided by INotification interface expects to receive a notification instance. In other to use the NotifyAsync method you need to inject the INotification interface in your contructor.

public class RegistrationController : ControllerBase
{
    private readonly INotification _notification;

    public RegistrationController(INotification notification)
    {
        _notification = notification;
    }

    [HttpGet("Register")]
    public async Task<IActionResult> Register()
    {
        //Create new user
        var accountUser = new AccountDto {Username = "Michael Ameyaw"};

        //removed for brevity....

        //call this after creating user to send email
        await _notification.NotifyAsync(new AccountCreatedNotifiable(accountUser));

        return Ok("Message has been processed");
    }
}

Note that NotifyAsync does not return an response