PostmarkProtocol

Class PostmarkProtocol

WEB-INF.cftags.component
        coldbox.system.core.mail.AbstractProtocol
            coldbox.system.core.mail.protocols.PostmarkProtocol

Class Attributes:

output : false

A mail protocol that sends via http://postmarkapp.com/

Constructor Summary
init([any properties='[runtime expression]']) Constructor.

Method Summary
`private struct`	encodeAttachment(struct MailParam) I encode an attachment so that PostMark likes it.
`private struct`	encodeHeader(struct MailParam) I encode named headers so that PostMark likes it.
`private string`	getFileMimeType(string filePath) I calculate the MIME type for a given file.
`private struct`	reformatPostMarkResponse(struct PostMarkReturnStruct) I format the PostMarkApp return result into one which conforms to the coldbox mailer service.
`struct`	send(Mail mail) Send an email payload.

Methods inherited from class `coldbox.system.core.mail.AbstractProtocol`
getProperties, getProperty, propertyExists, setProperties, setProperty

Methods inherited from class `WEB-INF.cftags.component`
None

Constructor Detail

public init([any properties='[runtime expression]'])

Constructor

Parameters:: properties - A map of configuration properties for the protocol

Method Detail

private struct encodeAttachment(struct MailParam)

I encode an attachment so that PostMark likes it.

private struct encodeHeader(struct MailParam)

I encode named headers so that PostMark likes it

private string getFileMimeType(string filePath)

I calculate the MIME type for a given file.

private struct reformatPostMarkResponse(struct PostMarkReturnStruct)

I format the PostMarkApp return result into one which conforms to the coldbox mailer service.

Parameters:: PostMarkReturnStruct - I'm the returned structure from postmark

public struct send(Mail mail)

Send an email payload. Returns a struct: [error:boolean,errorArray:array,messageid:string]