Sendgrid

java.lang.Object
- org.gaelic.util.Sendgrid

public class Sendgrid
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Sendgrid.SendgridHTTP`
`static class`	`Sendgrid.SendGridReqResp`
`static interface`	`Sendgrid.WarningListener` Invoked when a warning is returned from the server that isn't critical

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`domain`
`protected java.lang.String`	`endpoint`
`protected java.lang.String`	`password`
`protected java.lang.String`	`token`
`protected java.lang.Boolean`	`use_headers`
`protected java.lang.String`	`username`

Constructor Summary

Constructors
Constructor and Description

Sendgrid(java.lang.String username, java.lang.String password, java.lang.String token)

Constructors
Constructor and Description
`Sendgrid(java.lang.String username, java.lang.String password, java.lang.String token)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`_arrayToUrlPart(java.util.ArrayList<java.lang.String> array, java.lang.String token)` _arrayToUrlPart - Converts an ArrayList to a url friendly string
`protected java.util.Map<java.lang.String,java.lang.String>`	`_prepMessageData()` _prepMessageData - Takes the mail message and returns a url friendly querystring
`Sendgrid`	`addCategory(java.lang.String category)` addCategory - Append a category to the list of categories
`Sendgrid`	`addFilterSetting(java.lang.String filter_name, java.lang.String parameter_name, java.lang.String parameter_value)` addFilterSetting - Append a filter setting to the list of filter settings
`Sendgrid`	`addSection(java.lang.String from_value, java.lang.String to_value)` addSection - append a section value to the list of section values
`Sendgrid`	`addSubstitution(java.lang.String from_value, java.lang.String[] to_values)`
`Sendgrid`	`addTo(java.lang.String email)` addTo - Make the second parameter("name") of "addTo" method optional
`Sendgrid`	`addTo(java.lang.String email, java.lang.String name)` addTo - Append an email address to the existing list of addresses Preserve previous recipient 'to' data.
`Sendgrid`	`addUniqueArgument(java.lang.String key, java.lang.String value)` addUniqueArgument - Set a key/value pair of unique arguments, to be used for tracking purposes
`java.util.ArrayList<java.lang.String>`	`getBccs()` getBccs - return the list of Blind Carbon Copy recipients
`java.util.ArrayList<java.lang.String>`	`getCcs()` getCcs - return the list of Carbon Copy recipients
`java.lang.String`	`getFrom()` getFrom - Get the from email address
`java.lang.String`	`getFromName()` getFromName - Get the from name
`JsonObject`	`getHeaders()` getHeaders - return the list of headers
`java.lang.String`	`getHtml()` getHtml - Get the HTML part of the email
`java.lang.String`	`getReplyTo()` getReplyTo - Get reply to address
`java.lang.String`	`getServerResponse()` getServerResponse - Get the server response message
`java.lang.String`	`getSubject()` getSubject - Get the email subject
`java.lang.String`	`getText()` getText - Get the plain text part of the email
`java.util.ArrayList<java.lang.String>`	`getToNames()` getTos - Return the list of names for recipients
`java.util.ArrayList<java.lang.String>`	`getTos()` getTos - Return the list of recipients
`void`	`send()` send - Send an email
`void`	`send(Sendgrid.WarningListener w)` send - Send an email
`Sendgrid`	`setBcc(java.lang.String email)` setBcc - Initialize the list of Carbon Copy recipients destroy previous recipient Blind Carbon Copy data
`Sendgrid`	`setCategories(java.lang.String[] category_list)`
`Sendgrid`	`setCategory(java.lang.String category)` setCategory - Clears the category list and adds the given category
`Sendgrid`	`setCc(java.lang.String email)` setCc - Initialize the list of Carbon Copy recipients destroy previous recipient Carbon Copy data
`Sendgrid`	`setFilterSettings(JsonObject filter_settings)` setFilterSettings - Set filter/app settings
`Sendgrid`	`setFrom(java.lang.String email)` setFrom - Set the from email
`Sendgrid`	`setFromName(java.lang.String name)` setFromName - Set the from name
`Sendgrid`	`setHeaders(JsonObject key_value_pairs)` setHeaders - Sets the list headers destroys previous header data
`Sendgrid`	`setHtml(java.lang.String html)` setHTML - Set the HTML part of the email
`Sendgrid`	`setReplyTo(java.lang.String email)` setReplyTo - set the reply-to address
`Sendgrid`	`setSections(JsonObject key_value_pairs)` setSection - Set a list of section values
`Sendgrid`	`setSubject(java.lang.String subject)` setSubject - Set the email subject
`Sendgrid`	`setSubstitutions(JsonObject key_value_pairs)` setSubstitutions - Substitute a value for list of values, where each value corresponds to the list emails in a one to one relationship.
`Sendgrid`	`setText(java.lang.String text)` setText - Set the plain text part of the email
`Sendgrid`	`setTo(java.lang.String email)` setTo - Initialize a single email for the recipient 'to' field Destroy previous recipient 'to' data.
`Sendgrid`	`setTransport(Sendgrid.SendgridHTTP sgTransport)` setTo - Initialize a single email for the recipient 'to' field Destroy previous recipient 'to' data.
`Sendgrid`	`setUniqueArguments(JsonObject key_value_pairs)` setUniqueArguments - Set a list of unique arguments, to be used for tracking purposes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - use_headers
```
protected java.lang.Boolean use_headers
```
  - domain
