Skip to main content

Developer README for the mailgun adaptor

Source: https://github.com/OpenFn/adaptors/tree/main/packages/mailgun

Language Mailgun

Language Pack for building expressions and operations for working with the mailgun API.

mailgun-js on npm

Documentation​

Sample configuration​

{
  "domain": "http://mailgun.com/domain",
  "apiKey": "mailgunapikey"
}

send​

send(
  fields(
    field('from', 'from_email'),
    field('to', 'to_email'),
    field('subject', 'Your Subject'),
    field('text', 'Your message goes here')
  )
);

Development​

Clone the adaptors monorepo. Follow the Getting Started guide inside to get set up.

Run tests using pnpm run test or pnpm run test:watch

Build the project using pnpm build.

To just build the docs run pnpm build docs