Skip to content
The Official Twilio SendGrid Led, Community Driven Java API Library
Branch: master
Clone or download
thinkingserious Merge pull request #557 from wkurniawan07/jackson-version
Update Jackson dependencies to the latest version
Latest commit d8267bf May 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Twilio branding updates & CLA update May 17, 2019
bin/com/sendgrid/helpers Update Jackson to 2.9.9 May 23, 2019
docker Version Bump v4.4.0: Twilio Branding Update + other updates May 20, 2019
examples Twilio branding updates & CLA update May 17, 2019
gradle/wrapper Add gradlew and instructions to use it instead of gradle May 27, 2014
proposals Twilio branding updates & CLA update May 17, 2019
scripts Fixes prism startup script. Attempts to fix travis build. Oct 11, 2017
src Update Jackson to 2.9.9 May 23, 2019
test Makes prism script executable. Oct 10, 2017
.codeclimate.yml Add .codeclimate.yml file Oct 31, 2017
.env_sample Add .env_sample file Oct 27, 2017
.gitignore Version Bump v4.2.0: Hacktoberfest rollup release May 4, 2018
.travis.yml update travis.yml to change openjdk7 to openjdk8 Oct 29, 2017
CHANGELOG.md Version Bump v4.4.1: Package not uploaded correctly May 20, 2019
CODE_OF_CONDUCT.md Twilio branding updates & CLA update May 17, 2019
CONTRIBUTING.md Version Bump v4.4.1: Package not uploaded correctly May 20, 2019
LICENSE.md Fix license test May 17, 2019
README.md Version Bump v4.4.1: Package not uploaded correctly May 20, 2019
TROUBLESHOOTING.md Twilio branding updates & CLA update May 17, 2019
USAGE.md Too many Twilios May 17, 2019
USE_CASES.md Twilio branding updates & CLA update May 17, 2019
build.gradle Update Jackson to 2.9.9 May 23, 2019
gradle.properties.example add gradle properties example May 28, 2014
gradlew Add gradlew and instructions to use it instead of gradle May 27, 2014
gradlew.bat Add gradlew and instructions to use it instead of gradle May 27, 2014
pom.xml Update Jackson to 2.9.9 May 23, 2019

README.md

SendGrid Logo

Travis Badge Maven Central Email Notifications Badge Twitter Follow GitHub contributors Open Source Helpers MIT licensed

NEW: Subscribe to email notifications for releases and breaking changes.

This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via Java.

Version 3.X.X of this library provides full support for all Twilio SendGrid Web API v3 endpoints, including the new v3 /mail/send.

This library represents the beginning of a new path for Twilio SendGrid. We want this library to be community driven and Twilio 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!

Table of Contents

Installation

Prerequisites

  • Java version Oracle JDK 7, 8 or OpenJDK 7
  • The Twilio SendGrid service, starting at the free level to send up to 40,000 emails for the first 30 days, then send 100 emails/day free forever or check out our pricing.

Setup Environment Variables

Update the development environment with your SENDGRID_API_KEY, for example:

  1. Copy the sample environment file to a new file
cp .env_sample .env
  1. Edit the new .env to add your API key
  2. Source the .env file to set rhe variable in the current session
source .env

Install Package

Choose your installation method - Maven w/ Gradle (recommended), Maven or Jar file.

via Maven w/ Gradle

Add the following to your build.gradle file in the root of your project.

...
dependencies {
  ...
  implementation 'com.sendgrid:sendgrid-java:4.4.1'
}

repositories {
  mavenCentral()
}
...

via Maven

mvn install

via jar file

You can just drop the jar file in. It's a fat jar - it has all the dependencies built in.

sendgrid-java.jar

Dependencies

Quick Start

Hello Email

The following is the minimum needed code to send an email with the /mail/send Helper (here is a full example):

With Mail Helper Class

import com.sendgrid.*;
import java.io.IOException;

public class Example {
  public static void main(String[] args) throws IOException {
    Email from = new Email("test@example.com");
    String subject = "Sending with Twilio SendGrid is Fun";
    Email to = new Email("test@example.com");
    Content content = new Content("text/plain", "and easy to do anywhere, even with Java");
    Mail mail = new Mail(from, subject, to, content);

    SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
    Request request = new Request();
    try {
      request.setMethod(Method.POST);
      request.setEndpoint("mail/send");
      request.setBody(mail.build());
      Response response = sg.api(request);
      System.out.println(response.getStatusCode());
      System.out.println(response.getBody());
      System.out.println(response.getHeaders());
    } catch (IOException ex) {
      throw ex;
    }
  }
}

The Mail constructor creates a personalization object for you. Here is an example of how to add to it.

Without Mail Helper Class

The following is the minimum needed code to send an email without the /mail/send Helper (here is a full example):

import com.sendgrid.*;
import java.io.IOException;

public class Example {
  public static void main(String[] args) throws IOException {
    try {
      SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
      Request request = new Request();
      request.setMethod(Method.POST);
      request.setEndpoint("mail/send");
      request.setBody("{\"personalizations\":[{\"to\":[{\"email\":\"test@example.com\"}],\"subject\":\"Sending with Twilio SendGrid is Fun\"}],\"from\":{\"email\":\"test@example.com\"},\"content\":[{\"type\":\"text/plain\",\"value\": \"and easy to do anywhere, even with Java\"}]}");
      Response response = sg.api(request);
      System.out.println(response.getStatusCode());
      System.out.println(response.getBody());
      System.out.println(response.getHeaders());
    } catch (IOException ex) {
      throw ex;
    }
  }
}

General v3 Web API Usage

import com.sendgrid.*;
import java.io.IOException;

public class Example {
  public static void main(String[] args) throws IOException {
    SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
    try {
      Request request = new Request();
      request.setMethod(Method.GET);
      request.setEndpoint("api_keys");
      Response response = sg.api(request);
      System.out.println(response.getStatusCode());
      System.out.println(response.getBody());
      System.out.println(response.getHeaders());
    } catch (IOException ex) {
      throw ex;
    }
  }
}

Usage

Use Cases

Examples of common API use cases, such as how to send an email with a transactional template.

Announcements

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.

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.

How to Contribute

We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.

Quick links:

Troubleshooting

Please see our troubleshooting guide for common library issues.

About

sendgrid-java is guided and supported by the Twilio Developer Experience Team.

Please email the Developer Experience Team here in case of any queries.

sendgrid-java is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-java are trademarks of Twilio SendGrid, Inc.

License

The MIT License (MIT)

You can’t perform that action at this time.