Official Java library ☕ for Pepipost
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 version of this library provides is fully compatible with the latest Pepipost v5.0 API.
For any update of this library check Releases.
- Installation
- Quick Start
- Usage of library in Project
- Sample Example
- Announcements
- Roadmap
- About
- License
- Java version Oracle JDK 7, 8 or OpenJDK 7
- Java Maven Dependencies
- Jackson
- UniRest
- Apache HttpClient
- Java Development Enviromment (IDE).
- A free account on Pepipost. If you don't have a one, click here to signup and get 30,000 emails free every month.
This Java library uses few Maven Dependencies (mentioned above). The reference to these dependencies are added in pom.xml file which will be installed automatically. Just need internet access for successful build.
-
Download zip or get a clone for the pepipost repository using
git clone https://github.com/pepipost/pepipost-sdk-java.git -
In order to open the client library in Eclipse click on
File -> Import. -
In the import dialog, select
Existing Java Projectand clickNext. -
Browse to locate the folder containing the source code. Select the detected location of the project and click
Finish. -
Upon successful import, the project will be automatically built by Eclipse after automatically resolving the dependencies.
-
Starting a new project
-
Click the menu command
File > New > Project. -
Choose
Maven > Maven Project. -
Click
Next. -
Here, make sure to use the current workspace by choosing
Use default Workspace location, as shown in the screenshot below. -
Click
Next. -
Select the quick start project type to create a simple project with an existing class.
-
A
mainmethod. -
To do this, choose
maven-archetype-quickstartitem from the list. -
Click
Next. -
In the last step, provide a
Group Id.andArtifact Idas shown in the picture below. -
Click
Finish.
-
-
Add reference of the library project
-
The created Maven project manages its dependencies using its
pom.xmlfile. -
In order to add a dependency on the PepipostLib client library, double click on the
pom.xmlfile in thePackage Explorer. -
Opening the
pom.xmlfile will render a graphical view on the canvas. -
Here, switch to the
Dependenciestab. -
Click the
Addbutton as shown in the picture below. -
Click the
Addbutton. A dialog will open, where you need to specify Pepipost inGroup Idand PepipostLib in theArtifact Idfields. -
Once added click
OK. -
Save the
pom.xmlfile.
-
-
Getting started with code
-
Once the
SimpleConsoleAppis created, a file namedApp.javawill be visible in the Package Explorer with amainmethod. -
This is the entry point for the execution of the created project.
-
package TestApp.SimpleConsoleApp;
import java.util.*;
import java.io.*;
import com.pepipost.api.*;
import com.pepipost.api.models.*;
import com.pepipost.api.controllers.*;
import com.pepipost.api.http.client.*;
import com.fasterxml.jackson.core.JsonProcessingException;
public class App {
public static void main(String[] args) throws JsonProcessingException {
PepipostClient client = new PepipostClient();
MailSendController mailSendController = client.getMailSend();
Configuration.apiKey = "your api_key here";
Send body = new Send();
body.setFrom(new From());
body.getFrom().setEmail("hello@your-register-domain-with-pepipost");
body.getFrom().setName("Example Pepi");
body.setSubject("Emailing with Pepipost is easy");
body.setContent(new LinkedList<Content>());
Content body_content_0 = new Content();
body_content_0.setType(TypeEnum.HTML);
body_content_0.setValue("<html><body>Hey,<br><br>Do you know integration is even simpler in Pepipost, <br>with Java <br> Happy Mailing ! <br><br>Pepipost </body></html>");
body.getContent().add(body_content_0);
body.setPersonalizations(new LinkedList<Personalizations>());
Personalizations body_personalizations_0 = new Personalizations();
body_personalizations_0.setTo(new LinkedList<EmailStruct>());
EmailStruct body_personalizations_0_to_0 = new EmailStruct();
body_personalizations_0_to_0.setName("random-1");
body_personalizations_0_to_0.setEmail("[email protected]");
body_personalizations_0.getTo().add(body_personalizations_0_to_0);
body.getPersonalizations().add(body_personalizations_0);
mailSendController.createGeneratethemailsendrequestAsync(body, new APICallBack<Object>() {
public void onSuccess(HttpContext context, Object response) {
System.out.println(response.toString());
System.out.println(context.getResponse().getStatusCode());
}
public void onFailure(HttpContext context, Throwable error) {
System.out.println(error.getMessage());
System.out.println(context.getResponse().getStatusCode());
}
});
}
}- Change your api-key and sending domain respectively
- apikey will be available under Login to Pepipost -> Settings -> Integration
- Sending Domain will be available under Login to Pepiost -> Settings -> Sending Domains
*Note :: Domains showing with Active status on Sending Domain dashboard are only allowed to send any sort of emails.* In case there are no Sending Domain added under your account, then first add the domain, get the DNS (SPF/DKIM) settings done and get it reviewed by our compliance team for approval. Once the domain is approved, it will be in ACTIVE status and will be ready to send any sort of emails.
- Run your project
v5.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]
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.
pepipost-sdk-java library is guided and supported by the Pepipost Developer Experience Team . This pepipost library is maintained and funded by Pepipost Ltd. The names and logos for pepipost gem are trademarks of Pepipost Ltd.
This code library was semi-automatically generated by APIMATIC v2.0 and licensed under The MIT License (MIT).
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent