• Installs:
  • Today: 99
  • All Time: 12606
Developer:userzakutynsky
Readme

MailGun

MailGun Package

Use the MailGun API to access the product's features, such as sending E-Mails, webhooks, Email Validation etc.

  • Domain: MailGun
  • Credentials: apiKey

How to get credentials:

  1. Go to MailGun website.
  2. Register or log in.
  3. Go to Domains tab.
  4. Create or select domain.
  5. Copy domain name and apiKey

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

MailGun.sendEmail

Sends an email.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
fromStringEmail address for From header.
toListEmail address of the recipient(s). ('Bob [email protected]'). You can use commas to separate multiple recipients.
ccListSame as 'To' but for Cc.
bccListSame as 'To' but for Bcc.
subjectStringMessage subject.
textStringBody of the message. (text version).
htmlStringBody of the message. (HTML version).
inlineStringAttachment with inline disposition.
o:tagListTag string.
o:campaignStringId of the campaign the message belongs to. See um-campaign-analytics for details.
o:dkimSelectEnables/disables DKIM signatures on per-message basis. Pass yes or no.
o:deliverytimeDatePickerDesired time of delivery. See Date Format. Note: Messages can be scheduled for a maximum of 3 days in the future.
o:testmodeSelectEnables sending in test mode. Pass yes if needed. See Sending in Test Mode.
o:trackingSelectToggles tracking on a per-message basis, see Tracking Messages for details. Pass yes or no.
o:tracking-clicksSelectToggles clicks tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes, no or htmlonly.
o:tracking-opensSelectToggles opens tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes or no.
o:require-tlsBooleanThis requires the message only be sent over a TLS connection. (True or False)
o:skip-verificationBooleanIf set to True, the certificate and hostname will not be verified when trying to establish a TLS connection and Mailgun will accept any certificate during delivery.
h:X-My-HeaderStringh: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case).
v:my-varJSONv: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See Attaching Data to Messages for more information.

MailGun.sendEmailMIME

Posts a message in MIME format.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
fromStringEmail address for From header.
toListEmail address of the recipient(s). ('Bob [email protected]'). You can use commas to separate multiple recipients.
ccListSame as 'To' but for Cc.
bccListSame as 'To' but for Bcc.
subjectStringMessage subject.
textStringBody of the message. (text version).
htmlStringBody of the message. (HTML version).
inlineStringAttachment with inline disposition.
o:tagListTag string.
o:campaignStringId of the campaign the message belongs to. See um-campaign-analytics for details.
o:dkimSelectEnables/disables DKIM signatures on per-message basis. Pass yes or no.
o:deliverytimeDatePickerDesired time of delivery. See Date Format. Note: Messages can be scheduled for a maximum of 3 days in the future.
o:testmodeSelectEnables sending in test mode. Pass yes if needed. See Sending in Test Mode.
o:trackingSelectToggles tracking on a per-message basis, see Tracking Messages for details. Pass yes or no.
o:tracking-clicksSelectToggles clicks tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes, no or htmlonly.
o:tracking-opensSelectToggles opens tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes or no.
o:require-tlsBooleanThis requires the message only be sent over a TLS connection. (True or False)
o:skip-verificationBooleanIf set to True, the certificate and hostname will not be verified when trying to establish a TLS connection and Mailgun will accept any certificate during delivery.
h:X-My-HeaderStringh: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case).
v:my-varJSONv: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See Attaching Data to Messages for more information.

MailGun.getStoredMessages

Returns stored messages.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
beginDatePickerThe beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
endDatePickerThe end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
ascendingSelectDefines the direction of the search time range and must be provided if the range end time is not specified. Can be either yes or no.
limitNumberNumber of entries to return. (300 max)

MailGun.getAcceptedMessages

Returns accepted messages.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
beginDatePickerThe beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
endDatePickerThe end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
ascendingSelectDefines the direction of the search time range and must be provided if the range end time is not specified. Can be either yes or no.
limitNumberNumber of entries to return. (300 max)

MailGun.getRejectedMessages

Returns rejected messages.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
beginDatePickerThe beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
endDatePickerThe end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
ascendingSelectDefines the direction of the search time range and must be provided if the range end time is not specified. Can be either yes or no.
limitNumberNumber of entries to return. (300 max)

MailGun.getDeliveredMessages

Returns delivered messages.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
beginDatePickerThe beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
endDatePickerThe end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
ascendingSelectDefines the direction of the search time range and must be provided if the range end time is not specified. Can be either yes or no.
limitNumberNumber of entries to return. (300 max)

MailGun.getFailedMessages

Returns failed messages.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
beginDatePickerThe beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
endDatePickerThe end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
ascendingSelectDefines the direction of the search time range and must be provided if the range end time is not specified. Can be either yes or no.
limitNumberNumber of entries to return. (300 max)

MailGun.getOpenedMessages

