The Official Pepipost C#, .NetStandard, .NetCore API Library
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Pepipost
CONTRIBUTING.md
LICENSE
Mono-installation-SDK.md
Mono-installation-nuget.md
Pepipost.sln
README.md
simpleUsage.md
visual-studio-installation.md

README.md

pepipostlogo

NuGet Open Source Helpers MIT licensed Twitter Follow

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

Installation

Prerequisites

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

  2. Installation using Microsoft Visual Studio

Quick Start

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

  1. Start Microsoft Visual Studio 2017

    File -> New -> Project

    s1

  2. Give desired name to your project:

    TestConsoleProject recommended

    s2

  3. Installing dependencies through Nuget Package installer:

    s3

    Browse and Search for Pepipost - The Official C# library

    s4

  4. Install the selected package:

    s5

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

    s6

    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. 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)

  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

    s7

Announcements

v2.5.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

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).