Transfer

Content

Installation

Demo

Configuration

constMailgun=require('mailgun.js');constformData=require('form-data');const{ ApiPayloadConverter}=require('parse-server-api-mail-adapter');// Configure mail clientconstmailgun=newMailgun(formData);constmailgunClient=mailgun.client({username:'api',key:process.env.MAILGUN_API_KEY});constmailgunDomain=process.env.MAILGUN_DOMAIN;// Configure Parse Serverconstserver=newParseServer({    ...otherServerOptions,emailAdapter:{module:'parse-server-api-mail-adapter',options:{// The email address from which emails are sent.sender:'sender@example.com',// The email templates.templates:{// The template used by Parse Server to send an email for password// reset; this is a reserved template name.passwordResetEmail:{subjectPath:'./files/password_reset_email_subject.txt',textPath:'./files/password_reset_email.txt',htmlPath:'./files/password_reset_email.html'},// The template used by Parse Server to send an email for email// address verification; this is a reserved template name.verificationEmail:{subjectPath:'./files/verification_email_subject.txt',textPath:'./files/verification_email.txt',htmlPath:'./files/verification_email.html'},// A custom email template that can be used when sending emails// from Cloud Code; the template name can be chosen freely; it// is possible to add various custom templates.customEmail:{subjectPath:'./files/custom_email_subject.txt',textPath:'./files/custom_email.txt',htmlPath:'./files/custom_email.html',// Placeholders are filled into the template file contents.// For example, the placeholder `{{appName}}` in the email// will be replaced the value defined here.placeholders:{appName:"ExampleApp"},// Extras to add to the email payload that is accessible in the// `apiCallback`.extra:{replyTo:'no-reply@example.com'},// A callback that makes the Parse User accessible and allows// to return user-customized placeholders that will override// the default template placeholders. It also makes the user// locale accessible, if it was returned by the `localeCallback`,// and the current placeholders that will be augmented.placeholderCallback:async({ user, locale, placeholders})=>{return{phone:user.get('phone');};},// A callback that makes the Parse User accessible and allows// to return the locale of the user for template localization.localeCallback:async(user)=>{returnuser.get('locale');}}},// The asynchronous callback that contains the composed email payload to// be passed on to an 3rd party API and optional meta data. The payload// may need to be converted specifically for the API; conversion for// common APIs is conveniently available in the `ApiPayloadConverter`.// Below is an example for the Mailgun client.apiCallback:async({ payload, locale})=>{constmailgunPayload=ApiPayloadConverter.mailgun(payload);awaitmailgunClient.messages.create(mailgunDomain,mailgunPayload);}}}});

Templates

templates:{exampleTemplate:{subjectPath:'./files/custom_email_subject.txt',textPath:'./files/custom_email.txt',htmlPath:'./files/custom_email.html',}},

Placeholders

Password Reset and Email Verification

Localization

base/├──example.html// default file└──de/// de language folder│└──example.html// de localized file└──de-AT/// de-AT locale folder│└──example.html// de-AT localized file

Cloud Code

Example

Parse.Cloud.sendEmail({templateName:"next_level_email",placeholders:{gameScore:100,nextLevel:2},user:parseUser// user with email address});

Parameters

Supported APIs

Providers

Caution

The code examples below may show sensitive data such as API keys to be stored as environment variables. This is not a recommended practice and only used for simplicity to demonstrate how an adapter can be set up for development.

AWS Simple Email Service

const{SES, SendEmailCommand}=require('@aws-sdk/client-ses');const{// Get credentials via IMDS from the AWS instance (when deployed on AWS instance)  fromInstanceMetadata,// Get AWS credentials from environment variables (when testing locally)  fromEnv,}=require('@aws-sdk/credential-providers');// Get AWS credentials depending on environmentconstcredentialProvider=process.env.NODE_ENV=='production' ?fromInstanceMetadata() :fromEnv();constcredentials=awaitcredentialProvider();// Configure mail clientconstsesClient=newSES({    credentials,region:'eu-west-1',apiVersion:'2010-12-01'});// Configure Parse Serverconstserver=newParseServer({// ... other server optionsemailAdapter:{module:'parse-server-api-mail-adapter',options:{// ... other adapter optionsapiCallback:async({ payload, locale})=>{constawsSesPayload=ApiPayloadConverter.awsSes(payload);constcommand=newSendEmailCommand(awsSesPayload);awaitsesClient.send(command);}}}});

Mailgun

// Configure mail clientconstmailgun=require('mailgun.js');constmailgunClient=mailgun.client({username:'api',key:process.env.MAILGUN_API_KEY});constmailgunDomain=process.env.MAILGUN_DOMAIN;// Configure Parse Serverconstserver=newParseServer({// ... other server optionsemailAdapter:{module:'parse-server-api-mail-adapter',options:{// ... other adapter optionsapiCallback:async({ payload, locale})=>{constmailgunPayload=ApiPayloadConverter.mailgun(payload);awaitmailgunClient.messages.create(mailgunDomain,mailgunPayload);}}}});

ZeptoMail

const{ SendMailClient}=require('zeptomail');// Configure mail clientconsturl=process.env.ZEPTOMAIL_URL;consttoken=process.env.ZEPTOMAIL_TOKEN;constzeptoMaiClient=newSendMailClient({ url, token});// Configure Parse Serverconstserver=newParseServer({// ... other server optionsemailAdapter:{module:'parse-server-api-mail-adapter',options:{// ... other adapter optionsapiCallback:async({ payload, locale})=>{constzeptoMailPayload=ApiPayloadConverter.zeptomail({api:'1.1', payload});awaitzeptoMaiClient.sendMail(zeptoMailPayload);},}}});

Custom API

// Configure mail clientconstcustomMail=require('customMail.js');constcustomMailClient=customMail.configure({ ...});// Configure Parse Serverconstserver=newParseServer({// ... other server optionsemailAdapter:{module:'parse-server-api-mail-adapter',options:{// ... other adapter optionsapiCallback:async({ payload, locale})=>{constcustomPayload={customFrom:payload.from,customTo:payload.to,customSubject:payload.subject,customText:payload.text};awaitcustomMailClient.sendEmail(customPayload);}}}});