Returns opened messages.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
beginDatePickerThe beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
endDatePickerThe end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
ascendingSelectDefines the direction of the search time range and must be provided if the range end time is not specified. Can be either yes or no.
limitNumberNumber of entries to return. (300 max)

MailGun.getClickedMessages

Returns clicked messages.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
beginDatePickerThe beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
endDatePickerThe end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
ascendingSelectDefines the direction of the search time range and must be provided if the range end time is not specified. Can be either yes or no.
limitNumberNumber of entries to return. (300 max)

MailGun.getUnsubscribedMessages

Returns unsubscribed messages.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
beginDatePickerThe beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
endDatePickerThe end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
ascendingSelectDefines the direction of the search time range and must be provided if the range end time is not specified. Can be either yes or no.
limitNumberNumber of entries to return. (300 max)

MailGun.getComplainedMessages

Returns complained messages.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
beginDatePickerThe beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
endDatePickerThe end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds.
ascendingSelectDefines the direction of the search time range and must be provided if the range end time is not specified. Can be either yes or no.
limitNumberNumber of entries to return. (300 max)

MailGun.getAllStats

Returns total stats for a given domain.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringMailgun account contain email domain.
eventStringThe type of the event.
startDatePickerThe starting time. Should be in unix epoch format.
endDatePickerThe ending date. Should be in unix epoch format.
resolutionSelectCan be either hour, day or month. Default: day
durationStringPeriod of time with resoluton encoded. Read more

MailGun.getEventStats

Returns a list of event stats items. Each record represents counts for one event per one day.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
limitNumberMaximum number of records to return. (100 by default)
skipNumberNumber of records to skip.
eventStringName of the event to receive the stats for. Note that you can specify this parameter multiple times to fetch stats for several events at the same time.
startDateStringThe date to receive the stats starting from. Should have ISO8601 format (YYYY-MM-DD).

MailGun.getAllTags

Returns a list of tags for a domain. Provides with the pagination urls if the result set is to long to be returned in a single response.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
limitNumberMaximum number of records to return. (100 by default)

MailGun.getSingleTag

Returns info for a given tag.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
tagStringName of the tag.

MailGun.updateTag

Updates a given tag with the information provided.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
tagStringName of the tag.
descriptionStringOptional description of a tag.

MailGun.getTagStats

Returns statistics for a given tag.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
tagStringName of the tag.
eventStringThe type of the event.
startDatePickerThe starting time. Should be in unix epoch format.
endDatePickerThe ending date. Should be in unix epoch format.
resolutionSelectCan be either hour, day or month. Default: day
durationStringPeriod of time with resoluton encoded. Read more

MailGun.deleteTag

Deletes the tag. The statistics for the tag are not destroyed.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
tagStringName of the tag.

MailGun.getAllBounces

Paginate over a list of bounces for a domain.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
limitNumberMaximum number of records to return (optional, default: 100, max: 10000)

MailGun.getSingleBounce

Fetch a single bounce event by a given email address. Useful to check if a given email address has bounced before.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
emailStringEmail address

MailGun.addBounce

Add a bounce record to the bounce list. Updates the existing record if the address is already there.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
addressStringValid email address
codeStringError code
errorStringError description (default: empty string)
createdAtStringTimestamp of a bounce event.

MailGun.addMultipleBounces

Add multiple bounce records to the bounce list in a single API call.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
bouncesArrayRecords to the bounce list.

MailGun.deleteBounce

Clears a given bounce event. The delivery to the deleted email address resumes until it bounces again.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
addressStringValid email address

MailGun.deleteBounceList

Clears all bounced email addresses for a domain. Delivery to the deleted email addresses will no longer be suppressed.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.

MailGun.getAllUnsubscribes

Paginate over a list of unsubscribes for a domain.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
limitNumberNumber of records to return (optional, default: 100, max: 10000).

MailGun.getSingleUnsubscribeRecord

Fetch a single unsubscribe record. Can be used to check if a given address is present in the list of unsubscribed users.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
addressStringValid email address

MailGun.addAddressToUnsubscribeTable

Add an address to the unsubscribe table.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
addressStringValid email address
tagStringTag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *)
createdAtStringTimestamp of a bounce event.

MailGun.deleteUnsubscribeRecords

Remove an address from the unsubscribes list. If tag parameter is not provided, completely removes an address from the list.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
addressStringValid email address
tagStringSpecific tag to remove.

MailGun.getAllComplaints

Paginate over a list of complaints for a domain.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
limitNumberMaximum number of records to return (optional, default: 100, max: 10000)

MailGun.getSingleComplaint

Fetch a single spam complaint by a given email address. This is useful to check if a particular user has complained.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
addressStringValid email address

MailGun.addSingleComplaint

Add an address to the complaints list.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
addressStringValid email address
createdAtStringTimestamp of a bounce event.

MailGun.deleteComplaint

Remove a given spam complaint.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
addressStringValid email address