```
protected java.lang.String domain
```
  - endpoint
```
protected java.lang.String endpoint
```
  - username
```
protected java.lang.String username
```
  - token
```
protected java.lang.String token
```
  - password
```
protected java.lang.String password
```
- Constructor Detail
  - Sendgrid
```
public Sendgrid(java.lang.String username,
                java.lang.String password,
                java.lang.String token)
```
- Method Detail
  - setTransport
```
public Sendgrid setTransport(Sendgrid.SendgridHTTP sgTransport)
```
    setTo - Initialize a single email for the recipient 'to' field Destroy previous recipient 'to' data.
    
    Parameters:
    
    sgTransport - The pluggable interface we use to send the request
    
    Returns:
    
    The SendGrid object.
  - getTos
```
public java.util.ArrayList<java.lang.String> getTos()
```
    getTos - Return the list of recipients
    
    Returns:
    
    List of recipients
  - setTo
```
public Sendgrid setTo(java.lang.String email)
```
    setTo - Initialize a single email for the recipient 'to' field Destroy previous recipient 'to' data.
    
    Parameters:
    
    email - A list of email addresses
    
    Returns:
    
    The SendGrid object.
  - addTo
```
public Sendgrid addTo(java.lang.String email,
                      java.lang.String name)
```
    addTo - Append an email address to the existing list of addresses Preserve previous recipient 'to' data.
    
    Parameters:
    
    email - Recipient email address
    
    name - Recipient name
    
    Returns:
    
    The SendGrid object.
  - addTo
```
public Sendgrid addTo(java.lang.String email)
```
    addTo - Make the second parameter("name") of "addTo" method optional
    
    Parameters:
    
    email - A single email address
    
    Returns:
    
    The SendGrid object.
  - getToNames
```
public java.util.ArrayList<java.lang.String> getToNames()
```
    getTos - Return the list of names for recipients
    
    Returns:
    
    List of names
  - getFrom
```
public java.lang.String getFrom()
```
    getFrom - Get the from email address
    
    Returns:
    
    The from email address
  - setFrom
```
public Sendgrid setFrom(java.lang.String email)
```
    setFrom - Set the from email
    
    Parameters:
    
    email - An email address
    
    Returns:
    
    The SendGrid object.
  - getFromName
```
public java.lang.String getFromName()
```
    getFromName - Get the from name
    
    Returns:
    
    The from name
  - setFromName
```
public Sendgrid setFromName(java.lang.String name)
```
    setFromName - Set the from name
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The SendGrid object.
  - getReplyTo
```
public java.lang.String getReplyTo()
```
    getReplyTo - Get reply to address
    
    Returns:
    
    the reply to address
  - setReplyTo
