Merge pull request #29 from SparkPost/feature/issue_26_attachments

yepher · yepher · commit 1d37d074a58e · 2016-03-30T18:02:27.000-05:00
Feature/issue 26 attachments
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ The SparkPost Java Library is available in this [Maven Repository](http://maven.
 <dependency>
 	<groupId>com.sparkpost</groupId>
 	<artifactId>sparkpost-lib</artifactId>
-	<version>0.13</version>
+	<version>0.14</version>
 </dependency>
 ```
 
@@ -59,7 +59,7 @@ public class SparkPost {
 
 ## Advanced Send Email Example
 
-With SparkPost you have complete control over all aspects of an email and a powerful tempting solution.
+With SparkPost you have complete control over all aspects of an email and a powerful templating solution.
 
 ```java
 
@@ -75,17 +75,18 @@ private void sendEmail(String from, String[] recipients, String email) throws Sp
 	}
 	transmission.setRecipientArray(recipientArray);
 
-	transmission.setReturnPath(from);
-
-	// Populate Substitution Data
-	Map<String, String> substitutionData = new HashMap<String, String>();
-	substitutionData.put("from", from);
-	transmission.setSubstitutionData(substitutionData);
-
-	// Populate Email Body
-	TemplateContentAttributes contentAttributes = new TemplateContentAttributes();
-	contentAttributes.setEmailRFC822(email);
-	transmission.setContentAttributes(contentAttributes);
+	 // Populate Substitution Data
+    Map<String, Object> substitutionData = new HashMap<String, Object>();
+    substitutionData.put("yourContent", "You can add substitution data too.");
+    transmission.setSubstitutionData(substitutionData);
+
+    // Populate Email Body
+    TemplateContentAttributes contentAttributes = new TemplateContentAttributes();
+    contentAttributes.setFrom(new AddressAttributes(from));
+    contentAttributes.setSubject("Your subject content here. {{yourContent}}");
+    contentAttributes.setText("Your Text content here.  {{yourContent}}");
+    contentAttributes.setHtml("<p>Your <b>HTML</b> content here.  {{yourContent}}</p>");
+    transmission.setContentAttributes(contentAttributes);
 
 	// Send the Email
 	RestConnection connection = new RestConnection(client, getEndPoint());
diff --git a/apps/pom.xml b/apps/pom.xml
@@ -3,7 +3,7 @@
 	<parent>
 		<groupId>com.sparkpost</groupId>
 		<artifactId>sparkpost</artifactId>
-		<version>0.13</version>
+		<version>0.14</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>apps</artifactId>
diff --git a/apps/sparkpost-documentor-app/pom.xml b/apps/sparkpost-documentor-app/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>com.sparkpost</groupId>
 		<artifactId>apps</artifactId>
-		<version>0.13</version>
+		<version>0.14</version>
 	</parent>
 	<artifactId>sparkpost-documentor-app</artifactId>
 	<name>Generates Markdown of Protocol</name>
diff --git a/apps/sparkpost-javamail-app/pom.xml b/apps/sparkpost-javamail-app/pom.xml
@@ -6,7 +6,7 @@
 	<parent>
 		<groupId>com.sparkpost</groupId>
 		<artifactId>apps</artifactId>
-		<version>0.13</version>
+		<version>0.14</version>
 	</parent>
 	<groupId>com.sparkpost.sample</groupId>
 	<artifactId>sparkpost-javamail-app</artifactId>
diff --git a/apps/sparkpost-samples-app/pom.xml b/apps/sparkpost-samples-app/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>com.sparkpost</groupId>
 		<artifactId>apps</artifactId>
-		<version>0.13</version>
+		<version>0.14</version>
 	</parent>
 	<artifactId>sparkpost-samples-app</artifactId>
 	<name>Example use SparkPost library</name>
diff --git a/apps/sparkpost-samples-app/src/main/java/com/sparkpost/samples/SendEmailSample.java b/apps/sparkpost-samples-app/src/main/java/com/sparkpost/samples/SendEmailSample.java
@@ -38,15 +38,14 @@ private void runApp() throws SparkPostException, IOException {
         this.client = this.newConfiguredClient();
 
         // Loads an email to send from the file system
-        String template = getTemplate("sample_sp_email.eml");
         String fromAddress = getFromAddress();
         String[] recipients = getTestRecipients();
 
-        sendEmail(fromAddress, recipients, template);
+        sendEmail(fromAddress, recipients);
 
     }
 
