NEW: Subscribe to email notifications for releases and breaking changes.
This library allows you to quickly and easily use the SendGrid Web API v3 via Java.
Version 3.X.X of this library provides full support for all SendGrid Web API v3 endpoints, including the new v3 /mail/send.
This library represents the beginning of a new path for SendGrid. We want this library to be community driven and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create issues and pull requests or simply upvote or comment on existing issues or pull requests.
Please browse the rest of this README for further details.
We appreciate your continued support, thank you!
- Installation
- Quick Start
- Usage
- Use Cases
- Announcements
- Roadmap
- How to Contribute
- Troubleshooting
- About
- License
- Java version Oracle JDK 7, 8 or OpenJDK 7
- The SendGrid service, starting at the free level
Update the development environment with your SENDGRID_API_KEY, for example:
- Copy the sample environment file to a new file
cp .env_sample .env- Edit the new
.envto add your API key - Source the
.envfile to set rhe variable in the current session
source .envChoose your installation method - Maven w/ Gradle (recommended), Maven or Jar file.
Add the following to your build.gradle file in the root of your project.
...
dependencies {
...
compile 'com.sendgrid:sendgrid-java:4.1.2'
}
repositories {
mavenCentral()
}
...mvn install
You can just drop the jar file in. It's a fat jar - it has all the dependencies built in.
The following is the minimum needed code to send an email with the /mail/send Helper (here is a full example):
importcom.sendgrid.*;
importjava.io.IOException;
publicclassExample {
publicstaticvoidmain(String[] args) throwsIOException {
Emailfrom = newEmail("test@example.com");
Stringsubject = "Sending with SendGrid is Fun";
Emailto = newEmail("test@example.com");
Contentcontent = newContent("text/plain", "and easy to do anywhere, even with Java");
Mailmail = newMail(from, subject, to, content);
SendGridsg = newSendGrid(System.getenv("SENDGRID_API_KEY"));
Requestrequest = newRequest();
try {
request.setMethod(Method.POST);
request.setEndpoint("mail/send");
request.setBody(mail.build());
Responseresponse = sg.api(request);
System.out.println(response.getStatusCode());
System.out.println(response.getBody());
System.out.println(response.getHeaders());
} catch (IOExceptionex) {
throwex;
}
}
}The Mail constructor creates a personalization object for you. Here is an example of how to add to it.
The following is the minimum needed code to send an email without the /mail/send Helper (here is a full example):
importcom.sendgrid.*;
importjava.io.IOException;
publicclassExample {
publicstaticvoidmain(String[] args) throwsIOException {
try {
SendGridsg = newSendGrid(System.getenv("SENDGRID_API_KEY"));
Requestrequest = newRequest();
request.setMethod(Method.POST);
request.setEndpoint("mail/send");
request.setBody("{\"personalizations\":[{\"to\":[{\"email\":\"test@example.com\"}],\"subject\":\"Sending with SendGrid is Fun\"}],\"from\":{\"email\":\"test@example.com\"},\"content\":[{\"type\":\"text/plain\",\"value\": \"and easy to do anywhere, even with Java\"}]}");
Responseresponse = sg.api(request);
System.out.println(response.getStatusCode());
System.out.println(response.getBody());
System.out.println(response.getHeaders());
} catch (IOExceptionex) {
throwex;
}
}
}importcom.sendgrid.*;
importjava.io.IOException;
publicclassExample {
publicstaticvoidmain(String[] args) throwsIOException {
SendGridsg = newSendGrid(System.getenv("SENDGRID_API_KEY"));
try {
Requestrequest = newRequest();
request.setMethod(Method.GET);
request.setEndpoint("api_keys");
Responseresponse = sg.api(request);
System.out.println(response.getStatusCode());
System.out.println(response.getBody());
System.out.println(response.getHeaders());
} catch (IOExceptionex) {
throwex;
}
}
}- SendGrid Docs
- Library Usage Docs
- Example Code
- How-to: Migration from v2 to v3
- v3 Web API Mail Send Helper - build a request object payload for a v3 /mail/send API call.
Examples of common API use cases, such as how to send an email with a transactional template.
Please see our announcement regarding breaking changes. Your support is appreciated!
All updates to this library are documented in our CHANGELOG and releases. You may also subscribe to email release notifications for releases and breaking changes.
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.
We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.
Quick links:
Please see our troubleshooting guide for common library issues.
sendgrid-java is guided and supported by the SendGrid Developer Experience Team.
sendgrid-java is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-java are trademarks of SendGrid, Inc.