MailGun.getAllRoutes

Fetches the list of routes. Note that routes are defined globally, per account, not per domain as most of other API calls.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
limitNumberMaximum number of records to return. (100 by default).
skipNumberNumber of records to skip. (0 by default).

MailGun.getSingleRoute

Returns a single route object based on its ID.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
routeIdStringID of the route.

MailGun.createRoute

Creates a new route.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
priorityNumberInteger: smaller number indicates higher priority. Higher priority routes are handled first. Defaults to 0.
descriptionStringAn arbitrary string.
expressionStringA filter expression like match_recipient('.*@gmail.com').
actionStringRoute action. This action is executed when the expression evaluates to True. Example: forward('[email protected]')

MailGun.updateRoute

Updates a given route by ID. All parameters are optional: this API call only updates the specified fields leaving others unchanged.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
routeIdStringID of the route.
priorityNumberInteger: smaller number indicates higher priority. Higher priority routes are handled first. Defaults to 0.
descriptionStringAn arbitrary string.
expressionStringA filter expression like match_recipient('.*@gmail.com').
actionStringRoute action. This action is executed when the expression evaluates to True. Example: forward('[email protected]')

MailGun.deleteRoute

Deletes a route based on the id.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
routeIdStringID of the route.

MailGun.getAllWebhooks

Returns a list of webhooks set for the specified domain.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.

MailGun.getSingleWebhook

Returns details about a the webhook specified in the URL.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
webhookNameStringName of the webhook.

MailGun.createWebhook

Creates a new webhook.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
idStringName of the webhook.
urlStringURL for the webhook event.

MailGun.updateWebhook

Updates an existing webhook.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
webhookNameStringName of the webhook.
idStringName of the webhook.
urlStringURL for the webhook event.

MailGun.deleteWebhook

Deletes an existing webhook.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
domainStringName of the domain.
webhookNameStringName of the webhook.

MailGun.getAllMailingLists

Paginate over mailing lists under your account.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
limitNumberMaximum number of records to return (optional, default: 100, max: 10000)

MailGun.getSingleMailingList

Returns a single mailing list by a given address.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
addressStringValid email address

MailGun.createMailingList

Creates a new mailing list.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
addressStringA valid email address for the mailing list, e.g. [email protected], or Developers [email protected]
nameStringMailing list name, e.g. Developers.
descriptionStringA description.
accessLevelStringList access level, one of: readonly (default), members, everyone

MailGun.updateMailingList

Update mailing list properties, such as address, description or name

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
emailStringA valid email address for the mailing list, e.g. [email protected], or Developers [email protected]
addressStringNew mailing list address, e.g. [email protected]
nameStringMailing list name, e.g. Developers.
descriptionStringA description.
accessLevelStringList access level, one of: readonly (default), members, everyone

MailGun.deleteMailingList

Deletes a mailing list.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
emailStringA valid email address for the mailing list, e.g. [email protected], or Developers [email protected]

MailGun.getMailingListMembers

Paginate over list members in the given mailing list

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
addressStringA valid email address for the mailing list, e.g. [email protected], or Developers [email protected]
subscribedSelectyes to lists subscribed, no for unsubscribed. list all if not set
limitNumberMaximum number of records to return (optional, default: 100, max: 10000)

MailGun.getSingleMailingListMember

Retrieves a mailing list member.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
addressStringA valid email address for the mailing list, e.g. [email protected], or Developers [email protected]
memberAddressStringMember email-address

MailGun.addMemberToMailingList

Adds a member to the mailing list.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
addressStringA valid email address for the mailing list, e.g. [email protected], or Developers [email protected]
nameStringOptional member name.
varsJSONJSON-encoded dictionary string with arbitrary parameters, e.g. {'gender':'female','age':27}
subscribedSelectyes to add as subscribed (default), no as unsubscribed
upsertSelectyes to update member if present, no to raise error in case of a duplicate member (default)

MailGun.updateMember

Updates a mailing list member with given properties.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
addressStringA valid email address for the mailing list, e.g. [email protected], or Developers [email protected]
memberAddressStringMember email-address
nameStringOptional member name.
varsJSONJSON-encoded dictionary string with arbitrary parameters, e.g. {'gender':'female','age':27}
subscribedSelectyes to add as subscribed (default), no as unsubscribed
upsertSelectyes to update member if present, no to raise error in case of a duplicate member (default)

MailGun.deleteMember

Delete a mailing list member.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
addressStringA valid email address for the mailing list, e.g. [email protected], or Developers [email protected]
memberAddressStringMember email-address

MailGun.validateAddress

Given an arbitrary address, validates address based off defined checks.

FieldTypeDescription
apiKeyCredentialsThe api key obtained from MailGun.
addressStringAn email address to validate. (Maximum: 512 characters)
mailboxVerificationSelectIf set to true, a mailbox verification check will be performed against the address.
x
circle
MailGun
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view