-    private void sendEmail(String from, String[] recipients, String email) throws SparkPostException {
+    private void sendEmail(String from, String[] recipients) throws SparkPostException {
         TransmissionWithRecipientArray transmission = new TransmissionWithRecipientArray();
 
         // Populate Recipients
@@ -58,16 +57,19 @@ private void sendEmail(String from, String[] recipients, String email) throws Sp
         }
         transmission.setRecipientArray(recipientArray);
 
-        transmission.setReturnPath(from);
-
         // Populate Substitution Data
         Map<String, Object> substitutionData = new HashMap<String, Object>();
-        substitutionData.put("from", from);
+        substitutionData.put("yourContent", "You can add substitution data too.");
         transmission.setSubstitutionData(substitutionData);
 
         // Populate Email Body
         TemplateContentAttributes contentAttributes = new TemplateContentAttributes();
-        contentAttributes.setEmailRFC822(email);
+        contentAttributes.setFrom(new AddressAttributes(from));
+        contentAttributes.setSubject("Your subject content here. {{yourContent}}");
+        contentAttributes.setText("Your Text content here.  {{yourContent}}");
+        contentAttributes.setHtml("<p>Your <b>HTML</b> content here.  {{yourContent}}</p>");
+        transmission.setContentAttributes(contentAttributes);
+
         transmission.setContentAttributes(contentAttributes);
 
         // Send the Email
diff --git a/apps/sparkpost-samples-app/src/main/java/com/sparkpost/samples/SendEmailWithFilesSample.java b/apps/sparkpost-samples-app/src/main/java/com/sparkpost/samples/SendEmailWithFilesSample.java
@@ -0,0 +1,102 @@
+
+package com.sparkpost.samples;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.log4j.Level;
+import org.apache.log4j.Logger;
+
+import com.sparkpost.Client;
+import com.sparkpost.exception.SparkPostException;
+import com.sparkpost.model.AddressAttributes;
+import com.sparkpost.model.AttachmentAttributes;
+import com.sparkpost.model.InlineImageAttributes;
+import com.sparkpost.model.RecipientAttributes;
+import com.sparkpost.model.TemplateContentAttributes;
+import com.sparkpost.model.TransmissionWithRecipientArray;
+import com.sparkpost.model.responses.Response;
+import com.sparkpost.resources.ResourceTransmissions;
+import com.sparkpost.sdk.samples.helpers.SparkPostBaseApp;
+import com.sparkpost.transport.RestConnection;
+
+public class SendEmailWithFilesSample extends SparkPostBaseApp {
+
+    static final Logger logger = Logger.getLogger(CreateTemplateSimple.class);
+
+    private Client client;
+
+    public static void main(String[] args) throws SparkPostException, IOException {
+        Logger.getRootLogger().setLevel(Level.DEBUG);
+
+        SendEmailWithFilesSample sample = new SendEmailWithFilesSample();
+        sample.runApp();
+    }
+
+    private void runApp() throws SparkPostException, IOException {
+        this.client = this.newConfiguredClient();
+
+        // Loads an email to send from the file system
+        String fromAddress = getFromAddress();
+        String[] recipients = getTestRecipients();
+
+        sendEmail(fromAddress, recipients);
+
+    }
+
+    private void sendEmail(String from, String[] recipients) throws SparkPostException {
+        TransmissionWithRecipientArray transmission = new TransmissionWithRecipientArray();
+
+        // Populate Recipients
+        List<RecipientAttributes> recipientArray = new ArrayList<RecipientAttributes>();
+        for (String recipient : recipients) {
+            RecipientAttributes recipientAttribs = new RecipientAttributes();
+            recipientAttribs.setAddress(new AddressAttributes(recipient));
+            recipientArray.add(recipientAttribs);
+        }
+        transmission.setRecipientArray(recipientArray);
+
+        // Populate Email Body
+        TemplateContentAttributes contentAttributes = new TemplateContentAttributes();
+        contentAttributes.setFrom(new AddressAttributes(from));
+        contentAttributes.setSubject("Hello World");
+        contentAttributes.setText("Simple text content");
+
+        // Add a text attachment
+        AttachmentAttributes attachment = new AttachmentAttributes();
+        attachment.setName("aFile.txt");
+        attachment.setType("text/plain; charset=UTF-8;");
+        // This is Base64 of the file contents
+        attachment.setData("SGVsbG8gV29ybGQhCuydvA==");
+        List<AttachmentAttributes> attachments = new ArrayList<>();
+        attachments.add(attachment);
+        contentAttributes.setAttachments(attachments);
+
+        // Add inline image
+        InlineImageAttributes image = new InlineImageAttributes();
+        /*
+         * The name of the inline image, which will be inserted into the Content-ID header.
+         * The image should be referenced in your HTML content using <img src="cid:THIS_NAME">.
+         * The name must be unique within the content.inline_images array.
+         */
+        contentAttributes.setHtml("<p>My fantastic HTML content.<br><br><b>SparkPost</b> <img src=\"cid:AnImage.png\"></p>");
+        image.setName("AnImage.png");
+        image.setType("image/png");
+        // This is Base64 of the file contents
+        image.setData(
+                "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAXxJREFUOBFjvJVg84P5718WBjLAX2bmPyxMf/+xMDH8YyZDPwPDXwYGJkIaOXTNGdiUtHAqI2jA/18/GUQzGsg3gMfKg4FVQo6BiYcPqyF4XcChaczA4+DP8P//f4b/P3+SZgAzvxCDSGYjAyMjI8PvZw+AoYXdLuyiQLtE0uoZWAREwLb+fnKXQTipkngXcJu7MnACQx8G2FX1GHgs3bDGBlYX8HlFM/z9+JbhzewWhmf1CQyfti9j+PfzBwO/ZxTMTDiNmQKBfmZX1GB42V/K8P38YbDCX/dvMDAwMzPwuYbBNcIYmC4AhfjvXwx/376AqQHTf96+ZPj34xuKGIiDaQBQ8PPBTQwCoZkMjJzcYA3MgqIMAr7xDJ/3rAHzkQnGO7FWf5gZ/qLmBSZmBoHgNAZee1+Gf18/MzCyczJ83LyQ4fPetch6Gf4xMP3FbgBMGdAgJqAr/n37zABMTTBROA0ygAWUJUG5Civ4B8xwX78CpbD6FJiHmf4AAFicbTMTr5jAAAAAAElFTkSuQmCC");
+        List<InlineImageAttributes> inlineImages = new ArrayList<InlineImageAttributes>();
+        inlineImages.add(image);
+        contentAttributes.setInlineImages(inlineImages);
+
+        transmission.setContentAttributes(contentAttributes);
+
+        // Send the Email
+        RestConnection connection = new RestConnection(this.client, getEndPoint());
+        Response response = ResourceTransmissions.create(connection, 0, transmission);
+
+        logger.debug("Transmission Response: " + response);
+    }
+
+}
diff --git a/libs/pom.xml b/libs/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>com.sparkpost</groupId>
 		<artifactId>sparkpost</artifactId>
-		<version>0.13</version>
+		<version>0.14</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>libs</artifactId>
diff --git a/libs/sparkpost-lib/pom.xml b/libs/sparkpost-lib/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>com.sparkpost</groupId>
 		<artifactId>libs</artifactId>
-		<version>0.13</version>
+		<version>0.14</version>
 	</parent>
 	<!-- <version>0.10</version> -->
 	<artifactId>sparkpost-lib</artifactId>
diff --git a/libs/sparkpost-lib/src/main/java/com/sparkpost/model/AttachmentAttributes.java b/libs/sparkpost-lib/src/main/java/com/sparkpost/model/AttachmentAttributes.java
@@ -0,0 +1,14 @@
+
+package com.sparkpost.model;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * DTO for a transmission of attachments.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class AttachmentAttributes extends FileAttributes {
+
+}
diff --git a/libs/sparkpost-lib/src/main/java/com/sparkpost/model/FileAttributes.java b/libs/sparkpost-lib/src/main/java/com/sparkpost/model/FileAttributes.java
@@ -0,0 +1,42 @@
+
+package com.sparkpost.model;
+
+import com.yepher.jsondoc.annotations.Description;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * DTO for attachments and inline images
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class FileAttributes extends Base {
+
+    public FileAttributes() {
+
+    }
+
+    /**
+     * Valid email address
+     */
+    @Description(
+            value = "The MIME type of the file. The value will apply \"as-is\" to the \"Content-Type\" header of the generated MIME part for the file.",
+            sample = {"image/jpeg"})
+    private String type;
+
+    /**
+     * User-friendly name for the email address
+     */
+    @Description(value = "The name of the file.", sample = {"rainbow.jpg"})
+    private String name;
+
+    /**
+     * Email address to display in the "To" header instead of address.email (for BCC)
+     */
+    @Description(
+            value = "he content of the file as a Base64 encoded string. The string should not contain \\r\\n line breaks. The SparkPost systems will add line breaks as necessary to ensure the Base64 encoded lines contain no more than 76 characters each.",
+            sample = {""})
+    private String data;
+
+}
diff --git a/libs/sparkpost-lib/src/main/java/com/sparkpost/model/InlineImageAttributes.java b/libs/sparkpost-lib/src/main/java/com/sparkpost/model/InlineImageAttributes.java
@@ -0,0 +1,14 @@
+
+package com.sparkpost.model;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * DTO for a transmission of inline images.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class InlineImageAttributes extends FileAttributes {
+
+}
diff --git a/libs/sparkpost-lib/src/main/java/com/sparkpost/model/TemplateContentAttributes.java b/libs/sparkpost-lib/src/main/java/com/sparkpost/model/TemplateContentAttributes.java
@@ -1,6 +1,7 @@
 
 package com.sparkpost.model;
 
+import java.util.List;
 import java.util.Map;
 
 import com.google.gson.annotations.SerializedName;
@@ -59,9 +60,22 @@ public class TemplateContentAttributes extends Base {
     @Description(value = "Extra email headers to send", sample = {"Dictionary of Email Headers"})
     private Map<String, String> headers = null;
 
+    /**
+     * Attachments for a transmission
+     */
+    @Description(value = "List of AttachmentAttributes. Attachments are not valid with templateId.", sample = {""})
+    private List<AttachmentAttributes> attachments = null;
+
+    /**
+     * Inline images for a transmission
+     */
+    @Description(value = "List of InlineImageAttributes. Inline images are not valid with templateId.", sample = {""})
+    @SerializedName("inline_images")
+    private List<InlineImageAttributes> inlineImages = null;
+
     /**
      * Alternatively, the email_rfc822 may be used *instead* of all the other fields.
-     * The email_rfc822 field is mutually exclusive with all of the above fields.
+     * The email_rfc822 field is mutually exclusive with all of the other fields in this class.
      */
     @Description(
             value = "Alternatively, the email_rfc822 may be used *instead* of all the other fields. The email_rfc822 field is mutually exclusive with all of the above fields.",
diff --git a/libs/sparkpost-lib/src/main/java/com/sparkpost/transport/RestConnection.java b/libs/sparkpost-lib/src/main/java/com/sparkpost/transport/RestConnection.java
@@ -169,12 +169,9 @@ private HttpURLConnection createConnectionObject(String path, Method method) thr
     // Send HTTP data (payload) to server
     private void sendData(HttpURLConnection conn, String data) throws SparkPostException {
         byte[] bytes = null;
-        try
-        {
+        try {
             bytes = data.getBytes(DEFAULT_CHARSET);
-        }
-        catch (UnsupportedEncodingException e)
-        {
+        } catch (UnsupportedEncodingException e) {
             // This should never happen. UTF-8 should always be available but we
             // have to catch it so pass it on if it fails.
             throw new SparkPostException(e);
@@ -247,10 +244,28 @@ private Response receiveResponse(HttpURLConnection conn, Response response) thro
             // an error.
             response.setResponseBody("");
         } catch (IOException ex) {
+            String line = "";
+            try (BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getErrorStream(), DEFAULT_CHARSET))) {
+
+                while ((line = rd.readLine()) != null) {
+                    sb.append(line);
+                }
+
+                response.setResponseBody(sb.toString());
+                response.setRequestId(conn.getHeaderField("X-SparkPost-Request-Id"));
+
+                logger.error("Server Response:\n" + sb.toString() + "\n");
+
+            } catch (IOException ex2) {
+                // Ignore we are going to throw an exception anyway
+            }
+            if (logger.isDebugEnabled()) {
+                logger.error("Server Response:" + response);
+            }
             throw new SparkPostException("Error reading server response: " + ex.toString() + ": " + sb.toString() + "(" + response.getResponseMessage() + ")");
         }
-
         return response;
+
     }
 
     // This method actually performs an HTTP request.
diff --git a/pom.xml b/pom.xml
