SendGrid's smtpapi library in Java
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update PULL_REQUEST_TEMPLATE Oct 28, 2017
examples
gradle/wrapper
scripts
src Merge pull request #49 from pjhampton/pjhampton/add-tests Oct 31, 2017
.codeclimate.yml
.env_sample
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.txt
README.md
TROUBLESHOOTING.md
build.gradle
gradle.properties.example
gradlew
gradlew.bat

README.md

SendGrid Logo

BuildStatus Email Notifications Badge Twitter Follow GitHub contributors MIT licensed

This module allows you to build SendGrid's SMTP API headers with simplicity.

Announcements

All updates to this module is documented in our CHANGELOG.

If you're a software engineer who is passionate about #DeveloperExperience and/or #OpenSource, this is an incredible opportunity to join our #DX team as a Developer Experience Engineer and work with @thinkingserious and @aroach! Tell your friends :)

Table of Contents

Installation

Prerequisites

  • Java version Oracle JDK 7, 8 or OpenJDK 7
  • The SendGrid service, starting at the free level

Install Package

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

Install Maven w/ Gradle

...
dependencies {
  ...
  compile 'com.sendgrid:smtpapi-java:1.2.0'
}

repositories {
  mavenCentral()
}
...

Then import the library - in the file appropriate to your Java project.

import com.sendgrid.smtpapi.SMTPAPI;

Install with Jar File

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

smtpapi-java.jar

Environment Variable

Update the development environment with your SENDGRID_API_KEY, for example:

echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env

Dependencies

Quick Start

import com.sendgrid.smtpapi.SMTPAPI;

public class Example {
  public static void main(String[] args) {
    SMTPAPI header = new SMTPAPI();
    header.addTo("test@example.com");
    String headers = header.jsonString();
    System.out.println(headers);
  }
}

Usage

Roadmap

If you are interested in the future direction of this project, please take a look at our milestones. We would love to hear your feedback.

How to Contribute

We encourage contribution to our projects, please see our CONTRIBUTING guide for details.

Quick links:

About

smtpapi-java is guided and supported by the SendGrid Developer Experience Team.

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

License

The MIT License (MIT)