ericleversen / mailgun.cfc

mailgun.cfc

mailguncfc

A CFML wrapper for the MailGun API

This project borrows heavily from the API framework built by jcberquist with stripecfc.

Your account credentials can be found on the dashboard of your Mailgun account: https://mailgun.com/app/dashboard.

Currently both your Secret API Key and your Public API Key must be provided. The Secret API Key is used for most operations. In prior versions, email validation calls used the Public API Key. However, now that Mailgun has moved to a usage based pricing model for their email validation, the default for email validation calls is also to use the Secret API Key. The Public API Key requirement will likely be removed in later versions. It's currently included, so that calls can explicitly be made to the public endpoint of the email validation API.

Getting Started

mailGun = new com.mailgun( secretApiKey = 'key-xxx', publicApiKey = 'pubkey-xxx', domain = 'yourdomain.com', baseUrl = 'https://api.mailgun.net/v3' );

Available Methods

Note that the Mailgun API has more methods available. This is a list of those currently available in this wrapper. I'll be adding more as time permits and needs dictate.

Validation: https://documentation.mailgun.com/api-email-validation.html

validate( required string address, boolean mailbox_verification = false, boolean private = true )

Messages: https://documentation.mailgun.com/api-sending.html

sendMessage( string domain = variables.domain, required string from, required string to, string cc, string bcc, string subject, string text = "", string html = "", any attachment, any inline, struct o = { }, struct h = { }, struct v = { } )

getStoredMessage( required string messageUrl )

Supressions: https://documentation.mailgun.com/api-suppressions.html

getBounces( string domain = variables.domain, numeric limit = 100 )

Stats: https://documentation.mailgun.com/en/latest/api-stats.html

getStats( string domain = variables.domain, required string event, date start = '#now()#-7', date end = '#now()#', string resolution = 'day', string duration )

Mailing Lists: https://documentation.mailgun.com/api-mailinglists.html

getLists()

getList( required string listaddress, numeric limit = 100, numeric skip = 0 )

createList( required string address, string name = "", string description = "", access_level = "readonly" )

createListMember( required string listaddress, required string address, string name, string vars, boolean subscribed = true, boolean upsert = false )

createListMembers( required string listaddress, required json members, boolean upsert = false )

Changelog

2017-11-13

Added

• Method getStoredMessage(), to retrieve an inbound message that has been stored via the Mailgun's store() action, using the URL found in the stored event
• Option getStats(), to return a domain's event statistics

2017-07-09

Added

• Option mailbox_verification, to validate(), to enable a mailbox verification check to be performed against the address.
• Option private, to validate(), to override default and call public API endpoint

Changed

• validate() now defaults to the private API endpoint

2016-12-29

Thanks @mjhagen

Added

• Two list management functions:
• createList()
• createListMembers()

Changed

• Expanded the error reporting by deserializing the returned message and adding that to the error detail.