Getting Started with SparkPost in Java

Chris Wilson
Sep. 15, 2017 by Chris Wilson
Start sending email in minutes by using SparkPost's Java library. Click to Tweet
The SparkPost Java library is a popular way to integrate with SparkPost. If this describes your current task, this article will help you send email in a matter of a few minutes. If you’re a visual learner, check out this Getting Started video we have for the SparkPost Java Client Library.

I assume you have already created a SparkPost account and an API key.

Setting up a new project

As a Java developer I am sure you are more than familiar with how to add dependencies to your project. I will demonstrate doing so with Maven (mvn) in the code snippet below. If you are not using Maven, you’ll need to create the project and add the SparkPost library to it your normal way.

Let’s create the project.

Using the code above, we just created the following project structure:.

Now let’s build the base project:

Adding SparkPost Library Dependency

Now let’s edit the Maven Project Object Model (pom.xml) and add the SparkPost library dependency. You can find the code snippet with the latest version here. Add that to the dependencies element of the pom.xml file. Here is an example with the latest version as of the writing of this post:

Once the dependency is added, build the project again like this:

And with that, we’re ready to try it out!

Sending Your First Email

The easiest way to send an email is by using the SendMessage call. Here is an example:

To make this work for your own SparkPost account, you’ll want to make the following changes:

  1. In the above sample code, replace YOUR API KEY HERE with your SparkPost API key.
  2. Change  to an email address for your verified domain.
  3. Change to the address to which you want to send the email.
  4. Compile and run your code, and you will see the email arrive in the inbox.

More Advanced Examples

The sendMessage(...) function is helpful for getting up and running very quickly. However, you may need to do more advanced operations in the future. Here is an example to help you leverage the full power of the SparkPost API.

To make this work for your SparkPost account, you’ll want to make the same sort of changes as before:

  1. In that sample code, replace YOUR API KEY HERE with your SparkPost API key.
  2. Change to an email address for your verified domain.
  3. Change and to the addresses to which you want to send emails.
  4. Compile and run your code, and you will see the emails arrive in the inbox.

You can find many more examples of leveraging the SparkPost API here.


We’ve tried to make using SparkPost with Java as simple and enjoyable as writing any other Java code. If you run into any issues or have any questions, feel free to submit an issue on the Github repo or join us on our community Slack team in the #java channel. I’d love to hear from you.
—Chris Wilson




Related Content

RESTful API Versioning Best Practices: Why v1 is #1

Breaking changes can result in frustration and loss of trust between an API provider and their users. API versioning is one way to avoid that frustration.

read more

Advanced Email Templates

For the developer who wants to get the most out of SparkPost's email template capabilities, here's a guide to creating templates for more complex messages.

read more

Java-SparkPost Library Released!

At SparkPost we know many of our largest customers interface to the REST API from a Java backend. Today we are pleased to announce our Java client library. This will make developing for SparkPost a breeze ...

read more

Start sending email in minutes!

The world’s most powerful email delivery solution is now yours in a developer-friendly, quick to set up cloud service. Open a SparkPost account today and get started for free.

Get Started

Send this to a friend