pepipost / pepipost-sdk-csharp

The Official Pepipost C#, .NetStandard, .NetCore API Library

Official C# Code library for Pepipost

Overview

This library contains methods for easily interacting with the Pepipost Email Sending API to send emails within few seconds.

We are trying to make our libraries Community Driven- which means we need your help in building the right things in proper order we would request you to help us by sharing comments, creating new issues or pull requests.

We welcome any sort of contribution to this library.

The latest 5.0.0 version of this library provides is fully compatible with the latest Pepipost v5.0 API.

For any update of this library check Releases.

Table of Content

• Installation
• Quick Start
• Usage
• Announcements
• Roadmap
• About
• License

Installation

Prerequisites

• Microsoft visual Studio 2017
• NETStandard.Library(>= 1.6.1)
• Pepipost
• A free account on Pepipost. If you don't have a one, click here to sign-up and get 30,000 emails free every month.

IDE Specific installation

In order to use Pepipost C# library you can either directly download Pepipost C# .NET library from our GIT Repo or if you have Nuget Package manager installed, you can search and download Pepipost from the package manager.

Pepipost C# .NET library is compatible with Windows Forms, Windows RT, Windows Phone 8, Silverlight 5, Xamarin iOS, Xamarin Android and Mono.

We have demonstrated the installation with two IDEs which consists of Mono-Develop and Visual Studio 2017. We welcome contribution for other IDEs.

1. Installation using Mono-Develop

   • Using Nuget package manager.

   • Using Github Repository

2. Installation using Microsoft Visual Studio

   • Using Nuget Package manager

   • Using GitHub Reposistory

Quick Start

How to Build- Using Nuget Package Manager on MS Visual Studio

1. Start Microsoft Visual Studio 2017

   File -> New -> Project

   

2. Give desired name to your project:

   TestConsoleProject recommended

   

3. Installing dependencies through Nuget Package installer:

   

   Browse and Search for Pepipost - The Official C# library

   

4. Install the selected package:

   

5. Once all packages are install the solution explorer will look like below:

   

   Just copy and paste the simpleUsage.md in your program.cs file present in your project.

   build the project shown below OR by clicking ctrl + shift + F5

6. Update the api_key and FromEmail parameters

   • apikey: This will be available under: Login to your Pepipost account -> Settings -> Integration
   • FromEmail: If your fromemail address is e.g. [email protected], then the Sending Domain mydomain need to be verified and active under your Pepipost account. You can manage the Sending Domain under: Login to Pepipost -> Settings -> Sending Domains

   string apiKey = "XXXXX-your-api-key-XXXX" (near by line no 25 if you have copied the simpleUsage.md)

   body_personalizations_0.Recipient = "your recipient emailid here" (near by line no 31)

   body.From.FromEmail = "info@ your-verified-domain" (near by line no 37)

7. Build the project to finally send your first test email Run the project.

   If your apikey and sending domain is proper response message will be success

   

Announcements

v5.0.0 has been released! Please see the release notes for details.

All updates to this library are documented in our releases. For any queries, feel free to reach out us at [email protected]

Roadmap

If you are interested in the future direction of this project, please take a look at our open issues and pull requests. We would love to hear your feedback.

About

pepipost-csharp-sdk library is guided and supported by the Pepipost Developer Experience Team. This pepipost-csharp-sdk library is maintained and funded by Pepipost Ltd. The names and logos for pepipost-csharp-sdk are trademarks of Pepipost Ltd.

License

This code library was semi-automatically generated by APIMATIC v2.0 and licensed under The MIT License (MIT).

pepipost-sdk-csharp's Issues

Create a tutorial to deploy a simple Email Sending App on Heroku with C# using this SDK

Create a tutorial that explains how to create a simple Email sending app and deploy to Heroku.

Using this tutorial one should be able to send an email using their deployed app.

Please add the tutorial to USE_CASES.md.

Add _baseUri to _queryBuilder when url is null or empty in MailSendController

pepipost-sdk-csharp/Pepipost/Controllers/MailSendController.cs

Line 79 in 19425ab

_queryBuilder.Append("/mail/send");

           if (string.IsNullOrWhiteSpace(url))
           {
               _queryBuilder.Append(_baseUri +"/mail/send");

Create a Nudget package for Pepipost C# SDK

Nuget is the best way to distribute SDKs. It eases the pain of developers to download and compile the solution. Do you plan on releasing a nuget package?

Warning: Package 'Pepipost 5.0.4' was restored using '.NETFramework,Version=v4.6.1, .NETFramework,Version=v4.6.2, .NETFramework,Version=v4.7, .NETFramework,Version=v4.7.1, .NETFramework,Version=v4.7.2, .NETFramework,Version=v4.8' instead of the project target framework 'net5.0'. This package may not be fully compatible with your project.

I have a project targeting net5.0 and I get the following warning "Package 'Pepipost 5.0.4' was restored using '.NETFramework,Version=v4.6.1, .NETFramework,Version=v4.6.2, .NETFramework,Version=v4.7, .NETFramework,Version=v4.7.1, .NETFramework,Version=v4.7.2, .NETFramework,Version=v4.8' instead of the project target framework 'net5.0'. This package may not be fully compatible with your project."

Steps to Reproduce

1. Create a new ASP.NET Core Project with Linux support, add Pepipost nuget version 5.0.4.
2. I get the following error
   

Technical details:

• Target Framework net5.0

• <Pepipost> Version: 5.0.4 * C#: 9.0, NET Core 5.0.7.

Use of Email Templates with SDK