This repository contains the source code for the Java library for sending email via the sendwithus API.
To use the library in your own project, please follow the installation and usage instructions below - you do not need to build the library yourself.
Installation
via maven (preferred)
Add the following to your pom.xml:
<!-- in the repositories section -->
<repository>
<id>repo</id>
<url>https://github.com/sendwithus/sendwithus-mvn-repo/raw/master/releases</url>
</repository>
<!-- in the dependencies section -->
<dependency>
<groupId>com.sendwithus</groupId>
<artifactId>java-client</artifactId>
<version>1.0.2</version>
</dependency>
via wget:
$ wget https://github.com/sendwithus/sendwithus-mvn-repo/raw/master/releases/com/sendwithus/java-client/1.0.1/java-client-1.0.1.jar
External Dependencies (if not using maven)
Usage
General
See SendWithUsExample.java for full usage.
import java.util.HashMap;
import java.util.Map;
import com.sendwithus.SendWithUs;
final String SENDWITHUS_API_KEY = "API-KEY-HERE";
final String EMAIL_ID_WELCOME_EMAIL = "EMAIL-ID-HERE";
SendWithUs sendwithusAPI = new SendWithUs(SENDWITHUS_API_KEY);
// Send Welcome Email
Map<String, Object> recipientMap = new HashMap<String, Object>();
recipientMap.put("name", "Matt"); // optional
recipientMap.put("address", "us@sendwithus.com");
// sender is optional
Map<String, Object> senderMap = new HashMap<String, Object>();
senderMap.put("name", "Company"); // optional
senderMap.put("address", "company@company.com");
senderMap.put("reply_to", "info@company.com"); // optional
Map<String, Object> emailDataMap = new HashMap<String, Object>();
emailDataMap.put("first_name", "Brad");
emailDataMap.put("link", "http://sendwithus.com/some_link");
SendReceipt sendReceipt = sendwithusAPI.send(
EMAIL_ID_WELCOME_EMAIL,
recipientMap,
senderMap,
emailDataMap
);
Errors
The following errors may be generated:
com.sendwithus.exception.SendWithUsException - Raised by send exceptions