Parse JavaScript Classes

Cloud Modules

Namespace Mailgun

Cloud Module for using Mailgun.

To use this Cloud Module in Cloud Code, start by requiring the mailgun module and initializing it using your Mailgun domain name and api key.
var Mailgun = require('mailgun');
Mailgun.initialize('myDomainName','myApiKey');
You can then start using the module in your Cloud Code functions.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Mailgun Cloud Module
Method Summary
Method Attributes Method Name and Description
<static>  
Mailgun.initialize(domainName, apiKey)
Initialize the Mailgun module with the proper credentials
<static>  
Mailgun.sendEmail(params, options)
Send an email using Mailgun
Namespace Detail
Mailgun
Mailgun Cloud Module
Method Detail
<static> Mailgun.initialize(domainName, apiKey)
Initialize the Mailgun module with the proper credentials
Parameters:
{String} domainName
Your Mailgun domain name
{String} apiKey
Your Mailgun api key

<static> {Parse.Promise} Mailgun.sendEmail(params, options)
Send an email using Mailgun
Parameters:
{Object} params
A hash of the paramaters to be passed to the Mailgun API. They are passed as-is, so you should consult Mailgun's documentation to ensure they are valid.
{Object} options
A hash with the success and error callback functions under the keys 'success' and 'error' respectively.
Returns:
{Parse.Promise}

Documentation generated by JsDoc Toolkit.