Mailgun is an email automation service provided by Rackspace, for developers. It offers a complete cloud-based email service for sending, receiving and tracking emails sent through your websites and applications.
Please note that terms used in the Mailgun channel categories are Mailgun specific terminology.
How to create a Mailgun account
You need to create a Mailgun account before you get started wth your Mailgun channel. To create an account in Mailgun, navigate to https://www.mailgun.com/ and click on the large red Start Sending button. To create a free account, complete the following steps:
- Enter your information.
- Use your company email.
- Enter a password.
- Uncheck Add payment info now.
- Check I’m not a robot.
- Respond to verification email.
The free account limits you to five authorized recipients. An email is sent to each address you add and the addresses will need to be verified. A paid version allow you to send up to 5000 emails.
How to connect
- On the My pipelines page, click Create a pipeline. Enter name, description, and tag fields and click the Create Pipelines button. The pipelines wizard displays:
- From the wizard you choose the connections for the first steps of your pipeline. When you choose a type, you'll add the channels and steps for your first steps. You can always add more steps later. A Triggered pipeline is started by a specific event in real-time. A Scheduled pipeline will start according to a schedule. A Manual pipeline only starts manually. Once you've completed the wizard, you'll be prompted for connection detail, if necessary. If you are an experienced builder, click the Start from scratch button and then from the right side of the page, choose the All to list all available channels.
- Expand Mailgun in the list of channels on the right side of the page and click Connect to Mailgun.
- In the pop-up window, select your Account Type, API key, and the webhook key which you in Settings under the API Keys section in Mailgun
- When finished click Connect to Mailgun.
How to reconnect the Mailgun channel
You may need to reconnect your account to a channel. Reasons may be (but not limited to):
If you need to connect a different account.
Authorization updates, such as a changed password.
Editing the access rights that Pipelines has to the channel.
- Select a pipeline that already has Mailgun in it.
- Open a step containing Mailgun.
- Under account, select Connect (or reconnect) and follow the process above, How to connect.
The steps you can use with Mailgun are grouped into five categories:
- Mailing List Members
- Mailing Lists
Note: You cannot use jinja expressions in trigger conditions unless explicitly specified as possible.
|Query||Search a Domain||Searches and returns a list of domains based on search criteria.|
|Action||Look Up a Domain||Looks for a particular domain based on specific criteria. To be able to use Mailgun in production, your custom domains has to be created and verified with Mailgun.|
|Mailing List Members|
|Action||Create Mailing List Member||Creates a member to a specific mailing list.|
|Action||Update Mailing List Member||Updates the information for a mailing list member|
|Action||Delete Mailing List Member||Deletes a mailing list member in your account.|
|Query||Search a Mailing List Member||Searches for mailing list members and returns a list based on search criteria.|
|Action||Lookup a Mailing List Member||Looks for a specific user using search criteria.|
|Action||Create a Tag||Creates a tag.|
|Action||Update Tag||Updates a tag.|
|Action||Delete Tag||Deletes a specific tag.|
|Query||Search a Tag||Searches and returns a list based on search criteria.|
|Action||Lookup a Tag||Looks for a particular tag based on search criteria.|
|Action||Create a Template||Creates a template in the specified account. Message templates allow you to create HTML templates on Mailgun's platform so that you can simply reference the template during your send.|
|Action||Update Template||Updates the metadata information of a template specified in the url.|
|Action||Delete Template||Deletes a template in the specified account.|
|Query||Search a Template||Searches for a template based on search criteria and returns a list.|
|Action||Lookup a Template||Looks up metadata information about a stored template specified in the url.|
|Trigger||On Inbound Email||Triggers when a new inbound email is received for the specified domain and account.|
|Action||Send an Email||Sends an email from the specified account. You can send emails to individual email address, or to lists utilizing the list email.|
|Trigger||On clicked||Triggers when an email is clicked in the specified Account and Domain. Click tracking must be enabled in the Mailgun control panel|
|Trigger||On complained||Triggers when there is a SPAM complaint, when the email recipient has clicked on the spam complaint button. Feedback loops enable the notification to be received by Mailgun.|
|Trigger||On delivered||Triggers when a new email is delivered. This means that Mailgun sent the email and it was accepted by the recipient email server.|
|Trigger||On opened||Triggers when an email is opened. This means that the email recipient opened the email and enabled image viewing. Open tracking must be enabled in the Mailgun control panel.|
|Trigger||On permanent fail||Triggers when there is a permanent failure delivering an email. This means that Mailgun could not deliver the email to the recipient email server, and Mailgun will stop attempting to deliver the message.|
|Trigger||On temporary fail||Triggers when there is a temporary failure delivering an email.|
|Trigger||On unsubscribed||Triggers when an email unsubscribe event happens. This means that the email recipient clicked on the unsubscribe link. Unsubscribe tracking must be enabled in the Mailgun control panel.|
|Query||Search a Event||Searches events in a given account and domain and returns a list based on search criteria.|
|Action||Create Mailing List||Creates a new mailing list in the specified account. A mailing list is a group of members (recipients) which itself has an email address, like firstname.lastname@example.org. This address becomes an ID for this mailing list.|
|Action||Update Mailing List||Updates an existing mailing list in the specified account.|
|Action||Delete Mailing List||Deletes a mailing list in the specified account.|
|Query||Search a Mailing List||Searches a mailing list and returns a list based on search criteria.|
|Action||Lookup a Mailing List||Looks for a specific list matching the search criteria.|
Examples using Mailgun
Here are two case use examples of using Mailgun.
Emailing from Quickbase
You can use Mailgun to send out custom, personalized emails to individuals. These forms can be customized to include the necessary fields that are needed to be populated with in the pipeline. In this example, an email will be sent as a follow up to an activity posted to a customer's record. Here is an example of this pipeline.
Create Mailing List
With Mailing Lists, you can create lists for your bulk emails. You an create these mailing lists within Quickbase and update them in Mailgun. For example, when a contact record is created, it can be associated to a specific campaign:
Once you've created this mailing list, you can send bulk emails to all contacts on the list, by sending an email to the “Campaign Address.”