.net bindings for Apostle.io
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitattributes
.gitignore
LICENSE
README.md

README.md

Apostle .Net

.Net bindings for Apostle.io

Installation

To install Json.NET, run the following command in the Package Manager Console

Install-Package Apostle

or you can search for Apostle in the Nuget Package Manager UI.

Configuration

Before you can send mail you have to configure your domain key with the Apostle api client. This is done by setting the DomainKey property of the Apostle class as shown here:

Apostle.DomainKey = "<your domain key>";

Sending Mail

To send mail you need a minimum of three things:

  1. Domain Key
  2. Template Name
  3. Recipient Email Address

Once you are ready to send mail you can simply do the following:

Apostle.DomainKey = "<your domain key>";
var mail = new Mail("<template name>", "<recipient email address>");
var deliveryResults = mail.Deliver();

Sending Mail With Data

If your mail template has replaceable tokens or if you want to override some of the default settings when sending mail you can do so by populating the optional properties of the Mail object as shown below.

var mail = new Mail("welcome", "recipient@email.com");

mail.Name = "John Smith";
mail.From = "jsmith@email.com";
mail.Headers.Add("Test Header", "Test Header Value");
mail.Headers.Add("Test Header 2", "Test Header 2 Value");
mail.Headers.Add("Test Header 3", "Test Header 3 Value");
mail.LayoutId = "standard";
mail.ReplyTo = "support@email.com";
mail.Data.Add("Example Data", "Example data values. This can be of any type");
mail.Data.Add("Example Array Data", new[] { 1, 2, 3, 4 });
mail.Data.Add("items", new[] { new { Name = "Widget", Price = 4.00, Quantity = 2 }, new { Name = "Widget 2", Price = 5.00, Quantity = 1 }, new { Name = "Widget 3", Price = 33.00, Quantity = 13 } });

var deliveryResult = mail.Deliver();

Sending Multiple Mails At Once

If you are sending multiple mails you can make the process more efficient by using the MailQueue. You can add as many Mail objects to the MailQueue as you'd like before delivering the mail. By using the MailQueue you will only make one request to Apostle.io instead of making one request per Mail.

var mailQueue = new MailQueue();

mailQueue.Add(new Mail("welcome", "recipient.1@email.com"));
mailQueue.Add(new Mail("welcome", "recipient.2@email.com"));
mailQueue.Add(new Mail("welcome", "recipient.3@email.com"));

var deliveryResult = mailQueue.Deliver();

Verifying Results

Both the Mail and MailQueue return a DeliveryResult when you call their Deliver() methods. The DeliveryResult will contain the following properties that will help you verify that the Mail was accepted by Apostle.io

  • Status - Enumeration that tells you the status of the call to the Apostle.io api (Queued or Error)
  • Message - If the Status property is Error then this property will tell you why the error occurred.
  • RequestData
  • JsonRequest - This property will show you the json that was sent from your application to the Apostle.io api. This is useful for logging and/or debugging.
  • ApiResponse - This property will show you the response that was received by your application from the Apostle.io api. This is useful for logging and/or debugging

Building This Solution

Before you run the tests in this solution you will need to provide your own Apostle Domain Key and the email address where you want to send the mail messages to. These are defined in the private.config file located in the Apostle.Tests directory. You will need to rename private.config.template to private.config and then set the necessary values.

The .gitignore is already setup to ignore the private.config file so you don't have to worry about your domain key and email address being stored in the git repo.

Feedback

If you find anything that needs attention please create an issue.

Who

Created by Wes Shaddix (@wshaddix)

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request