```
public Sendgrid setReplyTo(java.lang.String email)
```
    setReplyTo - set the reply-to address
    
    Parameters:
    
    email - the email to reply to
    
    Returns:
    
    the SendGrid object.
  - getBccs
```
public java.util.ArrayList<java.lang.String> getBccs()
```
    getBccs - return the list of Blind Carbon Copy recipients
    
    Returns:
    
    ArrayList - the list of Blind Carbon Copy recipients
  - setBcc
```
public Sendgrid setBcc(java.lang.String email)
                throws java.lang.Exception
```
    setBcc - Initialize the list of Carbon Copy recipients destroy previous recipient Blind Carbon Copy data
    
    Parameters:
    
    email - an email address
    
    Returns:
    
    the SendGrid object.
    
    Throws:
    
    java.lang.Exception
  - getCcs
```
public java.util.ArrayList<java.lang.String> getCcs()
```
    getCcs - return the list of Carbon Copy recipients
    
    Returns:
    
    ArrayList - the list of Carbon Copy recipients
  - setCc
```
public Sendgrid setCc(java.lang.String email)
               throws java.lang.Exception
```
    setCc - Initialize the list of Carbon Copy recipients destroy previous recipient Carbon Copy data
    
    Parameters:
    
    email - an email address
    
    Returns:
    
    the SendGrid object.
    
    Throws:
    
    java.lang.Exception
  - getSubject
```
public java.lang.String getSubject()
```
    getSubject - Get the email subject
    
    Returns:
    
    The email subject
  - setSubject
```
public Sendgrid setSubject(java.lang.String subject)
```
    setSubject - Set the email subject
    
    Parameters:
    
    subject - The email subject
    
    Returns:
    
    The SendGrid object
  - getText
```
public java.lang.String getText()
```
    getText - Get the plain text part of the email
    
    Returns:
    
    the plain text part of the email
  - setText
```
public Sendgrid setText(java.lang.String text)
```
    setText - Set the plain text part of the email
    
    Parameters:
    
    text - The plain text of the email
    
    Returns:
    
    The SendGrid object.
  - getHtml
```
public java.lang.String getHtml()
```
    getHtml - Get the HTML part of the email
    
    Returns:
    
    The HTML part of the email.
  - setHtml
```
public Sendgrid setHtml(java.lang.String html)
```
    setHTML - Set the HTML part of the email
    
    Parameters:
    
    html - The HTML part of the email
    
    Returns:
    
    The SendGrid object.
  - setCategories
```
public Sendgrid setCategories(java.lang.String[] category_list)
                       throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - setCategory
```
public Sendgrid setCategory(java.lang.String category)
                     throws java.lang.Exception
```
    setCategory - Clears the category list and adds the given category
    
    Parameters:
    
    category - the new category to append
    
    Returns:
    
    the SendGrid object.
    
    Throws:
    
    java.lang.Exception
  - addCategory
```
public Sendgrid addCategory(java.lang.String category)
                     throws java.lang.Exception
```
    addCategory - Append a category to the list of categories
    
    Parameters:
    
    category - the new category to append
    
    Returns:
    
    the SendGrid object.
    
    Throws:
    
    java.lang.Exception
  - setSubstitutions
```
public Sendgrid setSubstitutions(JsonObject key_value_pairs)
```
    setSubstitutions - Substitute a value for list of values, where each value corresponds to the list emails in a one to one relationship. (IE, value[0] = email[0], value[1] = email[1])
    
    Parameters:
    
    key_value_pairs - key/value pairs where the value is an array of values
    
    Returns:
    
    the SendGrid object.
  - addSubstitution
```
public Sendgrid addSubstitution(java.lang.String from_value,
                                java.lang.String[] to_values)
                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - setSections
```
public Sendgrid setSections(JsonObject key_value_pairs)
                     throws java.lang.Exception
```
    setSection - Set a list of section values
    
    Parameters:
    
    key_value_pairs - key/value pairs
    
    Returns:
    
    the SendGrid object.
    
    Throws:
    
    java.lang.Exception
  - addSection
