de.grobmeier.postmark

Class PostmarkClient

java.lang.Object

de.grobmeier.postmark.PostmarkClient

public class PostmarkClient
extends Object

Class that does the heavy lifting

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_ENDPOINT

Constructor Summary

Constructors

Constructor and Description
PostmarkClient(String serverToken) Initializes a new instance of the PostmarkClient class.
PostmarkClient(String serverToken, String serverPath) Initializes a new instance of the PostmarkClient class.

Method Summary

Modifier and Type	Method and Description
PostmarkResponse	sendMessage(PostmarkMessage message) Sends a message through the Postmark API.
PostmarkResponse	sendMessage(PostmarkTemplate templateMessage) Sends a template message through the Postmark API.
PostmarkResponse	sendMessage(String from, String to, String replyTo, String cc, String subject, String body, boolean isHTML, String tag) Sends a message through the Postmark API.
PostmarkResponse	sendMessage(String from, String to, String replyTo, String cc, String subject, String body, boolean isHTML, String tag, List<NameValuePair> headers) Sends a message through the Postmark API.
PostmarkResponse	sendMessage(String from, String to, String replyTo, String cc, String bcc, String subject, String body, boolean isHTML, String tag, List<NameValuePair> headers) Sends a message through the Postmark API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

API_ENDPOINT

public static final String API_ENDPOINT

See Also:

Constant Field Values

Constructor Detail

PostmarkClient

public PostmarkClient(String serverToken)

Initializes a new instance of the PostmarkClient class. If you do not have a server token you can request one by signing up to use Postmark: http://postmarkapp.com.

Parameters:

serverToken - the postmark server token

PostmarkClient

public PostmarkClient(String serverToken,
                      String serverPath)

Initializes a new instance of the PostmarkClient class. If you do not have a server token you can request one by signing up to use Postmark: http://postmarkapp.com.

Parameters:

serverToken - the postmark server token

serverPath - an alternative server path e.g https://api.postmarkapp.com

Method Detail

sendMessage

public PostmarkResponse sendMessage(String from,
                                    String to,
                                    String replyTo,
                                    String cc,
                                    String subject,
                                    String body,
                                    boolean isHTML,
                                    String tag)
                             throws PostmarkException

Sends a message through the Postmark API. All email addresses must be valid, and the sender must be a valid sender signature according to Postmark. To obtain a valid sender signature, log in to Postmark and navigate to: http://postmarkapp.com/signatures.

Parameters:

from - An email address for a sender

to - An email address for a recipient

replyTo - An email address for the reply-to

cc - An email address for CC

subject - The message subject line

body - The message body

isHTML - Is the body text HTML

tag - A tag to identify the message in postmark

Returns:

PostmarkResponse with details about the transaction

Throws:

PostmarkException - when something goes wrong

sendMessage

public PostmarkResponse sendMessage(String from,
                                    String to,
                                    String replyTo,
                                    String cc,
                                    String subject,
                                    String body,
                                    boolean isHTML,
                                    String tag,
                                    List<NameValuePair> headers)
                             throws PostmarkException

Sends a message through the Postmark API. All email addresses must be valid, and the sender must be a valid sender signature according to Postmark. To obtain a valid sender signature, log in to Postmark and navigate to: http://postmarkapp.com/signatures.

Parameters:

from - An email address for a sender

to - An email address for a recipient

replyTo - An email address for the reply-to

cc - An email address for CC

subject - The message subject line

body - The message body

isHTML - Is the body text HTML

tag - A tag to identify the message in postmark

headers - A collection of additional mail headers to send with the message

Returns:

PostmarkResponse with details about the transaction

Throws:

PostmarkException - when something goes wrong

sendMessage

public PostmarkResponse sendMessage(String from,
                                    String to,
                                    String replyTo,
                                    String cc,
                                    String bcc,
                                    String subject,
                                    String body,
                                    boolean isHTML,
                                    String tag,
                                    List<NameValuePair> headers)
                             throws PostmarkException

Sends a message through the Postmark API. All email addresses must be valid, and the sender must be a valid sender signature according to Postmark. To obtain a valid sender signature, log in to Postmark and navigate to: http://postmarkapp.com/signatures.

Parameters:

from - An email address for a sender

to - An email address for a recipient

replyTo - An email address for the reply-to

cc - An email address for CC

bcc - An email address for BCC

subject - The message subject line

body - The message body

isHTML - Is the body text HTML

tag - A tag to identify the message in postmark

headers - A collection of additional mail headers to send with the message

Returns:

PostmarkResponse with details about the transaction

Throws:

PostmarkException - when something goes wrong

sendMessage

public PostmarkResponse sendMessage(PostmarkTemplate templateMessage)
                             throws PostmarkException

Sends a template message through the Postmark API. All email addresses must be valid, and the sender must be a valid sender signature according to Postmark. To obtain a valid sender signature, log in to Postmark and navigate to: http://postmarkapp.com/signatures.

Parameters:

templateMessage - A prepared template message instance.

Returns:

A response object

Throws:

PostmarkException - when something goes wrong

sendMessage

public PostmarkResponse sendMessage(PostmarkMessage message)
                             throws PostmarkException

Sends a message through the Postmark API. All email addresses must be valid, and the sender must be a valid sender signature according to Postmark. To obtain a valid sender signature, log in to Postmark and navigate to: http://postmarkapp.com/signatures.

Parameters:

message - A prepared message instance.

Returns:

A response object

Throws:

PostmarkException - when something goes wrong