mailgun

Send a success/error message to an email group

mailgun
Supported platforms ios, android, mac
Author @thiagolioy

2 Examples

mailgun(
  to: "fastlane@krausefx.com",
  success: true,
  message: "This is the mail's content"
)
mailgun(
  postmaster: "MY_POSTMASTER",
  apikey: "MY_API_KEY",
  to: "DESTINATION_EMAIL",
  from: "EMAIL_FROM_NAME",
  reply_to: "EMAIL_REPLY_TO",
  success: true,
  message: "Mail Body",
  app_link: "http://www.myapplink.com",
  ci_build_link: "http://www.mycibuildlink.com",
  template_path: "HTML_TEMPLATE_PATH",
  custom_placeholders: {
    :var1 => 123,
    :var2 => "string"
  },
  attachment: "dirname/filename.ext"
)

Parameters

Key Description Default
mailgun_sandbox_domain Mailgun sandbox domain postmaster for your mail. Please use postmaster instead
mailgun_sandbox_postmaster Mailgun sandbox domain postmaster for your mail. Please use postmaster instead
mailgun_apikey Mailgun apikey for your mail. Please use postmaster instead
postmaster Mailgun sandbox domain postmaster for your mail
apikey Mailgun apikey for your mail
to Destination of your mail
from Mailgun sender name Mailgun Sandbox
message Message of your mail
subject Subject of your mail fastlane build
success Was this build successful? (true/false) true
app_link App Release link
ci_build_link CI Build Link
template_path Mail HTML template
reply_to Mail Reply to
attachment Mail Attachment filenames, either an array or just one string
custom_placeholders Placeholders for template given as a hash {}

* = default value is dependent on the user's system


Documentation

To show the documentation in your terminal, run

fastlane action mailgun

CLI

It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run mailgun

To pass parameters, make use of the : symbol, for example

fastlane run mailgun parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primative types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.


Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub


Back to actions