```
public Sendgrid addSection(java.lang.String from_value,
                           java.lang.String to_value)
                    throws java.lang.Exception
```
    addSection - append a section value to the list of section values
    
    Parameters:
    
    from_value - the value to be replaced
    
    to_value - the value to replace
    
    Returns:
    
    the SendGrid object.
    
    Throws:
    
    java.lang.Exception
  - setUniqueArguments
```
public Sendgrid setUniqueArguments(JsonObject key_value_pairs)
```
    setUniqueArguments - Set a list of unique arguments, to be used for tracking purposes
    
    Parameters:
    
    key_value_pairs - - list of unique arguments
  - addUniqueArgument
```
public Sendgrid addUniqueArgument(java.lang.String key,
                                  java.lang.String value)
```
    addUniqueArgument - Set a key/value pair of unique arguments, to be used for tracking purposes
    
    Parameters:
    
    key - the key
    
    value - the value
  - setFilterSettings
```
public Sendgrid setFilterSettings(JsonObject filter_settings)
```
    setFilterSettings - Set filter/app settings
    
    Parameters:
    
    filter_settings - - JsonObject of fiter settings
  - addFilterSetting
```
public Sendgrid addFilterSetting(java.lang.String filter_name,
                                 java.lang.String parameter_name,
                                 java.lang.String parameter_value)
                          throws java.lang.Exception
```
    addFilterSetting - Append a filter setting to the list of filter settings
    
    Parameters:
    
    filter_name - filter name
    
    parameter_name - parameter name
    
    parameter_value - setting value
    
    Throws:
    
    java.lang.Exception
  - getHeaders
```
public JsonObject getHeaders()
```
    getHeaders - return the list of headers
    
    Returns:
    
    JsonObject with headers
  - setHeaders
```
public Sendgrid setHeaders(JsonObject key_value_pairs)
```
    setHeaders - Sets the list headers destroys previous header data
    
    Parameters:
    
    key_value_pairs - the list of header data
    
    Returns:
    
    the SendGrid object.
  - getServerResponse
```
public java.lang.String getServerResponse()
```
    getServerResponse - Get the server response message
    
    Returns:
    
    The server response message
  - _arrayToUrlPart
```
protected java.lang.String _arrayToUrlPart(java.util.ArrayList<java.lang.String> array,
                                           java.lang.String token)
```
    _arrayToUrlPart - Converts an ArrayList to a url friendly string
    
    Parameters:
    
    array - the array to convert
    
    token - the name of parameter
    
    Returns:
    
    a url part that can be concatenated to a url request
  - _prepMessageData
```
protected java.util.Map<java.lang.String,java.lang.String> _prepMessageData()
                                                                     throws java.lang.Exception
```
    _prepMessageData - Takes the mail message and returns a url friendly querystring
    
    Returns:
    
    the data query string to be posted
    
    Throws:
    
    java.lang.Exception
  - send
```
public void send()
          throws java.lang.Exception
```
    send - Send an email
    
    Throws:
    
    java.lang.Exception
  - send
```
public void send(Sendgrid.WarningListener w)
          throws java.lang.Exception
```
    send - Send an email
    
    Parameters:
    
    w - callback that will receive warnings
    
    Throws:
    
    java.lang.Exception

Class Sendgrid

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

use_headers

domain

endpoint

username

token

password

Constructor Detail

Sendgrid

Method Detail

setTransport

getTos

setTo

addTo

addTo

getToNames

getFrom

setFrom

getFromName

setFromName

getReplyTo

setReplyTo

getBccs

setBcc

getCcs

setCc

getSubject

setSubject

getText

setText

getHtml

setHtml

setCategories

setCategory

addCategory

setSubstitutions

addSubstitution

setSections

addSection

setUniqueArguments

addUniqueArgument

setFilterSettings

addFilterSetting

getHeaders

setHeaders

getServerResponse

_arrayToUrlPart

_prepMessageData

send

send