A Meteor wrapper for the MailChimp API.
See also these wrappers:
- node-mailchimp - A node.js wrapper for the MailChimp API
miro:mailchimp provides MailChimp API v2.0 (v3.0 not ready yet!) features to your Meteor application.
Install using Meteor:
meteor add miro:mailchimpNOTE: starting with v1.1.0 the template
MailChimpListSubscribeis NOT included in the package anymore BUT the template helpers and event handlers ARE! In other words, you can copy the old template from the example folder within the package or copy it from here,...
<!-- Bootstrap example -->
<template name="MailChimpListSubscribe">
<form class="form-inline">
{{#if message}}
<p class="mailchimp-message">{{{message}}}</p>
{{/if}}
<div class="form-group">
<input class="mailchimp-email form-control" type="email" placeholder="[email protected]"/>
<input type="submit" value="Subscribe" class="mailchimp-subscribe btn btn-success" />
</div>
</form>
</template>...include it in your code and customize it as you wish; it will be inherently functional as long as its name remains
MailChimpListSubscribeand it contains all template expressions and CSS classes (apart from bootstrap ones, of course) as the original example has.
Include it in some other template as needed:
<div id="subscribeForm">
{{> MailChimpListSubscribe}}
</div>Finally, put in your server's settings.json:
{
"private": {
"MailChimp": {
"apiKey": "<Your MailChimp API Key>",
"listId": "<ID of your default mailing list>"
}
}
}and start your server with:
meteor --settings=settings.jsonMailChimp takes two arguments. The first argument is your API key, which you can find in your MailChimp Account. The second argument is an options object which can contain the following option:
versionThe API version to use. Defaults to 2.0.
All of the API categories and methods described in the MailChimp API v2.0 Documentation are available in this wrapper both server- and client-side.
To use them, the method call is used which takes four parameters:
sectionThe section of the API method to call (e.g. 'campaigns').methodThe method to call in the given section.paramsParameters to pass to the API method.callback(optional server-side, required client-side) Callback function for returned data or errors with two parameters. The first one being an error object which is null when no error occured, the second one an object with all information retrieved as long as no error occured.
NOTE: If
callbackis ommited server-side, the method runs "synchronously" viaMeteor.wrapAsyncmethod.
// You can as well pass different parameters on each call
var mailChimp = new MailChimp( /* apiKey, { version: '2.0' } */ );
mailChimp.call( 'campaigns', 'list', {
start: 0,
limit: 25
},
// Callback beauty in action
function ( error, result ) {
if ( error ) {
console.error( '[MailChimp][Campaigns][List] Error: %o', error );
} else {
// Do something with your data!
console.info( '[MailChimp][Campaigns][List]: %o', result );
}
}
);// You can as well pass different parameters on each call
var mailChimp = new MailChimp( /* apiKey, { version: '2.0' } */ );
var result = mailChimp.call( 'campaigns', 'list', {
start: 0,
limit: 25
});
// Do something with your data!
console.info( '[MailChimp][Campaigns][List]: %o', result );- Removed subscribe template (moved to example folder) so it can be customized
- Some bug fixes
- Reinstated server-side callback in case someone still wants to use it instead
of
Meteor.wrapAsyncmethod (#19) - Updated documentation (README.md)
- Fixed bug with
Meteor.wrapAsyncnot returning real error (#16) - Fixed bug with
audit-argument-checkspackage throwing 'Did not check()' error (#15)
- Bumped version number
- README.md fix
- Update to Meteor v1.0
- Bug fixes
- Cleanup
- Fixed typo in README.md
- Updated README.md to reflect changes in v0.4.0
- Introduce settings.json for MailChimpOptions
- If already subscribed show different message then success message
- Enable submit with return key
- On client, MailChimp.call() now reads API Key from session variable 'MailChimpOptions.apiKey' as well
- Initial release
Copyright © 2014-1015 Miroslav Hibler
miro:mailchimp is licensed under the MIT license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent