Pepipost 5.0.0
See the version list below for details.
dotnet add package Pepipost --version 5.0.0
NuGet\Install-Package Pepipost -Version 5.0.0
<PackageReference Include="Pepipost" Version="5.0.0" />
paket add Pepipost --version 5.0.0
#r "nuget: Pepipost, 5.0.0"
// Install Pepipost as a Cake Addin
#addin nuget:?package=Pepipost&version=5.0.0
// Install Pepipost as a Cake Tool
#tool nuget:?package=Pepipost&version=5.0.0
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 2.5.0 version of this library provides is fully compatible with the latest Pepipost v2.0 API.
For any update of this library check Releases.
Table of Content
<a name="installation"></a>
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.
Installation using Mono-Develop
Installation using Microsoft Visual Studio
<a name="quick-start"></a>
Quick Start
How to Build- Using Nuget Package Manager on MS Visual Studio
Start Microsoft Visual Studio 2017
File → New → Project
Give desired name to your project:
TestConsoleProject recommended
Installing dependencies through Nuget Package installer:
Browse and Search for Pepipost - The Official C# library
Install the selected package:
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
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. info@mydomain.com, 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)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
<a name="announcements"></a>
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 dx@pepipost.com
<a name="roadmap"></a>
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.
<a name="about"></a>
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.
<a name="license"></a>
License
This code library was semi-automatically generated by APIMATIC v2.0 and licensed under The MIT License (MIT).
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET Framework | net is compatible. |
-
- NETStandard.Library (>= 1.6.1)
- Newtonsoft.Json (>= 11.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
## Highlights for V5
- Users can now schedule emails for up to 72 hours.
- Users can mark multiple recipients in To, Cc and Bcc.
- Recipient names are now supported across all the email address fields.
- Adding(or Removing) email addresses and domains to the suppression list is easier.
## SendEmail Support
- Structural changes are implemented in the Send Email API to allow JSON objects.
- Support for addition of multiple email address in To field.
- Support for recipient name included in To, Cc and Bcc.
- Support for sending a personalized attachment in a single API call.
- Content-type to distinguish and support multi-content with "AMP" and "HTML" content.
- Schedule email feature
- Now, X-APIHEADER will be known as token_to.
- Now X-APIHEADER_CC will be known as token_cc.
- Error response structure is modified for Send Email API.
with Sendmail API we have introduced support for other endpoints in SDK.
## Domain API
- Domain ID is provided in response message in 'Add a domain' API.
- New APIs added [Get the list of domains, Delete Domain]
## Suppression API
- Single API to suppress email address (and/or domain).
- Single API to remove email address (and/or domain) from the Suppression list.
- Multiple email addresses (or domains) can be suppressed or removed simultaneously.
## Subaccount API
- Credit type can be assigned at the time of the creation of subaccount.
- New API added - Retrieve a list of subaccounts.
- Update Subaccount API replaces the 'Change email address' API, 'Change credit type' API and 'Change password' API
## Events API
- Introduction of pagination using scroll ID.
- Introduction of aggregate status to fetch logs for multiple events simultaneously.