This Java module allows you to quickly and easily send emails through SendGrid using Java.
import com.sendgrid.*;
SendGrid sendgrid = new SendGrid("sendgrid_username", "sendgrid_password");
SendGrid.Email email = new SendGrid.Email();
email.addTo("[email protected]");
email.setFrom("[email protected]");
email.setSubject("Hello World");
email.setText("My first email through SendGrid");
try {
SendGrid.Response response = sendgrid.send(email);
catch (SendGridException e) {
System.out.println(e);
}Choose your installation method - Maven w/ Gradle (recommended) or Jar file.
Add the following to your build.gradle file in the root of your project.
...
dependencies {
...
compile 'com.sendgrid:sendgrid-java:1.0.0'
}
repositories {
mavenCentral()
}
...Then import the library - in the file appropriate to your Java project.
import com.sendgrid.SendGrid;You can just drop the jar file in. It's a fat jar - it has all the dependencies built in.
import com.sendgrid.*;To begin using this library, initialize the SendGrid object with your SendGrid credentials.
import com.sendgrid.SendGrid;
SendGrid sendgrid = new SendGrid("sendgrid_username", "sendgrid_password");Add your message details.
Email email = new Email();
email.addTo("[email protected]");
email.addToName("Example Guy");
email.setFrom("[email protected]");
email.setSubject("Hello World");
email.setText("My first email through SendGrid");Send it.
sendgrid.send(email);email.addTo("[email protected]");
// or
email.setTos(["[email protected]"]);email.setFrom("[email protected]");email.setFromName("Other Dude");email.setReplyTo("[email protected]");email.setSubject("Hello World");email.setText("This is some text of the email.");email.setHtml("<h1>My first email through SendGrid");email.addAttachment("text.txt", "contents");
// or
email.addAttachment("image.png", new File("./image.png"));
// or
email.addAttachment("text.txt", new InputStream(new File("./file.txt")));The mail object extends de SMTPAPI object which is found in STMAPI-Java.
header.addSubstitution("key", "value");
// or
header.setSubstitutions("key", ["value1", "value2"]);
JSONObject subs = header.getSubstitutions();header.addUuniqueAarg("key", "value");
// or
Map map = new HashMap<String, String>();
map.put("unique", "value");
header.setUniqueArgs(map);
// or
JSONObject map = new JSONObject();
map.put("unique", "value");
header.setUniqueArgs(map);
JSONObject args = header.getUniqueArgs();header.addCategory("category");
// or
header.addCategory(["categories"]);
// or
header.setCategories(["category1", "category2"]);
String[] cats = header.getCategories();header.addSection("key", "section");
// or
Map newSec = new HashMap();
newSec.put("-section-", "value");
header.setSections(newSec);
// or
JSONObject newSec = new JSONObject();
newSec.put("-section-", "value");
header.setSections(newSec);
JSONObject sections = header.getSections();header.addFilter("filter", "setting", "value");
header.addFilter("filter", "setting", 1);
JSONObject filters = header.getFilters();String headers = header.jsonString();You can enable and configure Apps.
SendGrid sendgrid = new SendGrid("sendgrid_username", "sendgrid_password");
sendgrid.addTo("[email protected]");
...
sendgrid.addFilter("bcc", "enabled", 1);
sendgrid.addFilter("bcc", "email", "[email protected]");- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
The existing tests in the src/test directory can be run using gradle with the following command:
./gradlew test -i./gradlew build(If you don't have gradle install it. If on a mac, you can run brew install gradle)
This only works if you have the correct permissions - for admins only basically.
./gradlew uploadArchives
Login to Sonatype.
Go to staging repositories page.
Click 'Close' with the archive selected.
Wait a few minutes, and refresh the staging repositories page.
Check the box for the SendGrid repo again and this time click 'Release'.
You're all done.
We have an example app using this library. This can be helpful to get a grasp on implementing it in your own app.
github.com/scottmotte/sendgrid-java-example
Licensed under the MIT License.