https://github.com/firesharkstudios/butterfly-message

Send emails and text messages via the same API in C#
https://github.com/firesharkstudios/butterfly-message

aws-ses butterfly email sms twilio

Last synced: about 2 months ago
JSON representation

Send emails and text messages via the same API in C#

• Host: GitHub
• URL: https://github.com/firesharkstudios/butterfly-message
• Owner: firesharkstudios
• License: mpl-2.0
• Created: 2019-10-15T21:00:22.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-04-21T23:21:40.000Z (over 5 years ago)
• Last Synced: 2024-04-30T03:01:43.504Z (over 1 year ago)
• Topics: aws-ses, butterfly, email, sms, twilio
• Language: C#
• Homepage:
• Size: 870 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Butterfly.Message ![Butterfly Logo](https://raw.githubusercontent.com/firesharkstudios/Butterfly/master/img/logo-40x40.png) 

> Send emails and text messages via the same API in C#

# Install from Nuget

| Name | Package | Install |

| --- | --- | --- |

| Butterfly.Message | [![nuget](https://img.shields.io/nuget/v/Butterfly.Message.svg)](https://www.nuget.org/packages/Butterfly.Message/) | `nuget install Butterfly.Message` |

| Butterfly.Message.Aws | [![nuget](https://img.shields.io/nuget/v/Butterfly.Message.Aws.svg)](https://www.nuget.org/packages/Butterfly.Message.Aws/) | `nuget install Butterfly.Message.Aws` |

| Butterfly.Message.Twilio | [![nuget](https://img.shields.io/nuget/v/Butterfly.Message.Twilio.svg)](https://www.nuget.org/packages/Butterfly.Message.Twilio/) | `nuget install Butterfly.Message.Twilio` |

# Install from Source Code

```git clone https://github.com/firesharkstudios/butterfly-message```

# Overview

Any files parsed with the ```.liquid``` extension will use the excellent [Scriban](https://github.com/lunet-io/scriban) template

engine which is based on the Liquid template language.

```cs

// Parse messages

var sendMessageFileParser = new SendMessageFileParser();

var welcomeEmailSendMessage = sendMessageFileParser.Parse("welcome-email.liquid");

var welcomeTextSendMessage = sendMessageFileParser.Parse("welcome-text.liquid");

// Setup notify manager

var sendMessageQueueManager = new SendMessageQueueManager(

    database,

    emailMessageSender: new AwsSesEmailMessageSender(options.AwsAccessKeyId, options.AwsSecretAccessKey),

    textMessageSender: new TwilioTextMessageSender(options.TwilioAccountSid, options.TwilioAuthToken)

);

sendMessageQueueManager.start();

// Send welcome email

var welcomeEmail = welcomeEmailSendMessage.Evaluate(new Dict {

    ["first_name"] = "Kent",

    ["to"] = "kent@fireshark.com",

});

sendMessageQueueManager.Queue(welcomeEmail);

// Send welcome text

var welcomeText = welcomeTextSendMessage.Evaluate(new Dict {

    ["first_name"] = "Kent",

    ["to"] = "+13165551212",

});

sendMessageQueueManager.Queue(welcomeText);

```

Example of the ```welcome-email.liquid``` file...

```

From: Kent Johnson 

To: {{ first_name }} <{{ to }}>

Subject: Welcome

Hello, {{ user.first_name }}.  To get started, do these things. 

```

Example of the ```welcome-text.liquid``` file...

```

From: +13165551212

To: {{ to }}

Hello, {{ user.first_name }}.  To get started, do these things. 

```

While any database engine supported by [Butterfly.Db](https://github.com/firesharkstudios/butterfly-db) can be used, here is the MySQL syntax for creating the required tables...

```

CREATE TABLE send_message (

  id varchar(50) NOT NULL,

  message_type tinyint(4) NOT NULL,

  message_priority tinyint(4) NOT NULL,

  message_from varchar(255) NOT NULL,

  message_to varchar(1024) NOT NULL,

  message_subject varchar(255) DEFAULT NULL,

  message_body_text mediumtext,

  message_body_html mediumtext,

  extra_json varchar(255) DEFAULT NULL,

  sent_at int(11) DEFAULT NULL,

  send_error varchar(255) DEFAULT NULL,

  sent_message_id varchar(255) DEFAULT NULL,

  created_at int(11) NOT NULL,

  PRIMARY KEY (id),

  UNIQUE KEY sent_message_id (sent_message_id),

  KEY other (message_type,sent_at,message_priority,created_at)

);

CREATE TABLE send_verify (

  id VARCHAR(50) NOT NULL,

  contact VARCHAR(255) NOT NULL,

  verify_code INT NOT NULL,

  expires_at INT NOT NULL,

  created_at INT NOT NULL,

  updated_at INT NOT NULL,

  PRIMARY KEY (id),

  UNIQUE KEY contact (contact)

);

```

# Contributing

If you'd like to contribute, please fork the repository and use a feature

branch. Pull requests are warmly welcome.

# Licensing

The code is licensed under the [Mozilla Public License 2.0](http://mozilla.org/MPL/2.0/).