adellahlou/smtpapi-java

It's Hacktoberfest!! SendGrid is giving out shirts if you make pull requests!

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

Announcements

All updates to this module is documented in our CHANGELOG.

Table of Contents

• Installation
• Quick Start
• Usage
• Roadmap
• How to Contribute
• About
• License

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

• See build.gradle.

Quick Start

import com.sendgrid.smtpapi.SMTPAPI;

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

Usage

• SendGrid Docs
• Example Code

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:

• Feature Request
• Bug Reports
• Sign the CLA to Create a Pull Request
• Improvements to the Codebase

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)