• Stars
    star
    481
  • Rank 91,384 (Top 2 %)
  • Language
    Java
  • License
    MIT License
  • Created about 11 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The Official Twilio SendGrid Led, Community Driven Java API Library

SendGrid Logo

BuildStatus Maven Central Twitter Follow GitHub contributors Open Source Helpers MIT licensed

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.

If you need help using SendGrid, please check the Twilio SendGrid Support Help Center.

Table of Contents

Installation

Prerequisites

  • Java 8 or 11
  • 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 the 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.9.3'
}

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("[email protected]");
    String subject = "Sending with Twilio SendGrid is Fun";
    Email to = new Email("[email protected]");
    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\":\"[email protected]\"}],\"subject\":\"Sending with Twilio SendGrid is Fun\"}],\"from\":{\"email\":\"[email protected]\"},\"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

All updates to this library are documented in our CHANGELOG and releases.

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 maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-java are trademarks of Twilio SendGrid, Inc.

Support

If you need help installing or using the library, please check the Twilio SendGrid Support Help Center.

License

The MIT License (MIT)

More Repositories

1

sendgrid-nodejs

The Official Twilio SendGrid Led, Community Driven Node.js API Library
JavaScript
2,974
star
2

sendgrid-python

The Official Twilio SendGrid Python API Library
Python
1,463
star
3

sendgrid-php

The Official Twilio SendGrid PHP API Library
PHP
1,445
star
4

sendgrid-csharp

The Official Twilio SendGrid C#, .NetStandard, .NetCore API Library
C#
1,030
star
5

sendgrid-go

The Official Twilio SendGrid Golang API Library
Go
924
star
6

email-templates

A repository of common email templates to use and modify to your heart's content.
HTML
816
star
7

sendgrid-ruby

The Official Twilio SendGrid Led, Community Driven Ruby API Library
Ruby
606
star
8

docs

Repository of Twilio SendGrid's product documentation.
JavaScript
236
star
9

rest

SendGrid's Golang HTTP Client for calling APIs
Go
167
star
10

python-http-client

Twilio SendGrid's Python HTTP Client for calling APIs
Python
121
star
11

php-http-client

SendGrid's PHP HTTP Client for calling APIs
PHP
120
star
12

nodemailer-sendgrid-transport

SendGrid transport for Nodemailer
JavaScript
116
star
13

smtpapi-php

SendGrid's smtpapi library in PHP
PHP
67
star
14

krampus

The original AWS security enforcerâ„¢
Python
58
star
15

eventkit-rails

An open source project for integrating with SendGrid's Event Webhook.
Ruby
52
star
16

wordpress

SendGrid plugin for WordPress
PHP
48
star
17

smtpapi-nodejs

SendGrid's smtpapi library in NodeJS
JavaScript
47
star
18

sendgrid-parse-api-example

Example application using the SendGrid Parse API.
JavaScript
45
star
19

sendgrid-subscription-widget

A new SendGrid subscription widget that works with existing infrastructure.
JavaScript
44
star
20

sendgrid-oai

SendGrid's Open API specification for the v3 API
Shell
42
star
21

go-solr

solr go client from sendgrid, zookeeper aware, incorporates retries
Go
39
star
22

sendgrid-php-example

Example of using sendgrid-php library.
PHP
33
star
23

sendgrid-apex

SendGrid (http://sendgrid.com) Apex helper library.
Apex
33
star
24

sendgrid-nodejs-example

Example of using sendgrid-nodejs library.
JavaScript
31
star
25

opensource

SendGrid Open Source Dashboard
31
star
26

smtpapi-go

SendGrids smtpapi library in Golang
Go
30
star
27

go-gmime

Go
27
star
28

smtpapi-csharp

SendGrid's smtpapi library in C#
C#
27
star
29

java-http-client

SendGrid's Java HTTP Client for calling APIs
Java
26
star
30

sendgrid-objc

SendGrid Objective-C helper library
Objective-C
25
star
31

csharp-http-client

Twilio SendGrid's C# HTTP Client for calling APIs
C#
23
star
32

ruby-http-client

SendGrid's Ruby HTTP Client for calling APIs
Ruby
23
star
33

ti.sendgrid

A SendGrid CommonJS module for Titanium
JavaScript
21
star
34

sendgrid-cli

The SendGrid CLI (Command Line Interface) is a tool that helps you to interact with SendGrid services from the command line.
JavaScript
20
star
35

nodejs-http-client

This repo is no longer maintained. Please use https://github.com/sendgrid/sendgrid-nodejs/tree/HEAD/packages/client instead
JavaScript
19
star
36

sendgrid-perl

Perl module for SendGrid's API
Perl
18
star
37

sendgrid-cobol

Official SendGrid library for Cobol
C
16
star
38

sendgridjs

Proxy so you can send email via JavaScript through SendGrid.
JavaScript
14
star
39

dx-automator

A tool for managing priorities across multiple GitHub repositories
HCL
14
star
40

sendgrid-parse-demo

A simple example of a parse webhook endpoint that receives an email, looks at the body for an integer, rolls that many dice, and replies to the requester.
PHP
13
star
41

open-source-library-data-collector

A tool for collecting open source download and github stats across multiple repositories
Python
12
star
42

filegetter

This package is an example implementation referenced in the blog post 'When Writing Unit Tests, Don't Use Mocks.'
Go
10
star
43

stopwatch

Benchmark your Go code with this utility for keeping track of timing information for different states.
Go
10
star
44

aws-env

PUBLIC REPO: Wrapper to export environment variables from AWS Parameter Store
Go
9
star
45

sendgrid-google-php

PHP
9
star
46

openshift-sendgrid-php

SendGrid integration for RedHat's OpenShift
PHP
8
star
47

google-python-sample-app

Python
8
star
48

sendgrid-google-java

Java
7
star
49

uptyped

Ruby
7
star
50

sendgrid-java-example

Example of using sendgrid-java library.
Java
6
star
51

sendgrid-engine-yard-ruby

Example Ruby app that shows how to use SendGrid on EngineYard
Ruby
5
star
52

dx-mobile

A Flutter powered iOS and Android app to help maintainers manage multiple repos on the go.
Dart
5
star
53

smtpapi-java

SendGrid's smtpapi library in Java
Java
5
star
54

sendgrid-java-sample-app

Java
4
star
55

smtpapi-objc

Simple Wrapper around SendGrid SMTPAPI Header
Objective-C
4
star
56

google-java-sample-app

Java
4
star
57

ui-developer-challenge

Ruby
3
star
58

tagtrics

Easy to use application metrics
Go
3
star
59

martini

Go
3
star
60

design-primitives

SendGrid design primitives
JavaScript
3
star
61

sendgrid-engine-yard-php

A sample app demonstrating how to integrate SendGrid with EngineYard through PHP.
PHP
3
star
62

sendgrid-python-django-sample-app

Python
3
star
63

google-php-sample-app

PHP
3
star
64

sendgrid-azure-ios

iPhone app which lets a user enter a song into a request queue backed by a sample Azure app
Objective-C
3
star
65

Gridium

A web automation framework for Selenium and NO Capybara
Ruby
2
star
66

box

Demo for BoxDev 2016
Python
2
star
67

sendgrid-rails-sample-app

Ruby
2
star
68

visual_studio_sdk_mail

2
star
69

Reputation

Python
2
star
70

visual_studio_sdk_sample_app

MSFT SDK for the sample app
C#
2
star
71

reseller-docs

1
star
72

sherlock

JavaScript
1
star
73

JusticeEngine

Python
1
star
74

library-automator

For automating v3 endpoints into our 7 libraries
C#
1
star
75

sendgrid-php-sample-app

sendgrid-php-sample-app
PHP
1
star
76

folly

A folly of a service that just chews up memory and CPU cycles
Go
1
star
77

lambda_cost

A Jupyter Notebook Comparing Lambda and EC2 Costs
Jupyter Notebook
1
star