Mailgun API - Mailgun api implementation for Meteor.
v0.5.0 - Send no longer returns a future
Meteor wrapper for mailgun-js This module wraps base functionality you'd want from the mailgun.api. Use this if you want to abstract away raw mailgun api useage. Feel free to add more wrapper methods and submit them via pull request. The instance of the npm module lives in Mailgun.api so use that for calling methods in https://github.com/1lobby/mailgun-js
There is a example application deployed at meteor.com source
Install this package using meteor
meteor add gfk:mailgun-api
Instantiate:
var options = {
apiKey: 'ablalbadjkfga',
domain: 'www.pleasegiveuslotsofmoney.com'
}
var NigerianPrinceGun = new Mailgun(options);
NigerianPrinceGun.send({
'to': 'test@test.com',
'from': 'no-reply@test.com',
'html': '<html><head></head><body>This is a test</body></html>',
'text': 'This is a test',
'subject': 'testSubject',
'tags': [
'some',
'test',
'tags'
]
});The reference to the npm package lives in .api for example:
NigerianPrinceGun.api.lists('mylist@mydomain.com').info().then(function (data) {
console.log(data);
}, function (err) {
console.log(err);
});See the mailgun-js npm page for more info mailgun-js
Currently the wrapper does not wrap the attachment system of mailgun-js I plan on implementing this later #3. As a work around until I get around to implementing attachment support you can use the following code:
var MailgunInstance = new Mailgun(mailgunOptions);
var readFile = Meteor.wrapAsync(Npm.require('fs').readFile)
var path = Npm.require('path');
var filename = 'mailgun_logo.png';
var filepath = path.join(__dirname, filename);
var file = readFile(filepath);
var attch = new MailgunInstance.api.Attachment({data: file, filename: filename});
var data = {
from: 'Excited User <me@samples.mailgun.org>',
to: 'serobnic@mail.ru',
subject: 'Hello',
text: 'Testing some Mailgun awesomness!',
attachment: attch
};
mailgunInstance.send(data);
Constructs a new instance of the mailgun wrapper
- Object options
- String options.apiKey The api key to use in communication with mailgun
- String options.domain The domain to use in communication with mailgun
send(emailObject, [emailObject.to], [emailObject.cc], [emailObject.bcc], [emailObject.html], [emailObject.text], [emailObject.subject], [emailObject.tags], options, [options.testmode], [options.saveEmailTo])
Sends the email to mailgun
- Object emailObject
- String [emailObject.to] Address to which to sent the email
- String [emailObject.cc] Address to which to cc the email
- String [emailObject.bcc] Address to which to bcc the email
- String [emailObject.html] The html version of the email
- String [emailObject.text] The text version of the email
- String [emailObject.subject] the subject of the email
- Array [emailObject.tags] Tags to sent to mailgun
- Object options [options={}] The options to use for sending the email
- String [options.testmode] Adds mailgun testmode parameter
- String [options.saveEmailTo] Specifies the location to save a copy of the html email to. Tries to create the directories if they don't exist yet
Checks events for the given filter.
- Object filter [filter={}] The filter to use for retrieving the events see: http://documentation.mailgun.com/api-events.html#filter-field
- Date|String [filter.beginDate] The beginning of the time range to select log records from. By default it is the time of the request
- Date|String [filter.endDate] The end of the time range and the direction of the log record traversal. If end is less than begin, then traversal is performed in the timestamp descending order, otherwise in timestamp ascending order. By default, if ascending is yes, then it is a date in the distant future, otherwise a date in the distant past.
- Boolean [filter.ascending=false] The direction of log record traversal. If end is also specified, then the relation between begin and end should agree with the ascending value, otherwise an error will be returned. The default value is deduced from the begin and end relation. If end is not specified, then the value is no, effectively defining traversal direction from begin, to the past, until the end of time.
- Boolean [filter.pretty=true] Defaults to true on the server
Iterates over the events found with the given filter and calls the appropiate handler for each event.
- Object filter [filter={}] The filter to use for retrieving the events see: http://documentation.mailgun.com/api-events.html#filter-field
- Object eventHandlers hold handlers for the different eventTypes
- Function eventHandlers.before [eventHandlers.before] Handler to be executed on all events before the actual handler is executed
- Function eventHandlers.accepted [eventHandlers.accepted] Handler executed on accepted event
- Function eventHandlers.rejected [eventHandlers.rejected] Handler executed on rejected event
- Function eventHandlers.delivered [eventHandlers.delivered] Handler executed on delivered event
- Function eventHandlers.failed [eventHandlers.failed] Handler executed on failed event
- Function eventHandlers.openend [eventHandlers.openend] Handler executed on openend event
- Function eventHandlers.clicked [eventHandlers.clicked] Handler executed on clicked event
- Function eventHandlers.unsubscribed [eventHandlers.unsubscribed] Handler executed on unsubscribed event
- Function eventHandlers.complained [eventHandlers.complained] Handler executed on complained event
- Function eventHandlers.stored [eventHandlers.stored] Handler executed on stored event
www.pleasegiveuslotsofmoney.com as domain maybe a bit obvious.
Any contributions are welcome. Please create an issue on github to start a discussion about the contribution you're planning to make.