npm - mailgun.js - Versions diffs - 4.1.5 → 4.1.6 - Mend

mailgun.js 4.1.5 → 4.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (252) hide show

package/docs/index.html CHANGED Viewed

@@ -1,1308 +1,1140 @@
-<!doctype html>
-<html class="default no-js">
-<head>
-	<meta charset="utf-8">
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>mailgun.js</title>
-	<meta name="description" content="Documentation for mailgun.js">
-	<meta name="viewport" content="width=device-width, initial-scale=1">
-	<link rel="stylesheet" href="assets/css/main.css">
-</head>
-<body>
-<header>
-	<div class="tsd-page-toolbar">
-		<div class="container">
-			<div class="table-wrap">
-				<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
-					<div class="field">
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
-						<input id="tsd-search-field" type="text" />
-					</div>
-					<ul class="results">
-						<li class="state loading">Preparing search index...</li>
-						<li class="state failure">The search index is not available</li>
-					</ul>
-					<a href="index.html" class="title">mailgun.js</a>
-				</div>
-				<div class="table-cell" id="tsd-widgets">
-					<div id="tsd-filter">
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
-						<div class="tsd-filter-group">
-							<div class="tsd-select" id="tsd-filter-visibility">
-								<span class="tsd-select-label">All</span>
-								<ul class="tsd-select-list">
-									<li data-value="public">Public</li>
-									<li data-value="protected">Public/Protected</li>
-									<li data-value="private" class="selected">All</li>
-								</ul>
-							</div>
-							<input type="checkbox" id="tsd-filter-inherited" checked />
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
-							<input type="checkbox" id="tsd-filter-externals" checked />
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
-							<input type="checkbox" id="tsd-filter-only-exported" />
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
-						</div>
-					</div>
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
-				</div>
-			</div>
-		</div>
-	</div>
-	<div class="tsd-page-title">
-		<div class="container">
-			<ul class="tsd-breadcrumb">
-				<li>
-					<a href="globals.html">Globals</a>
-				</li>
-			</ul>
-			<h1>mailgun.js</h1>
-		</div>
-	</div>
-</header>
-<div class="container container-main">
-	<div class="row">
-		<div class="col-8 col-content">
-			<div class="tsd-panel tsd-typography">
-				<a href="#mailgunjs-" id="mailgunjs-" style="color: inherit; text-decoration: none;">
-					<h1>Mailgun.js <a href="https://travis-ci.org/mailgun/mailgun-js"><img src="https://travis-ci.org/mailgun/mailgun-js.svg" alt="Build Status"></a></h1>
-				</a>
-				<p>A javascript sdk for Mailgun built with webpack, babel &amp; es6. This can be used in node or in the browser*.</p>
-				<p>NOTE: If used in the browser, a proxy is required to communicate with the Mailgun api due to cors limitations. Also, do not publish your private api key in frontend code.</p>
-				<p><strong>Table of Contents</strong></p>
-				<ul>
-					<li><a href="#documentation">Documentation</a><ul>
-							<li><a href="#install">Install</a></li>
-							<li><a href="#setup-client">Setup Client</a></li>
-							<li><a href="#methods">Methods</a></li>
-							<li><a href="#browser-demo">Browser Demo</a></li>
-							<li><a href="https://github.com/mailgun/mailgun-js/tree/c379f79ea2a2e0f825103751a3a102d8bdd3dd1b/example">Examples</a></li>
-						</ul>
-					</li>
-					<li><a href="#development">Development</a><ul>
-							<li><a href="#requirements">Requirements</a></li>
-							<li><a href="#build">Build</a></li>
-							<li><a href="#tests">Tests</a></li>
-							<li><a href="#release-process">Release Process</a></li>
-						</ul>
-					</li>
-				</ul>
-				<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
-					<h1>Documentation</h1>
-				</a>
-				<a href="#install" id="install" style="color: inherit; text-decoration: none;">
-					<h2>Install</h2>
-				</a>
-				<ul>
-					<li>Requires node.js &gt;= 12.x</li>
-				</ul>
-				<p>Install mailgun.js with:</p>
-				<pre><code class="language-sh">npm install mailgun.js</code></pre>
-				<a href="#setup-client" id="setup-client" style="color: inherit; text-decoration: none;">
-					<h2>Setup Client</h2>
-				</a>
-				<p>Next, require the module and instantiate a mailgun client by calling <code>mailgun.client</code> with basic auth credentials <code>(username: &#39;api&#39;, key: &#39;key-yourkeyhere&#39;)</code>.</p>
-				<pre><code class="language-js"><span class="hljs-keyword">var</span> mailgun = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;mailgun.js&#x27;</span>);
-<span class="hljs-keyword">var</span> mg = mailgun.client({<span class="hljs-attr">username</span>: <span class="hljs-string">&#x27;api&#x27;</span>, <span class="hljs-attr">key</span>: process.env.MAILGUN_API_KEY || <span class="hljs-string">&#x27;key-yourkeyhere&#x27;</span>});</code></pre>
-				<p>To use <code>validate</code> and <code>parse</code> methods, you must additionally include <code>public_key</code>. If you&#39;re using only those methods, <code>key</code> can be an empty string.</p>
-				<pre><code class="language-js"><span class="hljs-keyword">var</span> mg = mailgun.client({
-  <span class="hljs-attr">username</span>: <span class="hljs-string">&#x27;api&#x27;</span>,
-  <span class="hljs-attr">key</span>: process.env.MAILGUN_API_KEY || <span class="hljs-string">&#x27;&#x27;</span>,
-  <span class="hljs-attr">public_key</span>: process.env.MAILGUN_PUBLIC_KEY || <span class="hljs-string">&#x27;pubkey-yourkeyhere&#x27;</span>
-});</code></pre>
-				<p>In the case your mailgun account is eu hosted you would need to define eu&#39;s subdomain as <code>url</code> in mailgun&#39;s Client constructor:</p>
-				<pre><code class="language-js"><span class="hljs-keyword">var</span> mailgun = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;mailgun.js&#x27;</span>);
-<span class="hljs-keyword">var</span> mg = mailgun.client({<span class="hljs-attr">username</span>: <span class="hljs-string">&#x27;api&#x27;</span>, <span class="hljs-attr">key</span>: process.env.MAILGUN_API_KEY || <span class="hljs-string">&#x27;key-yourkeyhere&#x27;</span>, <span class="hljs-attr">url</span>: <span class="hljs-string">&#x27;https://api.eu.mailgun.net&#x27;</span>});</code></pre>
-				<a href="#methods" id="methods" style="color: inherit; text-decoration: none;">
-					<h2>Methods</h2>
-				</a>
-				<p>The following service methods are available to instantiated clients. The examples assume you have already created a mailgun client as <code>mg</code> with valid credentials.</p>
-				<ul>
-					<li><a href="#mailgunjs-img-srchttpstravis-ciorgmailgunmailgun-jssvg-altbuild-status">Mailgun.js <img src="https://travis-ci.org/mailgun/mailgun-js" alt="Build Status"></a></li>
-					<li><a href="#documentation">Documentation</a><ul>
-							<li><a href="#install">Install</a></li>
-							<li><a href="#setup-client">Setup Client</a></li>
-							<li><a href="#methods">Methods</a><ul>
-									<li><a href="#messages">messages</a><ul>
-											<li><a href="#create">create</a></li>
-										</ul>
-									</li>
-									<li><a href="#domains">domains</a><ul>
-											<li><a href="#list">list</a></li>
-											<li><a href="#get">get</a></li>
-											<li><a href="#create-1">create</a></li>
-											<li><a href="#destroy">destroy</a></li>
-											<li><a href="#gettracking">getTracking</a></li>
-											<li><a href="#updatetracking">updateTracking</a></li>
-										</ul>
-									</li>
-									<li><a href="#events">events</a><ul>
-											<li><a href="#get-1">get</a></li>
-										</ul>
-									</li>
-									<li><a href="#stats">stats</a><ul>
-											<li><a href="#getdomain">getDomain</a></li>
-											<li><a href="#getaccount">getAccount</a></li>
-										</ul>
-									</li>
-									<li><a href="#suppressions">suppressions</a><ul>
-											<li><a href="#list-1">list</a></li>
-											<li><a href="#get-2">get</a></li>
-											<li><a href="#create-2">create</a></li>
-										</ul>
-									</li>
-									<li><a href="#webhooks">webhooks</a><ul>
-											<li><a href="#list-2">list</a></li>
-											<li><a href="#get-3">get</a></li>
-											<li><a href="#create-3">create</a></li>
-											<li><a href="#update">update</a></li>
-											<li><a href="#destroy-1">destroy</a></li>
-										</ul>
-									</li>
-									<li><a href="#routes">routes</a><ul>
-											<li><a href="#list-3">list</a></li>
-											<li><a href="#get-4">get</a></li>
-											<li><a href="#create-4">create</a></li>
-											<li><a href="#update-1">update</a></li>
-											<li><a href="#destroy-2">destroy</a></li>
-										</ul>
-									</li>
-									<li><a href="#validate">validate</a><ul>
-											<li><a href="#get-5">get</a></li>
-										</ul>
-									</li>
-									<li><a href="#parse">parse</a><ul>
-											<li><a href="#get-6">get</a></li>
-										</ul>
-									</li>
-								</ul>
-							</li>
-							<li><a href="#browser-demo">Browser Demo</a></li>
-						</ul>
-					</li>
-					<li><a href="#development">Development</a><ul>
-							<li><a href="#requirements">Requirements</a></li>
-							<li><a href="#build">Build</a></li>
-							<li><a href="#tests">Tests</a></li>
-							<li><a href="#release-process">Release Process</a></li>
-							<li><a href="#todo">TODO</a></li>
-						</ul>
-					</li>
-				</ul>
-				<p>Method naming conventions:</p>
-				<ul>
-					<li><code>get</code> or <code>get{{Item}}</code> - expected response for client is a single object</li>
-					<li><code>list</code> or <code>list{{Items}}</code> - expected response for client is a list of objects</li>
-					<li><code>create</code> or <code>create{{Item}}</code> - expected response for client is a single object</li>
-					<li><code>update</code> or <code>update{{Item}}</code> - expected response is an object with a status message</li>
-					<li><code>destroy</code> or <code>destroy{{Item}}</code> - expected response is an object with a status message</li>
-				</ul>
-				<a href="#messages" id="messages" style="color: inherit; text-decoration: none;">
-					<h3>messages</h3>
-				</a>
-				<a href="#create" id="create" style="color: inherit; text-decoration: none;">
-					<h4>create</h4>
-				</a>
-				<p><code>mg.messages.create(domain, data)</code> - <a href="https://documentation.mailgun.com/api-sending.html#sending">api docs</a></p>
-				<p>HTML/TEXT Example:</p>
-				<pre><code class="language-js">mg.messages.create(<span class="hljs-string">&#x27;sandbox-123.mailgun.org&#x27;</span>, {
-    <span class="hljs-attr">from</span>: <span class="hljs-string">&quot;Excited User &lt;mailgun@sandbox-123.mailgun.org&gt;&quot;</span>,
-    <span class="hljs-attr">to</span>: [<span class="hljs-string">&quot;test@example.com&quot;</span>],
-    <span class="hljs-attr">subject</span>: <span class="hljs-string">&quot;Hello&quot;</span>,
-    <span class="hljs-attr">text</span>: <span class="hljs-string">&quot;Testing some Mailgun awesomness!&quot;</span>,
-    <span class="hljs-attr">html</span>: <span class="hljs-string">&quot;&lt;h1&gt;Testing some Mailgun awesomness!&lt;/h1&gt;&quot;</span>
-  })
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>MIME Example:</p>
-				<pre><code class="language-js">mg.messages.create(<span class="hljs-string">&#x27;sandbox-123.mailgun.org&#x27;</span>, {
-    <span class="hljs-attr">from</span>: <span class="hljs-string">&quot;Excited User &lt;mailgun@sandbox-123.mailgun.org&gt;&quot;</span>,
-    <span class="hljs-attr">to</span>: [<span class="hljs-string">&quot;test@example.com&quot;</span>],
-    <span class="hljs-attr">subject</span>: <span class="hljs-string">&quot;Hello&quot;</span>,
-    <span class="hljs-attr">message</span>: <span class="hljs-string">&quot;&lt;mime encoded string here&gt;&quot;</span>
-  })
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;&lt;20151025002517.117282.79817@sandbox-123.mailgun.org&gt;&#x27;</span>,
-  message: <span class="hljs-string">&#x27;Queued. Thank you.&#x27;</span>
-}</code></pre>
-				<p>Options:</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">to</td>
-							<td align="left">Email address of the recipient(s). Example: &quot;Bob <a href="mailto:&#98;&#111;&#x62;&#64;&#104;&#x6f;&#115;&#116;&#x2e;&#99;&#x6f;&#x6d;">&#98;&#111;&#x62;&#64;&#104;&#x6f;&#115;&#116;&#x2e;&#99;&#x6f;&#x6d;</a>&quot;. You can use commas to separate multiple recipients (e.g.: &quot;<a href="mailto:&#116;&#x65;&#115;&#116;&#x40;&#101;&#x78;&#x61;&#109;&#112;&#x6c;&#101;&#x2e;&#x63;&#111;&#x6d;">&#116;&#x65;&#115;&#116;&#x40;&#101;&#x78;&#x61;&#109;&#112;&#x6c;&#101;&#x2e;&#x63;&#111;&#x6d;</a>,test@example.com&quot; or [&quot;test@example.com&quot;, &quot;<a href="mailto:&#116;&#x65;&#x73;&#116;&#x40;&#101;&#x78;&#97;&#x6d;&#x70;&#108;&#101;&#46;&#99;&#x6f;&#x6d;">&#116;&#x65;&#x73;&#116;&#x40;&#101;&#x78;&#97;&#x6d;&#x70;&#108;&#101;&#46;&#99;&#x6f;&#x6d;</a>&quot;]). Make sure to include all To, Cc and Bcc recipients of the message.</td>
-						</tr>
-						<tr>
-							<td align="left">html</td>
-							<td align="left">HTML version of the message.</td>
-						</tr>
-						<tr>
-							<td align="left">text</td>
-							<td align="left">Text version of the message.</td>
-						</tr>
-						<tr>
-							<td align="left">message</td>
-							<td align="left">MIME string of the message. Make sure to use multipart/form-data to send this as a file upload.</td>
-						</tr>
-						<tr>
-							<td align="left">attachment</td>
-							<td align="left">File attachment. You can post multiple attachment values. Important: You must use multipart/form-data encoding when sending attachments. Also you can use <code>{data: file, filename: filename}</code> to define custom filename.</td>
-						</tr>
-						<tr>
-							<td align="left">o:tag</td>
-							<td align="left">Tag string. See Tagging for more information.</td>
-						</tr>
-						<tr>
-							<td align="left">o:campaign</td>
-							<td align="left">Id of the campaign the message belongs to. See um-campaign-analytics for details.</td>
-						</tr>
-						<tr>
-							<td align="left">o:deliverytime</td>
-							<td align="left">Desired time of delivery. See Date Format. Note: Messages can be scheduled for a maximum of 3 days in the future.</td>
-						</tr>
-						<tr>
-							<td align="left">o:dkim</td>
-							<td align="left">Enables/disabled DKIM signatures on per-message basis. Pass yes or no</td>
-						</tr>
-						<tr>
-							<td align="left">o:testmode</td>
-							<td align="left">Enables sending in test mode. Pass yes if needed. See Sending in Test Mode</td>
-						</tr>
-						<tr>
-							<td align="left">o:tracking</td>
-							<td align="left">Toggles tracking on a per-message basis, see Tracking Messages for details. Pass yes or no.</td>
-						</tr>
-						<tr>
-							<td align="left">o:tracking-clicks</td>
-							<td align="left">Toggles clicks tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes, no or htmlonly.</td>
-						</tr>
-						<tr>
-							<td align="left">o:tracking-opens</td>
-							<td align="left">Toggles opens tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes or no.</td>
-						</tr>
-						<tr>
-							<td align="left">h:X-My-Header</td>
-							<td align="left">h: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case). For example, h:Reply-To to specify Reply-To address.</td>
-						</tr>
-						<tr>
-							<td align="left">v:my-var</td>
-							<td align="left">v: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See Attaching Data to Messages for more information.</td>
-						</tr>
-				</tbody></table>
-				<a href="#domains" id="domains" style="color: inherit; text-decoration: none;">
-					<h3>domains</h3>
-				</a>
-				<a href="#list" id="list" style="color: inherit; text-decoration: none;">
-					<h4>list</h4>
-				</a>
-				<p><code>mg.messages.list(query)</code> - <a href="https://documentation.mailgun.com/api-domains.html">api docs</a></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.messages.list()
-  .then(<span class="hljs-function"><span class="hljs-params">domains</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(domains)) <span class="hljs-comment">// logs array of domains</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns: array of Domain instances</p>
-				<pre><code>[{
-  <span class="hljs-attr">created_at:</span> <span class="hljs-string">&#x27;Sun, 19 Oct 2014 18:49:36 GMT&#x27;</span>,
-  <span class="hljs-attr">name:</span> <span class="hljs-string">&#x27;testing.example.com&#x27;</span>,
-  <span class="hljs-attr">receiving_dns_records:</span> <span class="hljs-literal">null</span>,
-  <span class="hljs-attr">require_tls:</span> <span class="hljs-literal">true</span>,
-  <span class="hljs-attr">sending_dns_records:</span> <span class="hljs-literal">null</span>,
-  <span class="hljs-attr">skip_verification:</span> <span class="hljs-literal">true</span>,
-  <span class="hljs-attr">smtp_login:</span> <span class="hljs-string">&#x27;postmaster@testing.example.com&#x27;</span>,
-  <span class="hljs-attr">smtp_password:</span> <span class="hljs-string">&#x27;password&#x27;</span>,
-  <span class="hljs-attr">spam_action:</span> <span class="hljs-string">&#x27;disabled&#x27;</span>,
-  <span class="hljs-attr">state:</span> <span class="hljs-string">&#x27;unverified&#x27;</span>,
-  <span class="hljs-attr">type:</span> <span class="hljs-string">&#x27;custom&#x27;</span>,
-  <span class="hljs-attr">wildcard:</span> <span class="hljs-literal">true</span>
-}]</code></pre>
-				<p>Options</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">limit</td>
-							<td align="left">Maximum number of records to return. (100 by default)</td>
-						</tr>
-						<tr>
-							<td align="left">skip</td>
-							<td align="left">Number of records to skip. (0 by default)</td>
-						</tr>
-				</tbody></table>
-				<a href="#get" id="get" style="color: inherit; text-decoration: none;">
-					<h4>get</h4>
-				</a>
-				<p><code>mg.messages.get()</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.messages.get()
-  .then(<span class="hljs-function"><span class="hljs-params">domains</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(domains)) <span class="hljs-comment">// logs array of domains</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns: Domain instance</p>
-				<pre><code>{
-  created_at: <span class="hljs-symbol">&#x27;Sun</span>, <span class="hljs-number">19</span> <span class="hljs-type">Oct</span> <span class="hljs-number">2014</span> <span class="hljs-number">18</span>:<span class="hljs-number">49</span>:<span class="hljs-number">36</span> <span class="hljs-type">GMT</span>&#x27;,
-  name: <span class="hljs-symbol">&#x27;testing</span>.example.com&#x27;,
-  receiving_dns_records: [{
-      <span class="hljs-string">&quot;name&quot;</span>: <span class="hljs-string">&quot;testing.example.com&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;TXT&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;v=spf1 include:mailgun.org ~all&quot;</span>
-    },
-    {
-      <span class="hljs-string">&quot;name&quot;</span>: <span class="hljs-string">&quot;k1._domainkey.testing.example.com&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;TXT&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;k=rsa; 123456&quot;</span>
-    },
-    {
-      <span class="hljs-string">&quot;name&quot;</span>: <span class="hljs-string">&quot;email.testing.example.com&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;CNAME&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;mailgun.org&quot;</span>
-    }],
-  require_tls: <span class="hljs-literal">true</span>,
-  sending_dns_records: [{
-      <span class="hljs-string">&quot;priority&quot;</span>: <span class="hljs-string">&quot;10&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;MX&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;mxa.mailgun.org&quot;</span>
-    },
-    {
-      <span class="hljs-string">&quot;priority&quot;</span>: <span class="hljs-string">&quot;10&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;MX&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;mxb.mailgun.org&quot;</span>
-    }],
-  skip_verification: <span class="hljs-literal">true</span>,
-  smtp_login: <span class="hljs-symbol">&#x27;postmaster</span><span class="hljs-meta">@testing</span>.example.com&#x27;,
-  smtp_password: <span class="hljs-symbol">&#x27;passwor</span>d&#x27;,
-  spam_action: <span class="hljs-symbol">&#x27;disable</span>d&#x27;,
-  state: <span class="hljs-symbol">&#x27;unverifie</span>d&#x27;,
-  <span class="hljs-class"><span class="hljs-keyword">type</span></span>: <span class="hljs-symbol">&#x27;custo</span>m&#x27;,
-  wildcard: <span class="hljs-literal">true</span>
-}</code></pre>
-				<a href="#create-1" id="create-1" style="color: inherit; text-decoration: none;">
-					<h4>create</h4>
-				</a>
-				<p><code>mg.domains.create(data)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.domains.create({<span class="hljs-attr">name</span>: <span class="hljs-string">&#x27;foobar.example.com&#x27;</span>})
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Options:</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">name</td>
-							<td align="left">Name of the domain (ex. domain.com)</td>
-						</tr>
-						<tr>
-							<td align="left">smtp_password</td>
-							<td align="left">Password for SMTP authentication</td>
-						</tr>
-						<tr>
-							<td align="left">spam_action</td>
-							<td align="left">disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged wtih a spam header. See Spam Filter.</td>
-						</tr>
-						<tr>
-							<td align="left">wildcard</td>
-							<td align="left">true or false Determines whether the domain will accept email for sub-domains.</td>
-						</tr>
-				</tbody></table>
-				<p>Promise Returns: Domain instance</p>
-				<pre><code>{
-  created_at: <span class="hljs-symbol">&#x27;Sun</span>, <span class="hljs-number">19</span> <span class="hljs-type">Oct</span> <span class="hljs-number">2014</span> <span class="hljs-number">18</span>:<span class="hljs-number">49</span>:<span class="hljs-number">36</span> <span class="hljs-type">GMT</span>&#x27;,
-  name: <span class="hljs-symbol">&#x27;foobar</span>.example.com&#x27;,
-  receiving_dns_records: [{
-      <span class="hljs-string">&quot;name&quot;</span>: <span class="hljs-string">&quot;foobar.example.com&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;TXT&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;v=spf1 include:mailgun.org ~all&quot;</span>
-    },
-    {
-      <span class="hljs-string">&quot;name&quot;</span>: <span class="hljs-string">&quot;k1._domainkey.foobar.example.com&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;TXT&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;k=rsa; 123456&quot;</span>
-    },
-    {
-      <span class="hljs-string">&quot;name&quot;</span>: <span class="hljs-string">&quot;email.foobar.example.com&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;CNAME&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;mailgun.org&quot;</span>
-    }],
-  require_tls: <span class="hljs-literal">true</span>,
-  sending_dns_records: [{
-      <span class="hljs-string">&quot;priority&quot;</span>: <span class="hljs-string">&quot;10&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;MX&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;mxa.mailgun.org&quot;</span>
-    },
-    {
-      <span class="hljs-string">&quot;priority&quot;</span>: <span class="hljs-string">&quot;10&quot;</span>,
-      <span class="hljs-string">&quot;record_type&quot;</span>: <span class="hljs-string">&quot;MX&quot;</span>,
-      <span class="hljs-string">&quot;valid&quot;</span>: <span class="hljs-string">&quot;unknown&quot;</span>,
-      <span class="hljs-string">&quot;value&quot;</span>: <span class="hljs-string">&quot;mxb.mailgun.org&quot;</span>
-    }],
-  skip_verification: <span class="hljs-literal">true</span>,
-  smtp_login: <span class="hljs-symbol">&#x27;postmaster</span><span class="hljs-meta">@foobar</span>.example.com&#x27;,
-  smtp_password: <span class="hljs-symbol">&#x27;passwor</span>d&#x27;,
-  spam_action: <span class="hljs-symbol">&#x27;disable</span>d&#x27;,
-  state: <span class="hljs-symbol">&#x27;unverifie</span>d&#x27;,
-  <span class="hljs-class"><span class="hljs-keyword">type</span></span>: <span class="hljs-symbol">&#x27;custo</span>m&#x27;,
-  wildcard: <span class="hljs-literal">false</span>
-}</code></pre>
-				<a href="#destroy" id="destroy" style="color: inherit; text-decoration: none;">
-					<h4>destroy</h4>
-				</a>
-				<p><code>mg.domains.destroy(domain)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.domains.destroy(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attribute">message</span>: <span class="hljs-string">&quot;Domain has been deleted&quot;</span>
-}</code></pre>
-				<a href="#gettracking" id="gettracking" style="color: inherit; text-decoration: none;">
-					<h4>getTracking</h4>
-				</a>
-				<p><code>mg.domains.getTracking(domain)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.domains.getTracking(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attr">&quot;click&quot;</span>: {
-    <span class="hljs-attr">&quot;active&quot;</span>: <span class="hljs-literal">false</span>
-  },
-  <span class="hljs-attr">&quot;open&quot;</span>: {
-    <span class="hljs-attr">&quot;active&quot;</span>: <span class="hljs-literal">false</span>
-  },
-  <span class="hljs-attr">&quot;unsubscribe&quot;</span>: {
-    <span class="hljs-attr">&quot;active&quot;</span>: <span class="hljs-literal">false</span>,
-    <span class="hljs-attr">&quot;html_footer&quot;</span>: <span class="hljs-string">&quot;\n&lt;br&gt;\n&lt;p&gt;&lt;a href=\&quot;%unsubscribe_url%\&quot;&gt;unsubscribe&lt;/a&gt;&lt;/p&gt;\n&quot;</span>,
-    <span class="hljs-attr">&quot;text_footer&quot;</span>: <span class="hljs-string">&quot;\n\nTo unsubscribe click: &lt;%unsubscribe_url%&gt;\n\n&quot;</span>
-  }
-}</code></pre>
-				<a href="#updatetracking" id="updatetracking" style="color: inherit; text-decoration: none;">
-					<h4>updateTracking</h4>
-				</a>
-				<p><code>mg.domains.updateTracking(domain, trackingType, data)</code></p>
-				<p>Open Tracking Example:</p>
-				<pre><code class="language-js">mg.domains.updateTracking(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;open&#x27;</span>, {<span class="hljs-attr">active</span>: <span class="hljs-literal">true</span>})
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Open Tracking Options</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">active</td>
-							<td align="left">Boolean, enables or disables open tracking</td>
-						</tr>
-				</tbody></table>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attribute">message</span>: <span class="hljs-string">&#x27;Tracking settings have been updated&#x27;</span>,
-  open: {
-    active: true
-  }
-}</code></pre>
-				<p>Click Tracking Example:</p>
-				<pre><code class="language-js">mg.domains.updateTracking(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;click&#x27;</span>, {<span class="hljs-attr">active</span>: <span class="hljs-literal">true</span>})
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Click Tracking Options</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">active</td>
-							<td align="left">Boolean, enables or disables click tracking</td>
-						</tr>
-				</tbody></table>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attribute">message</span>: <span class="hljs-string">&#x27;Tracking settings have been updated&#x27;</span>,
-  click: {
-    active: true
-  }
-}</code></pre>
-				<p>Unsubscribe Tracking Example:</p>
-				<pre><code class="language-js">mg.domains.updateTracking(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;unsubscribe&#x27;</span>, {
-    <span class="hljs-attr">active</span>: <span class="hljs-literal">true</span>,
-    <span class="hljs-attr">html_footer</span>: <span class="hljs-string">&quot;\n&lt;br&gt;\n&lt;p&gt;&lt;a href=\&quot;%unsubscribe_url%\&quot;&gt;unsubscribe&lt;/a&gt;&lt;/p&gt;\n&quot;</span>,
-    <span class="hljs-attr">text_footer</span>: <span class="hljs-string">&quot;\n\nTo unsubscribe click: &lt;%unsubscribe_url%&gt;\n\n&quot;</span>
-  })
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Unsubscribe Tracking Options</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">active</td>
-							<td align="left">Boolean, enables or disables unsubscribe tracking</td>
-						</tr>
-						<tr>
-							<td align="left">html_footer</td>
-							<td align="left">string appended to html emails for managing unsubscribe links</td>
-						</tr>
-						<tr>
-							<td align="left">text_footer</td>
-							<td align="left">string appended to html emails for managing unsubscribe links</td>
-						</tr>
-				</tbody></table>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  message: &#x27;<span class="hljs-type">Tracking</span> settings have been updated&#x27;,
-  <span class="hljs-string">&quot;unsubscribe&quot;</span>: {
-    <span class="hljs-string">&quot;active&quot;</span>: <span class="hljs-literal">true</span>,
-    <span class="hljs-string">&quot;html_footer&quot;</span>: <span class="hljs-string">&quot;<span class="hljs-subst">\n</span>&lt;br&gt;<span class="hljs-subst">\n</span>&lt;p&gt;&lt;a href=<span class="hljs-subst">\&quot;</span>%unsubscribe_url%<span class="hljs-subst">\&quot;</span>&gt;unsubscribe&lt;/a&gt;&lt;/p&gt;<span class="hljs-subst">\n</span>&quot;</span>,
-    <span class="hljs-string">&quot;text_footer&quot;</span>: <span class="hljs-string">&quot;<span class="hljs-subst">\n</span><span class="hljs-subst">\n</span>To unsubscribe click: &lt;%unsubscribe_url%&gt;<span class="hljs-subst">\n</span><span class="hljs-subst">\n</span>&quot;</span>
-  }
-}</code></pre>
-				<a href="#events" id="events" style="color: inherit; text-decoration: none;">
-					<h3>events</h3>
-				</a>
-				<a href="#get-1" id="get-1" style="color: inherit; text-decoration: none;">
-					<h4>get</h4>
-				</a>
-				<p><code>mg.events.get(domain, query)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.events.get(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, { <span class="hljs-attr">page</span>: <span class="hljs-string">&#x27;mypageid&#x27;</span> })
-  .then(<span class="hljs-function"><span class="hljs-params">data</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(data.items)) <span class="hljs-comment">// logs array of event objects</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Options:</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">page</td>
-							<td align="left">Fetches the specified page of log records, assuming that the URL was returned by the previous request</td>
-						</tr>
-						<tr>
-							<td align="left">begin</td>
-							<td align="left">The beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.</td>
-						</tr>
-						<tr>
-							<td align="left">end</td>
-							<td align="left">The end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.</td>
-						</tr>
-						<tr>
-							<td align="left">ascending</td>
-							<td align="left">Defines the direction of the search time range if the range end time is not specified. Can be either yes or no. Refer to Time Range for details.</td>
-						</tr>
-						<tr>
-							<td align="left">limit</td>
-							<td align="left">Number of entries to return. (300 max)</td>
-						</tr>
-						<tr>
-							<td align="left"><field></td>
-							<td align="left"><field> is the name of the Filter Field. The value of the parameter should be a valid Filter Expression. Several field filters can be specified in one request. If the same field is mentioned, more then once, then all its filter expressions are combined with AND operator.</td>
-						</tr>
-				</tbody></table>
-				<p>Promise Returns: items (array of event objects), pages (paging keys grouped by id)</p>
-				<pre><code>{
- <span class="hljs-attribute">items</span>: [{
-    <span class="hljs-attribute">type</span>: <span class="hljs-string">&#x27;accepted&#x27;</span>,
-    <span class="hljs-attribute">summary</span>: <span class="hljs-string">&#x27;got it&#x27;</span>,
-    <span class="hljs-attribute">content</span>: { <span class="hljs-attribute">more</span>: <span class="hljs-string">&#x27;data&#x27;</span> },
-    <span class="hljs-attribute">timestamp</span>: Wed Nov <span class="hljs-number">19</span> <span class="hljs-number">2014</span> <span class="hljs-number">10</span>:<span class="hljs-number">32</span>:<span class="hljs-number">57</span> GMT-<span class="hljs-number">0800</span> (PST) },
-  }],
-  <span class="hljs-attribute">pages</span>: {
-    <span class="hljs-attribute">first</span>: { <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;first&#x27;</span>, <span class="hljs-attribute">number</span>: <span class="hljs-string">&#x27;W3siYSI6IGZhbHNlLC&#x27;</span>, <span class="hljs-attribute">url</span>: <span class="hljs-string">&#x27;apiurl&#x27;</span> },
-    <span class="hljs-attribute">last</span>: { <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;last&#x27;</span>, <span class="hljs-attribute">number</span>: <span class="hljs-string">&#x27;W3siYSI6IGZhbHNlLC&#x27;</span>, <span class="hljs-attribute">url</span>: <span class="hljs-string">&#x27;apiurl&#x27;</span> },
-    <span class="hljs-attribute">next</span>: { <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;next&#x27;</span>, <span class="hljs-attribute">number</span>: W3siYSI6IGZhbHNlLC<span class="hljs-string">&#x27;&#x27;</span>, <span class="hljs-attribute">url</span>: <span class="hljs-string">&#x27;apiurl&#x27;</span> },
-    <span class="hljs-attribute">previous</span>: { <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;previous&#x27;</span>, <span class="hljs-attribute">number</span>: <span class="hljs-string">&#x27;W3siYSI6IGZhbHNlLC&#x27;</span>, <span class="hljs-attribute">url</span>: <span class="hljs-string">&#x27;apiurl&#x27;</span> }
-  }
-}</code></pre>
-				<a href="#stats" id="stats" style="color: inherit; text-decoration: none;">
-					<h3>stats</h3>
-				</a>
-				<p>Stats Options</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">event</td>
-							<td align="left">The type of the event. For a complete list of all events written to the log see the <code>Event Types</code> table below. (Required)</td>
-						</tr>
-						<tr>
-							<td align="left">start</td>
-							<td align="left">The starting time. Should be in :rfc:<code>2822#page-14</code> or unix epoch format. Default: 7 days from the current time.</td>
-						</tr>
-						<tr>
-							<td align="left">end</td>
-							<td align="left">The ending date. Should be in :rfc:<code>2822#page-14</code> or unix epoch format. Default: current time.</td>
-						</tr>
-						<tr>
-							<td align="left">resolution</td>
-							<td align="left">Can be either <code>hour</code>, <code>day</code> or <code>month</code>. Default: <code>day</code></td>
-						</tr>
-						<tr>
-							<td align="left">duration</td>
-							<td align="left">Period of time with resoluton encoded. If provided, overwrites the start date. See list below.</td>
-						</tr>
-				</tbody></table>
-				<p>Duration is a string that represents a period of time with some resolution. It has a format <code>[0-9]+[m,d,h]</code> where</p>
-				<ul>
-					<li><code>h</code> - an hour</li>
-					<li><code>d</code> - a day</li>
-					<li><code>m</code> - a month</li>
-				</ul>
-				<p>Examples:</p>
-				<ul>
-					<li><code>24h</code> - a period of 24 hours (a day) with hourly resolution</li>
-					<li><code>1d</code> - a period of 1 day with daily resolution</li>
-					<li><code>2m</code> - a period of 2 months with monthly resolution</li>
-				</ul>
-				<p>Event Types</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Event Type</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">accepted</td>
-							<td align="left">Mailgun accepted the request to send/forward the email and the message has been placed in queue.</td>
-						</tr>
-						<tr>
-							<td align="left">delivered</td>
-							<td align="left">Mailgun sent the email and it was accepted by the recipient email server.</td>
-						</tr>
-						<tr>
-							<td align="left">failed</td>
-							<td align="left">Mailgun could not deliver the email to the recipient email server.</td>
-						</tr>
-						<tr>
-							<td align="left">opened</td>
-							<td align="left">The email recipient opened the email and enabled image viewing. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org.</td>
-						</tr>
-						<tr>
-							<td align="left">clicked</td>
-							<td align="left">The email recipient clicked on a link in the email. Click tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org.</td>
-						</tr>
-						<tr>
-							<td align="left">unsubscribed</td>
-							<td align="left">The email recipient clicked on the unsubscribe link. Unsubscribe tracking must be enabled in the Mailgun control panel.</td>
-						</tr>
-						<tr>
-							<td align="left">complained</td>
-							<td align="left">The email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.</td>
-						</tr>
-						<tr>
-							<td align="left">stored</td>
-							<td align="left">Mailgun has stored an incoming message</td>
-						</tr>
-				</tbody></table>
-				<a href="#getdomain" id="getdomain" style="color: inherit; text-decoration: none;">
-					<h4>getDomain</h4>
-				</a>
-				<p><code>mg.stats.getDomain(domain, query)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.stats.getDomain(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, {<span class="hljs-attr">event</span>: [<span class="hljs-string">&#x27;delivered&#x27;</span>, <span class="hljs-string">&#x27;accepted&#x27;</span>, <span class="hljs-string">&#x27;failed&#x27;</span>, <span class="hljs-string">&#x27;complained&#x27;</span>]})
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attr">start:</span> <span class="hljs-string">Sun</span> <span class="hljs-string">Mar</span> <span class="hljs-number">15</span> <span class="hljs-number">2015 17:00:00 </span><span class="hljs-string">GMT-0700</span> <span class="hljs-string">(PDT)</span>,
-  <span class="hljs-attr">end:</span> <span class="hljs-string">Sun</span> <span class="hljs-string">Mar</span> <span class="hljs-number">22</span> <span class="hljs-number">2015 17:00:00 </span><span class="hljs-string">GMT-0700</span> <span class="hljs-string">(PDT)</span>,
-  <span class="hljs-attr">resolution:</span> <span class="hljs-string">&#x27;day&#x27;</span>,
-  <span class="hljs-attr">stats:</span> [{
-    <span class="hljs-attr">time:</span> <span class="hljs-string">Sun</span> <span class="hljs-string">Mar</span> <span class="hljs-number">15</span> <span class="hljs-number">2015 17:00:00 </span><span class="hljs-string">GMT-0700</span> <span class="hljs-string">(PDT)</span>,
-    <span class="hljs-attr">delivered:</span> { <span class="hljs-attr">smtp:</span> <span class="hljs-number">2</span>, <span class="hljs-attr">http:</span> <span class="hljs-number">1</span>, <span class="hljs-attr">total:</span> <span class="hljs-number">3</span> }
-  }]
-}</code></pre>
-				<a href="#getaccount" id="getaccount" style="color: inherit; text-decoration: none;">
-					<h4>getAccount</h4>
-				</a>
-				<p><code>mg.stats.getDomain(domain, query)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.stats.getDomain(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, {<span class="hljs-attr">event</span>: [<span class="hljs-string">&#x27;delivered&#x27;</span>, <span class="hljs-string">&#x27;accepted&#x27;</span>, <span class="hljs-string">&#x27;failed&#x27;</span>, <span class="hljs-string">&#x27;complained&#x27;</span>]})
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attr">start:</span> <span class="hljs-string">Sun</span> <span class="hljs-string">Mar</span> <span class="hljs-number">15</span> <span class="hljs-number">2015 17:00:00 </span><span class="hljs-string">GMT-0700</span> <span class="hljs-string">(PDT)</span>,
-  <span class="hljs-attr">end:</span> <span class="hljs-string">Sun</span> <span class="hljs-string">Mar</span> <span class="hljs-number">22</span> <span class="hljs-number">2015 17:00:00 </span><span class="hljs-string">GMT-0700</span> <span class="hljs-string">(PDT)</span>,
-  <span class="hljs-attr">resolution:</span> <span class="hljs-string">&#x27;day&#x27;</span>,
-  <span class="hljs-attr">stats:</span> [{
-    <span class="hljs-attr">time:</span> <span class="hljs-string">Sun</span> <span class="hljs-string">Mar</span> <span class="hljs-number">15</span> <span class="hljs-number">2015 17:00:00 </span><span class="hljs-string">GMT-0700</span> <span class="hljs-string">(PDT)</span>,
-    <span class="hljs-attr">delivered:</span> { <span class="hljs-attr">smtp:</span> <span class="hljs-number">2</span>, <span class="hljs-attr">http:</span> <span class="hljs-number">1</span>, <span class="hljs-attr">total:</span> <span class="hljs-number">3</span> }
-  }]
-}</code></pre>
-				<a href="#suppressions" id="suppressions" style="color: inherit; text-decoration: none;">
-					<h3>suppressions</h3>
-				</a>
-				<a href="#list-1" id="list-1" style="color: inherit; text-decoration: none;">
-					<h4>list</h4>
-				</a>
-				<p><code>mg.suppressions.list(domain, suppressionType, query)</code></p>
-				<p>Bounces Example:</p>
-				<pre><code class="language-js">mg.suppressions.list(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;bounces&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Unsubscribes Example:</p>
-				<pre><code class="language-js">mg.suppressions.list(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;unsubscribes&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Complaints Example:</p>
-				<pre><code class="language-js">mg.suppressions.list(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;complaints&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attribute">items</span>: [
-    {
-      <span class="hljs-attribute">type</span>: <span class="hljs-string">&#x27;bounces&#x27;</span>,
-      <span class="hljs-attribute">address</span>: <span class="hljs-string">&#x27;unknown@unknown.com&#x27;</span>,
-      <span class="hljs-attribute">code</span>: <span class="hljs-number">550</span>,
-      <span class="hljs-attribute">error</span>: <span class="hljs-string">&#x27;No such mailbox&#x27;</span>,
-      <span class="hljs-attribute">created_at</span>: Fri Oct <span class="hljs-number">21</span> <span class="hljs-number">2011</span> <span class="hljs-number">04</span>:<span class="hljs-number">02</span>:<span class="hljs-number">55</span> GMT-<span class="hljs-number">0700</span> (PDT)
-    }
-  ],
-  <span class="hljs-attribute">pages</span>: {
-    <span class="hljs-attribute">first</span>: { <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;first&#x27;</span>, <span class="hljs-attribute">page</span>: <span class="hljs-string">&#x27;&#x27;</span>, <span class="hljs-attribute">address</span>: <span class="hljs-string">&#x27;&#x27;</span>, <span class="hljs-attribute">url</span>: <span class="hljs-string">&#x27;apiurl&#x27;</span> },
-    <span class="hljs-attribute">last</span>: { <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;last&#x27;</span>, <span class="hljs-attribute">page</span>: <span class="hljs-string">&#x27;&#x27;</span>, <span class="hljs-attribute">address</span>: <span class="hljs-string">&#x27;&#x27;</span>, <span class="hljs-attribute">url</span>: <span class="hljs-string">&#x27;apiurl&#x27;</span> },
-    <span class="hljs-attribute">next</span>: { <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;next&#x27;</span>, <span class="hljs-attribute">page</span>: <span class="hljs-string">&#x27;&#x27;</span>, <span class="hljs-attribute">address</span>: <span class="hljs-string">&#x27;&#x27;</span>, <span class="hljs-attribute">url</span>: <span class="hljs-string">&#x27;apiurl&#x27;</span> },
-    <span class="hljs-attribute">previous</span>: { <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;prev&#x27;</span>, <span class="hljs-attribute">page</span>: <span class="hljs-string">&#x27;&#x27;</span>, <span class="hljs-attribute">address</span>: <span class="hljs-string">&#x27;&#x27;</span>, <span class="hljs-attribute">url</span>: <span class="hljs-string">&#x27;apiurl&#x27;</span> }
-  }
-}</code></pre>
-				<a href="#get-2" id="get-2" style="color: inherit; text-decoration: none;">
-					<h4>get</h4>
-				</a>
-				<p><code>mg.suppressions.get(domain, suppressionType, address)</code></p>
-				<p>Bounces Example:</p>
-				<pre><code class="language-js">mg.suppressions.get(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;bounces&#x27;</span>, <span class="hljs-string">&#x27;address@example.com&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Unsubscribes Example:</p>
-				<pre><code class="language-js">mg.suppressions.get(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;unsubscribes&#x27;</span>, <span class="hljs-string">&#x27;address@example.com&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Complaints Example:</p>
-				<pre><code class="language-js">mg.suppressions.get(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;complaints&#x27;</span>, <span class="hljs-string">&#x27;address@example.com&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Options:</p>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-built_in">type</span>: <span class="hljs-string">&#x27;bounces&#x27;</span>,
-  addres<span class="hljs-variable">s:</span> <span class="hljs-string">&#x27;address?@unknown.com&#x27;</span>,
-  <span class="hljs-keyword">tag</span><span class="hljs-variable">s:</span> [ <span class="hljs-string">&#x27;*&#x27;</span> ],
-  created_a<span class="hljs-variable">t:</span> Fri Oct <span class="hljs-number">21</span> <span class="hljs-number">2011</span> <span class="hljs-number">05</span>:<span class="hljs-number">02</span>:<span class="hljs-number">55</span> GMT-<span class="hljs-number">0700</span> (PDT)
-}</code></pre>
-				<a href="#create-2" id="create-2" style="color: inherit; text-decoration: none;">
-					<h4>create</h4>
-				</a>
-				<p><code>mg.suppressions.create(domain, suppressionType, array)</code></p>
-				<p>Bounces Example:</p>
-				<pre><code class="language-js">mg.suppressions.create(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;bounces&#x27;</span>, [{<span class="hljs-attr">address</span>: <span class="hljs-string">&#x27;bob@example.com&#x27;</span>}])
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Bounces Options: Contains an array with the following object properties</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">address</td>
-							<td align="left">Valid email address</td>
-						</tr>
-						<tr>
-							<td align="left">code</td>
-							<td align="left">Error code (optional, default: 550)</td>
-						</tr>
-						<tr>
-							<td align="left">error</td>
-							<td align="left">Error description (optional, default: empty string)</td>
-						</tr>
-						<tr>
-							<td align="left">created_at</td>
-							<td align="left">Timestamp of a bounce event in RFC2822 format (optional, default: current time)</td>
-						</tr>
-				</tbody></table>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attribute">message</span>: <span class="hljs-string">&quot;1 address has been added to the bounces table&quot;</span>
-}</code></pre>
-				<p>Unsubscribes Example:</p>
-				<pre><code class="language-js">mg.suppressions.create(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;unsubscribes&#x27;</span>, [{<span class="hljs-attr">address</span>: <span class="hljs-string">&#x27;bob@example.com&#x27;</span>}])
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Unsubscribes Options: Contains an array with the following object properties</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">address</td>
-							<td align="left">Valid email address</td>
-						</tr>
-						<tr>
-							<td align="left">tag</td>
-							<td align="left">Tag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *)</td>
-						</tr>
-						<tr>
-							<td align="left">created_at</td>
-							<td align="left">Timestamp of a bounce event in RFC2822 format (optional, default: current time)</td>
-						</tr>
-				</tbody></table>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attribute">message</span>: <span class="hljs-string">&quot;1 address has been added to the unsubscribes table&quot;</span>
-}</code></pre>
-				<p>Complaints Example:</p>
-				<pre><code class="language-js">mg.suppressions.create(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;complaints&#x27;</span>, [{<span class="hljs-attr">address</span>: <span class="hljs-string">&#x27;bob@example.com&#x27;</span>}])
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Complaints Options: Contains an array with the following object properties</p>
-				<table>
-					<thead>
-						<tr>
-							<th align="left">Parameter</th>
-							<th align="left">Description</th>
-						</tr>
-					</thead>
-					<tbody><tr>
-							<td align="left">address</td>
-							<td align="left">Valid email address</td>
-						</tr>
-						<tr>
-							<td align="left">created_at</td>
-							<td align="left">Timestamp of a bounce event in RFC2822 format (optional, default: current time)</td>
-						</tr>
-				</tbody></table>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-attribute">message</span>: <span class="hljs-string">&quot;1 address has been added to the complaints table&quot;</span>
-}</code></pre>
-				<a href="#webhooks" id="webhooks" style="color: inherit; text-decoration: none;">
-					<h3>webhooks</h3>
-				</a>
-				<a href="#list-2" id="list-2" style="color: inherit; text-decoration: none;">
-					<h4>list</h4>
-				</a>
-				<p><code>mg.webhooks.list(domain, query)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.webhooks.list(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  open: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; },</span>
-  click: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; },</span>
-  bounce: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; },</span>
-  deliver: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; },</span>
-  <span class="hljs-built_in">drop</span>: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; },</span>
-  spam: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; },</span>
-  unsubscribe: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; },</span>
-  click: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; },</span>
-  open: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; },</span>
-}</code></pre>
-				<a href="#get-3" id="get-3" style="color: inherit; text-decoration: none;">
-					<h4>get</h4>
-				</a>
-				<p><code>mg.webhooks.get(domain, id)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.webhooks.get(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;open&#x27;</span>) <span class="hljs-comment">// bounce, deliver, drop, spam, unsubscribe, click, open</span>
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-symbol">&#x27;open</span>&#x27;: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; }</span>
-}</code></pre>
-				<a href="#create-3" id="create-3" style="color: inherit; text-decoration: none;">
-					<h4>create</h4>
-				</a>
-				<p><code>mg.webhooks.create(domain, id, data, test)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.webhooks.create(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;open&#x27;</span>, <span class="hljs-string">&#x27;http://requestb.in&#x27;</span>) <span class="hljs-comment">// bounce, deliver, drop, spam, unsubscribe, click, open</span>
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-symbol">&#x27;open</span>&#x27;: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; }</span>
-}</code></pre>
-				<p>Test Webhook Example:</p>
-				<pre><code class="language-js">mg.webhooks.get(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;open&#x27;</span>, <span class="hljs-string">&#x27;http://requestb.in&#x27;</span>, <span class="hljs-literal">true</span>) <span class="hljs-comment">// bounce, deliver, drop, spam, unsubscribe, click, open</span>
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  &#x27;code&#x27;: &#x27;500&#x27;,
-  &#x27;message&#x27;: &#x27;Hi!&#x27;
-}</code></pre>
-				<a href="#update" id="update" style="color: inherit; text-decoration: none;">
-					<h4>update</h4>
-				</a>
-				<p><code>mg.webhooks.update(domain, id, url, test)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.webhooks.update(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;open&#x27;</span>, <span class="hljs-string">&#x27;http://requestb.in&#x27;</span>) <span class="hljs-comment">// bounce, deliver, drop, spam, unsubscribe, click, open</span>
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-symbol">&#x27;open</span>&#x27;: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; }</span>
-}</code></pre>
-				<a href="#destroy-1" id="destroy-1" style="color: inherit; text-decoration: none;">
-					<h4>destroy</h4>
-				</a>
-				<p><code>mg.webhooks.destroy(domain, id)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.webhooks.update(<span class="hljs-string">&#x27;foobar.example.com&#x27;</span>, <span class="hljs-string">&#x27;open&#x27;</span>) <span class="hljs-comment">// bounce, deliver, drop, spam, unsubscribe, click, open</span>
-  .then(<span class="hljs-function"><span class="hljs-params">msg</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(msg)) <span class="hljs-comment">// logs response data</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns:</p>
-				<pre><code>{
-  <span class="hljs-symbol">&#x27;open</span>&#x27;: { <span class="hljs-symbol">&#x27;url</span>&#x27;: <span class="hljs-symbol">&#x27;http</span>:<span class="hljs-comment">//requestb.in&#x27; }</span>
-}</code></pre>
-				<a href="#routes" id="routes" style="color: inherit; text-decoration: none;">
-					<h3>routes</h3>
-				</a>
-				<a href="#list-3" id="list-3" style="color: inherit; text-decoration: none;">
-					<h4>list</h4>
-				</a>
-				<p><code>mg.routes.list(query)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.routes.list()
-  .then(<span class="hljs-function"><span class="hljs-params">data</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(data)) <span class="hljs-comment">// logs response body</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns: response body</p>
-				<pre><code>[
-  {
-    actions: [ <span class="hljs-symbol">&#x27;forward</span>(<span class="hljs-string">&quot;http://myhost.com/messages/&quot;</span>)&#x27;, <span class="hljs-symbol">&#x27;stop</span>()&#x27; ],
-    created_at: <span class="hljs-symbol">&#x27;Mon</span>, <span class="hljs-number">26</span> Oct <span class="hljs-number">2015</span> <span class="hljs-number">03</span>:56:51 GMT&#x27;,
-    description: <span class="hljs-symbol">&#x27;sample</span>&#x27;,
-    expression: <span class="hljs-symbol">&#x27;match_recipient</span>(<span class="hljs-string">&quot;.*@example.com&quot;</span>)&#x27;,
-    id: <span class="hljs-symbol">&#x27;562da483125730608a7d1719</span>&#x27;,
-    priority: <span class="hljs-number">0</span>
-  }
-]</code></pre>
-				<a href="#get-4" id="get-4" style="color: inherit; text-decoration: none;">
-					<h4>get</h4>
-				</a>
-				<p><code>mg.routes.get(id)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.routes.get(<span class="hljs-string">&#x27;562da483125730608a7d1719&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">data</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(data)) <span class="hljs-comment">// logs response body</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns: response body</p>
-				<pre><code>{
-  <span class="hljs-attribute">actions</span>: [ <span class="hljs-string">&#x27;forward(&quot;http://myhost.com/messages/&quot;)&#x27;</span>, <span class="hljs-string">&#x27;stop()&#x27;</span> ],
-  <span class="hljs-attribute">created_at</span>: <span class="hljs-string">&#x27;Mon, 26 Oct 2015 03:56:51 GMT&#x27;</span>,
-  <span class="hljs-attribute">description</span>: <span class="hljs-string">&#x27;sample&#x27;</span>,
-  <span class="hljs-attribute">expression</span>: <span class="hljs-string">&#x27;match_recipient(&quot;.*@example.com&quot;)&#x27;</span>,
-  <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;562da483125730608a7d1719&#x27;</span>,
-  <span class="hljs-attribute">priority</span>: <span class="hljs-number">0</span>
-}</code></pre>
-				<a href="#create-4" id="create-4" style="color: inherit; text-decoration: none;">
-					<h4>create</h4>
-				</a>
-				<p><code>mg.routes.create(options)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.routes.create({
-    <span class="hljs-attr">priority</span>: <span class="hljs-number">0</span>,
-    <span class="hljs-attr">description</span>: <span class="hljs-string">&#x27;sample&#x27;</span>,
-    <span class="hljs-attr">expression</span>: <span class="hljs-string">&#x27;match_recipient(&quot;.*@example.org&quot;)&#x27;</span>,
-    <span class="hljs-attr">action</span>: [<span class="hljs-string">&#x27;forward(&quot;http://myhost.com/messages/&quot;)&#x27;</span>, <span class="hljs-string">&#x27;stop()&#x27;</span>]
-  })
-  .then(<span class="hljs-function"><span class="hljs-params">data</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(data)) <span class="hljs-comment">// logs response body</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns: response body</p>
-				<pre><code>{
-  <span class="hljs-attribute">actions</span>: [ <span class="hljs-string">&#x27;forward(&quot;http://myhost.com/messages/&quot;)&#x27;</span>, <span class="hljs-string">&#x27;stop()&#x27;</span> ],
-  <span class="hljs-attribute">created_at</span>: <span class="hljs-string">&#x27;Mon, 26 Oct 2015 03:56:51 GMT&#x27;</span>,
-  <span class="hljs-attribute">description</span>: <span class="hljs-string">&#x27;sample&#x27;</span>,
-  <span class="hljs-attribute">expression</span>: <span class="hljs-string">&#x27;match_recipient(&quot;.*@example.com&quot;)&#x27;</span>,
-  <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;562da483125730608a7d1719&#x27;</span>,
-  <span class="hljs-attribute">priority</span>: <span class="hljs-number">0</span>
-}</code></pre>
-				<a href="#update-1" id="update-1" style="color: inherit; text-decoration: none;">
-					<h4>update</h4>
-				</a>
-				<p><code>mg.routes.update(id, options)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.routes.update(<span class="hljs-string">&#x27;562da483125730608a7d1719&#x27;</span>, {
-    <span class="hljs-attr">priority</span>: <span class="hljs-number">0</span>,
-    <span class="hljs-attr">description</span>: <span class="hljs-string">&#x27;sample&#x27;</span>,
-    <span class="hljs-attr">expression</span>: <span class="hljs-string">&#x27;match_recipient(&quot;.*@example.org&quot;)&#x27;</span>,
-    <span class="hljs-attr">action</span>: [<span class="hljs-string">&#x27;forward(&quot;http://myhost.com/messages/&quot;)&#x27;</span>, <span class="hljs-string">&#x27;stop()&#x27;</span>]
-  })
-  .then(<span class="hljs-function"><span class="hljs-params">data</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(data)) <span class="hljs-comment">// logs response body</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns: response body</p>
-				<pre><code>{
-  <span class="hljs-attribute">actions</span>: [ <span class="hljs-string">&#x27;forward(&quot;http://myhost.com/messages/&quot;)&#x27;</span>, <span class="hljs-string">&#x27;stop()&#x27;</span> ],
-  <span class="hljs-attribute">created_at</span>: <span class="hljs-string">&#x27;Mon, 26 Oct 2015 03:56:51 GMT&#x27;</span>,
-  <span class="hljs-attribute">description</span>: <span class="hljs-string">&#x27;sample&#x27;</span>,
-  <span class="hljs-attribute">expression</span>: <span class="hljs-string">&#x27;match_recipient(&quot;.*@example.com&quot;)&#x27;</span>,
-  <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;562da483125730608a7d1719&#x27;</span>,
-  <span class="hljs-attribute">message</span>: <span class="hljs-string">&#x27;Route has been updated&#x27;</span>,
-  <span class="hljs-attribute">priority</span>: <span class="hljs-number">0</span>
-}</code></pre>
-				<a href="#destroy-2" id="destroy-2" style="color: inherit; text-decoration: none;">
-					<h4>destroy</h4>
-				</a>
-				<p><code>mg.routes.destroy(id)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.routes.destroy(<span class="hljs-string">&#x27;562da483125730608a7d1719&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">data</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(data)) <span class="hljs-comment">// logs response body</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns: response body</p>
-				<pre><code>{
-  <span class="hljs-attribute">id</span>: <span class="hljs-string">&#x27;562da483125730608a7d1719&#x27;</span>,
-  message: <span class="hljs-string">&#x27;Route has been deleted&#x27;</span>
-}</code></pre>
-				<a href="#validate" id="validate" style="color: inherit; text-decoration: none;">
-					<h3>validate</h3>
-				</a>
-				<a href="#get-5" id="get-5" style="color: inherit; text-decoration: none;">
-					<h4>get</h4>
-				</a>
-				<p><code>mg.validate.get(address)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.validate.get(<span class="hljs-string">&#x27;alice@example.com&#x27;</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">data</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(data)) <span class="hljs-comment">// logs response body</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns: response body</p>
-				<pre><code>{
-  <span class="hljs-attr">address:</span> <span class="hljs-string">&#x27;alice@example.com&#x27;</span>,
-  <span class="hljs-attr">did_you_mean:</span> <span class="hljs-literal">null</span>,
-  <span class="hljs-attr">is_valid:</span> <span class="hljs-literal">false</span>,
-  <span class="hljs-attr">parts:</span> { <span class="hljs-attr">display_name:</span> <span class="hljs-literal">null</span>, <span class="hljs-attr">domain:</span> <span class="hljs-literal">null</span>, <span class="hljs-attr">local_part:</span> <span class="hljs-literal">null</span> }
-}</code></pre>
-				<a href="#parse" id="parse" style="color: inherit; text-decoration: none;">
-					<h3>parse</h3>
-				</a>
-				<a href="#get-6" id="get-6" style="color: inherit; text-decoration: none;">
-					<h4>get</h4>
-				</a>
-				<p><code>mg.parse.get(addresses, enableDnsEspChecks)</code></p>
-				<p>Example:</p>
-				<pre><code class="language-js">mg.parse.get(<span class="hljs-string">&#x27;Alice &lt;alice@example.com&gt;, example.com&#x27;</span>, <span class="hljs-literal">true</span>)
-  .then(<span class="hljs-function"><span class="hljs-params">data</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(data)) <span class="hljs-comment">// logs response body</span>
-  .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> <span class="hljs-built_in">console</span>.log(err)); <span class="hljs-comment">// logs any error</span></code></pre>
-				<p>Promise Returns: response body</p>
-				<pre><code>{
-  <span class="hljs-attribute">parsed</span>: [],
-  unparseable: [
-    <span class="hljs-string">&#x27;Alice &lt;alice@example.com&gt;&#x27;</span>,
-    <span class="hljs-string">&#x27;example.com&#x27;</span>
-  ]
-}</code></pre>
-				<a href="#browser-demo" id="browser-demo" style="color: inherit; text-decoration: none;">
-					<h2>Browser Demo</h2>
-				</a>
-				<p><img src="https://cloud.githubusercontent.com/assets/399776/10718632/e8fe56e4-7b34-11e5-84c8-cfcfde978711.png" alt="image"></p>
-				<p>For this demo to work, you&#39;ll need to install and run <code>http-proxy</code> locally. Install it with:</p>
-				<pre><code class="language-sh">npm install -g http-proxy</code></pre>
-				<p>Then run the following command from the mailgun-js directory:</p>
-				<pre><code class="language-sh">http-server -p 4001 --proxy=<span class="hljs-string">&quot;https://api.mailgun.net&quot;</span></code></pre>
-				<p>Demo should be up and running at <a href="http://0.0.0.0:4001/examples/">http://0.0.0.0:4001/examples/</a></p>
-				<a href="#development" id="development" style="color: inherit; text-decoration: none;">
-					<h1>Development</h1>
-				</a>
-				<a href="#requirements" id="requirements" style="color: inherit; text-decoration: none;">
-					<h2>Requirements</h2>
-				</a>
-				<ul>
-					<li>Requires node.js &gt;= 4.x</li>
-				</ul>
-				<p>Install node dependencies with:</p>
-				<pre><code class="language-sh">npm install</code></pre>
-				<a href="#build" id="build" style="color: inherit; text-decoration: none;">
-					<h2>Build</h2>
-				</a>
-				<pre><code class="language-sh">npm run build</code></pre>
-				<a href="#tests" id="tests" style="color: inherit; text-decoration: none;">
-					<h2>Tests</h2>
-				</a>
-				<pre><code class="language-sh">npm run tests</code></pre>
-				<p>Watch tests with</p>
-				<pre><code class="language-sh">npm run watch-tests</code></pre>
-				<a href="#release-process" id="release-process" style="color: inherit; text-decoration: none;">
-					<h2>Release Process</h2>
-				</a>
-				<p>Releases occur after feature branches have been tested and merged into master.</p>
-				<p>First, checkout master and pull the latest commits.</p>
-				<pre><code class="language-sh">git checkout master
-git pull</code></pre>
-				<p>Next, determine semantic version bump (major/minor/patch). Then run <code>npm version</code> with the appropriate keyword.</p>
-				<pre><code class="language-sh">npm version patch -m <span class="hljs-string">&quot;chore(release): added %s&quot;</span></code></pre>
-				<p>Other examples:</p>
-				<pre><code class="language-sh">npm version major -m <span class="hljs-string">&quot;chore(release): added %s&quot;</span>
-npm version minor -m <span class="hljs-string">&quot;chore(release): added %s&quot;</span>
-npm version patch -m <span class="hljs-string">&quot;chore(release): added %s&quot;</span></code></pre>
-				<a href="#todo" id="todo" style="color: inherit; text-decoration: none;">
-					<h2>TODO</h2>
-				</a>
-				<ul>
-					<li>add missing services<ul>
-							<li>Lists<ul>
-									<li><code>lists.list(query)</code></li>
-									<li><code>list.get(address)</code></li>
-									<li><code>list.create(data)</code></li>
-									<li><code>list.update(address, data)</code></li>
-									<li><code>list.destroy(address)</code></li>
-									<li><code>lists.listMembers(address, query)</code></li>
-									<li><code>list.getMember(address, memberAddress)</code></li>
-									<li><code>list.createMember(address, data)</code> (singe &amp; json batch upload)</li>
-									<li><code>list.updateMember(address, memberAddress, data)</code></li>
-									<li><code>list.updateMember(address, memberAddress, data)</code></li>
-									<li><code>list.destroyMember(address, memberAddress)</code></li>
-								</ul>
-							</li>
-						</ul>
-					</li>
-					<li>add browser demo to heroku</li>
-				</ul>
-			</div>
-		</div>
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
-			<nav class="tsd-navigation primary">
-				<ul>
-					<li class="globals  ">
-						<a href="globals.html"><em>Globals</em></a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_index_.html">&quot;index&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_client_.html">&quot;lib/client&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_domains_.html">&quot;lib/domains&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_error_.html">&quot;lib/error&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_events_.html">&quot;lib/events&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_interfaces_apierroroptions_.html">&quot;lib/interfaces/APIError<wbr>Options&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_interfaces_options_.html">&quot;lib/interfaces/<wbr>Options&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_interfaces_requestoptions_.html">&quot;lib/interfaces/<wbr>Request<wbr>Options&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_interfaces_statsoptions_.html">&quot;lib/interfaces/<wbr>Stats<wbr>Options&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_interfaces_supressions_.html">&quot;lib/interfaces/<wbr>Supressions&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_messages_.html">&quot;lib/messages&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_parse_.html">&quot;lib/parse&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_request_.html">&quot;lib/request&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_routes_.html">&quot;lib/routes&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_stats_.html">&quot;lib/stats&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_suppressions_.html">&quot;lib/suppressions&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_validate_.html">&quot;lib/validate&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_lib_webhooks_.html">&quot;lib/webhooks&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_webpack_config_.html">&quot;webpack.config&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="modules/_webpack_release_config_.html">&quot;webpack.release.config&quot;</a>
-					</li>
-				</ul>
-			</nav>
-			<nav class="tsd-navigation secondary menu-sticky">
-				<ul class="before-current">
-				</ul>
-			</nav>
-		</div>
-	</div>
-</div>
-<footer class="with-border-bottom">
-	<div class="container">
-		<h2>Legend</h2>
-		<div class="tsd-legend-group">
-			<ul class="tsd-legend">
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
-			</ul>
-			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
-			</ul>
-			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
-			</ul>
-		</div>
-	</div>
-</footer>
-<div class="container tsd-generator">
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
-</div>
-<div class="overlay"></div>
-<script src="assets/js/main.js"></script>
-</body>
-</html>
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>mailgun.js</title><meta name="description" content="Documentation for mailgun.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">mailgun.js</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> mailgun.js</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
+<a href="#mailgunjs-" id="mailgunjs-" style="color: inherit; text-decoration: none;">
+  <h1>Mailgun.js <a href="https://travis-ci.org/mailgun/mailgun-js"><img src="https://travis-ci.org/mailgun/mailgun-js.svg" alt="Build Status"></a></h1>
+</a>
+<p>A javascript sdk for Mailgun built with webpack, babel &amp; es6. This can be used in node or in the browser*.</p>
+<p>NOTE: If used in the browser, a proxy is required to communicate with the Mailgun api due to cors limitations. Also, do not publish your private api key in frontend code.</p>
+<p><strong>Table of Contents</strong></p>
+<ul>
+<li><a href="#documentation">Documentation</a><ul>
+<li><a href="#install">Install</a></li>
+<li><a href="#setup-client">Setup Client</a></li>
+<li><a href="#methods">Methods</a></li>
+<li><a href="#browser-demo">Browser Demo</a></li>
+<li><a href="https://github.com/mailgun/mailgun-js/tree/master/examples">Examples</a></li>
+</ul>
+</li>
+<li><a href="#development">Development</a><ul>
+<li><a href="#requirements">Requirements</a></li>
+<li><a href="#build">Build</a></li>
+<li><a href="#tests">Tests</a></li>
+<li><a href="#release-process">Release Process</a></li>
+</ul>
+</li>
+</ul>
+<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
+  <h1>Documentation</h1>
+</a>
+<a href="#install" id="install" style="color: inherit; text-decoration: none;">
+  <h2>Install</h2>
+</a>
+<ul>
+<li>Requires node.js &gt;= 12.x</li>
+</ul>
+<p>Install mailgun.js with:</p>
+<pre><code class="language-sh"><span class="hl-0">npm install mailgun.js</span>
+</code></pre>
+<a href="#setup-client" id="setup-client" style="color: inherit; text-decoration: none;">
+  <h2>Setup Client</h2>
+</a>
+<p>Next, require the module and instantiate a mailgun client by calling <code>new Mailgun(formData)</code> and then using <code>mailgun.client</code> setup the client with basic auth credentials <code>(username: &#39;api&#39;, key: &#39;key-yourkeyhere&#39;)</code>.</p>
+<p>NOTE: starting from version 3.0 you need to pass FormData (we need this to keep library universal). For node.js you can use <code>form-data</code> library.</p>
+<pre><code class="language-js"><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">formData</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">&#39;form-data&#39;</span><span class="hl-0">);</span><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">Mailgun</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">&#39;mailgun.js&#39;</span><span class="hl-0">);</span><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">mailgun</span><span class="hl-0"> = </span><span class="hl-1">new</span><span class="hl-0"> </span><span class="hl-3">Mailgun</span><span class="hl-0">(</span><span class="hl-5">formData</span><span class="hl-0">);</span><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">mg</span><span class="hl-0"> = </span><span class="hl-5">mailgun</span><span class="hl-0">.</span><span class="hl-3">client</span><span class="hl-0">({</span><span class="hl-5">username:</span><span class="hl-0"> </span><span class="hl-4">&#39;api&#39;</span><span class="hl-0">, </span><span class="hl-5">key:</span><span class="hl-0"> </span><span class="hl-5">process</span><span class="hl-0">.</span><span class="hl-5">env</span><span class="hl-0">.</span><span class="hl-2">MAILGUN_API_KEY</span><span class="hl-0"> || </span><span class="hl-4">&#39;key-yourkeyhere&#39;</span><span class="hl-0">});</span>
+</code></pre>
+<p>To use <code>validate</code> and <code>parse</code> methods, you must additionally include <code>public_key</code>. If you&#39;re using only those methods, <code>key</code> can be an empty string.</p>
+<pre><code class="language-js"><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">mg</span><span class="hl-0"> = </span><span class="hl-5">mailgun</span><span class="hl-0">.</span><span class="hl-3">client</span><span class="hl-0">({</span><br/><span class="hl-0">  </span><span class="hl-5">username:</span><span class="hl-0"> </span><span class="hl-4">&#39;api&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">key:</span><span class="hl-0"> </span><span class="hl-5">process</span><span class="hl-0">.</span><span class="hl-5">env</span><span class="hl-0">.</span><span class="hl-2">MAILGUN_API_KEY</span><span class="hl-0"> || </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">public_key:</span><span class="hl-0"> </span><span class="hl-5">process</span><span class="hl-0">.</span><span class="hl-5">env</span><span class="hl-0">.</span><span class="hl-2">MAILGUN_PUBLIC_KEY</span><span class="hl-0"> || </span><span class="hl-4">&#39;pubkey-yourkeyhere&#39;</span><br/><span class="hl-0">});</span>
+</code></pre>
+<p>In the case your mailgun account is eu hosted you would need to define eu&#39;s subdomain as <code>url</code> in mailgun&#39;s Client constructor:</p>
+<pre><code class="language-js"><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">mg</span><span class="hl-0"> = </span><span class="hl-5">mailgun</span><span class="hl-0">.</span><span class="hl-3">client</span><span class="hl-0">({</span><span class="hl-5">username:</span><span class="hl-0"> </span><span class="hl-4">&#39;api&#39;</span><span class="hl-0">, </span><span class="hl-5">key:</span><span class="hl-0"> </span><span class="hl-5">process</span><span class="hl-0">.</span><span class="hl-5">env</span><span class="hl-0">.</span><span class="hl-2">MAILGUN_API_KEY</span><span class="hl-0"> || </span><span class="hl-4">&#39;key-yourkeyhere&#39;</span><span class="hl-0">, </span><span class="hl-5">url:</span><span class="hl-0"> </span><span class="hl-4">&#39;https://api.eu.mailgun.net&#39;</span><span class="hl-0">});</span>
+</code></pre>
+<a href="#methods" id="methods" style="color: inherit; text-decoration: none;">
+  <h2>Methods</h2>
+</a>
+<p>The following service methods are available to instantiated clients. The examples assume you have already created a mailgun client as <code>mg</code> with valid credentials.</p>
+<ul>
+<li><a href="#mailgunjs-img-srchttpstravis-ciorgmailgunmailgun-jssvg-altbuild-status">Mailgun.js <img src="https://travis-ci.org/mailgun/mailgun-js" alt="Build Status"></a></li>
+<li><a href="#documentation">Documentation</a><ul>
+<li><a href="#install">Install</a></li>
+<li><a href="#setup-client">Setup Client</a></li>
+<li><a href="#methods">Methods</a><ul>
+<li><a href="#messages">messages</a><ul>
+<li><a href="#create">create</a></li>
+</ul>
+</li>
+<li><a href="#domains">domains</a><ul>
+<li><a href="#list">list</a></li>
+<li><a href="#get">get</a></li>
+<li><a href="#create-1">create</a></li>
+<li><a href="#destroy">destroy</a></li>
+<li><a href="#gettracking">getTracking</a></li>
+<li><a href="#updatetracking">updateTracking</a></li>
+<li><a href="#getips">getIps</a></li>
+<li><a href="#assignip">assignIp</a></li>
+</ul>
+</li>
+<li><a href="#events">events</a><ul>
+<li><a href="#get-1">get</a></li>
+</ul>
+</li>
+<li><a href="#stats">stats</a><ul>
+<li><a href="#getdomain">getDomain</a></li>
+<li><a href="#getaccount">getAccount</a></li>
+</ul>
+</li>
+<li><a href="#suppressions">suppressions</a><ul>
+<li><a href="#list-1">list</a></li>
+<li><a href="#get-2">get</a></li>
+<li><a href="#create-2">create</a></li>
+</ul>
+</li>
+<li><a href="#webhooks">webhooks</a><ul>
+<li><a href="#list-2">list</a></li>
+<li><a href="#get-3">get</a></li>
+<li><a href="#create-3">create</a></li>
+<li><a href="#update">update</a></li>
+<li><a href="#destroy-1">destroy</a></li>
+</ul>
+</li>
+<li><a href="#routes">routes</a><ul>
+<li><a href="#list-3">list</a></li>
+<li><a href="#get-4">get</a></li>
+<li><a href="#create-4">create</a></li>
+<li><a href="#update-1">update</a></li>
+<li><a href="#destroy-2">destroy</a></li>
+</ul>
+</li>
+<li><a href="#validate">validate</a><ul>
+<li><a href="#get-5">get</a></li>
+</ul>
+</li>
+<li><a href="#parse">parse</a><ul>
+<li><a href="#get-6">get</a></li>
+</ul>
+</li>
+<li><a href="#lists">lists</a><ul>
+<li><a href="#list-4">list</a></li>
+<li><a href="#get-7">get</a></li>
+<li><a href="#create-5">create</a></li>
+<li><a href="#update-2">update</a></li>
+<li><a href="#destroy-3">destroy</a></li>
+</ul>
+</li>
+<li><a href="#maillistmembers">mailListMembers</a><ul>
+<li><a href="#listmember">listMembers</a></li>
+<li><a href="#getmember">getMember</a></li>
+<li><a href="#createmember">createMember</a></li>
+<li><a href="#createmembers">createMembers</a></li>
+<li><a href="#updatemember">updateMember</a></li>
+<li><a href="#destroymember">destroyMember</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a href="#browser-demo">Browser Demo</a></li>
+</ul>
+</li>
+<li><a href="#development">Development</a><ul>
+<li><a href="#requirements">Requirements</a></li>
+<li><a href="#build">Build</a></li>
+<li><a href="#tests">Tests</a></li>
+<li><a href="#release-process">Release Process</a></li>
+<li><a href="#todo">TODO</a></li>
+</ul>
+</li>
+</ul>
+<p>Method naming conventions:</p>
+<ul>
+<li><code>get</code> or <code>get{{Item}}</code> - expected response for client is a single object</li>
+<li><code>list</code> or <code>list{{Items}}</code> - expected response for client is a list of objects</li>
+<li><code>create</code> or <code>create{{Item}}</code> - expected response for client is a single object</li>
+<li><code>update</code> or <code>update{{Item}}</code> - expected response is an object with a status message</li>
+<li><code>destroy</code> or <code>destroy{{Item}}</code> - expected response is an object with a status message</li>
+</ul>
+<a href="#messages" id="messages" style="color: inherit; text-decoration: none;">
+  <h3>messages</h3>
+</a>
+<a href="#create" id="create" style="color: inherit; text-decoration: none;">
+  <h4>create</h4>
+</a>
+<p><code>mg.messages.create(domain, data)</code> - <a href="https://documentation.mailgun.com/en/latest/api-sending.html">api docs</a></p>
+<p>Options:</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">to</td>
+<td align="left">Email address of the recipient(s). Example: &quot;Bob <a href="mailto:bob@host.com">bob@host.com</a>&quot;. You can use commas to separate multiple recipients (e.g.: &quot;<a href="mailto:test@example.com">test@example.com</a>,<a href="mailto:test@example.com">test@example.com</a>&quot; or [&quot;<a href="mailto:test@example.com">test@example.com</a>&quot;, &quot;<a href="mailto:test@example.com">test@example.com</a>&quot;]). Make sure to include all To, Cc and Bcc recipients of the message.</td>
+</tr>
+<tr>
+<td align="left">html</td>
+<td align="left">HTML version of the message.</td>
+</tr>
+<tr>
+<td align="left">text</td>
+<td align="left">Text version of the message.</td>
+</tr>
+<tr>
+<td align="left">message</td>
+<td align="left">MIME string of the message. Make sure to use multipart/form-data to send this as a file upload.</td>
+</tr>
+<tr>
+<td align="left">attachment</td>
+<td align="left">File attachment. You can post multiple attachment values. Important: You must use multipart/form-data encoding when sending attachments. Also you can use <code>{data: file, filename: filename}</code> to define custom filename.</td>
+</tr>
+<tr>
+<td align="left">o:tag</td>
+<td align="left">Tag string. See Tagging for more information.</td>
+</tr>
+<tr>
+<td align="left">o:campaign</td>
+<td align="left">Id of the campaign the message belongs to. See um-campaign-analytics for details.</td>
+</tr>
+<tr>
+<td align="left">o:deliverytime</td>
+<td align="left">Desired time of delivery. See Date Format. Note: Messages can be scheduled for a maximum of 3 days in the future.</td>
+</tr>
+<tr>
+<td align="left">o:dkim</td>
+<td align="left">Enables/disabled DKIM signatures on per-message basis. Pass yes or no</td>
+</tr>
+<tr>
+<td align="left">o:testmode</td>
+<td align="left">Enables sending in test mode. Pass yes if needed. See Sending in Test Mode</td>
+</tr>
+<tr>
+<td align="left">o:tracking</td>
+<td align="left">Toggles tracking on a per-message basis, see Tracking Messages for details. Pass yes or no.</td>
+</tr>
+<tr>
+<td align="left">o:tracking-clicks</td>
+<td align="left">Toggles clicks tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes, no or htmlonly.</td>
+</tr>
+<tr>
+<td align="left">o:tracking-opens</td>
+<td align="left">Toggles opens tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes or no.</td>
+</tr>
+<tr>
+<td align="left">h:X-My-Header</td>
+<td align="left">h: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case). For example, h:Reply-To to specify Reply-To address.</td>
+</tr>
+<tr>
+<td align="left">v:my-var</td>
+<td align="left">v: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See Attaching Data to Messages for more information.</td>
+</tr>
+</tbody></table>
+<ul>
+<li><p>HTML/TEXT Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">messages</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-4">&#39;sandbox-123.mailgun.org&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">    </span><span class="hl-5">from:</span><span class="hl-0"> </span><span class="hl-4">&quot;Excited User &lt;mailgun@sandbox-123.mailgun.org&gt;&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">to:</span><span class="hl-0"> [</span><span class="hl-4">&quot;test@example.com&quot;</span><span class="hl-0">],</span><br/><span class="hl-0">    </span><span class="hl-5">subject:</span><span class="hl-0"> </span><span class="hl-4">&quot;Hello&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">text:</span><span class="hl-0"> </span><span class="hl-4">&quot;Testing some Mailgun awesomness!&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">html:</span><span class="hl-0"> </span><span class="hl-4">&quot;&lt;h1&gt;Testing some Mailgun awesomness!&lt;/h1&gt;&quot;</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+</li>
+<li><p>MIME Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">messages</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-4">&#39;sandbox-123.mailgun.org&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">    </span><span class="hl-5">from:</span><span class="hl-0"> </span><span class="hl-4">&quot;Excited User &lt;mailgun@sandbox-123.mailgun.org&gt;&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">to:</span><span class="hl-0"> [</span><span class="hl-4">&quot;test@example.com&quot;</span><span class="hl-0">],</span><br/><span class="hl-0">    </span><span class="hl-5">subject:</span><span class="hl-0"> </span><span class="hl-4">&quot;Hello&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">text:</span><span class="hl-0"> </span><span class="hl-4">&quot;&lt;mime encoded string here&gt;&quot;</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+</li>
+</ul>
+<p>Messages with attachments:</p>
+<ul>
+<li><p>Node.js example of send file as an attachment</p>
+<pre><code class="language-js"><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">fsPromises</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">&#39;fs&#39;</span><span class="hl-0">).</span><span class="hl-5">promises</span><span class="hl-0">;</span><br/><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">path</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">&#39;path&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">filepath</span><span class="hl-0"> = </span><span class="hl-5">path</span><span class="hl-0">.</span><span class="hl-3">resolve</span><span class="hl-0">(</span><span class="hl-5">__dirname</span><span class="hl-0">, </span><span class="hl-4">&#39;../test.pdf&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">  </span><span class="hl-1">let</span><span class="hl-0"> </span><span class="hl-5">messageParams</span><span class="hl-0"> = {</span><br/><span class="hl-0">      </span><span class="hl-5">from:</span><span class="hl-0"> </span><span class="hl-4">&quot;Excited User &lt;mailgun@sandbox-123.mailgun.org&gt;&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-5">to:</span><span class="hl-0"> [</span><span class="hl-4">&quot;test@example.com&quot;</span><span class="hl-0">],</span><br/><span class="hl-0">      </span><span class="hl-5">subject:</span><span class="hl-0"> </span><span class="hl-4">&quot;Test subject&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-5">text:</span><span class="hl-0"> </span><span class="hl-4">&quot;Hello here is a file in the attachment&quot;</span><br/><span class="hl-0">  }</span><br/><br/><span class="hl-0">  </span><span class="hl-5">fsPromises</span><span class="hl-0">.</span><span class="hl-3">readFile</span><span class="hl-0">(</span><span class="hl-5">filepath</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">    </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">file</span><span class="hl-0"> = {</span><br/><span class="hl-0">        </span><span class="hl-5">filename:</span><span class="hl-0"> </span><span class="hl-4">&#39;test-rename.pdf&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">        </span><span class="hl-5">data</span><br/><span class="hl-0">    }</span><br/><span class="hl-0">    </span><span class="hl-5">messageParams</span><span class="hl-0">.</span><span class="hl-5">attachment</span><span class="hl-0"> = </span><span class="hl-5">file</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-7">return</span><span class="hl-0"> </span><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">messages</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-4">&#39;sandbox-123.mailgun.org&#39;</span><span class="hl-0">, </span><span class="hl-5">messageParams</span><span class="hl-0">);</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">response</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">      </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">response</span><span class="hl-0">);</span><br/><span class="hl-0">  })</span>
+</code></pre>
+</li>
+<li><p>Node.js example of send multiple files as an attachment</p>
+<pre><code class="language-js"><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">fsPromises</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">&#39;fs&#39;</span><span class="hl-0">).</span><span class="hl-5">promises</span><span class="hl-0">;</span><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">path</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">&#39;path&#39;</span><span class="hl-0">);</span><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">filepath</span><span class="hl-0"> = </span><span class="hl-5">path</span><span class="hl-0">.</span><span class="hl-3">resolve</span><span class="hl-0">(</span><span class="hl-5">__dirname</span><span class="hl-0">, </span><span class="hl-4">&#39;../test.pdf&#39;</span><span class="hl-0">);</span><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">filepath1</span><span class="hl-0"> = </span><span class="hl-5">path</span><span class="hl-0">.</span><span class="hl-3">resolve</span><span class="hl-0">(</span><span class="hl-5">__dirname</span><span class="hl-0">, </span><span class="hl-4">&#39;../test.jpg&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-1">let</span><span class="hl-0"> </span><span class="hl-5">messageParams</span><span class="hl-0"> = {</span><br/><span class="hl-0">    </span><span class="hl-5">from:</span><span class="hl-0"> </span><span class="hl-4">&quot;Excited User &lt;mailgun@sandbox-123.mailgun.org&gt;&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">to:</span><span class="hl-0"> [</span><span class="hl-4">&quot;test@example.com&quot;</span><span class="hl-0">],</span><br/><span class="hl-0">    </span><span class="hl-5">subject:</span><span class="hl-0"> </span><span class="hl-4">&quot;Test subject&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">text:</span><span class="hl-0"> </span><span class="hl-4">&quot;Test message&quot;</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-0">(</span><span class="hl-1">async</span><span class="hl-0"> () </span><span class="hl-1">=&gt;</span><span class="hl-0">{</span><br/><span class="hl-0">    </span><span class="hl-7">try</span><span class="hl-0"> {</span><br/><span class="hl-0">        </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">firstFile</span><span class="hl-0"> = {</span><br/><span class="hl-0">            </span><span class="hl-5">filename:</span><span class="hl-0"> </span><span class="hl-4">&#39;test.pdf&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">            </span><span class="hl-5">data:</span><span class="hl-0"> </span><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-5">fsPromises</span><span class="hl-0">.</span><span class="hl-3">readFile</span><span class="hl-0">(</span><span class="hl-5">filepath</span><span class="hl-0">)</span><br/><span class="hl-0">        }</span><br/><br/><span class="hl-0">        </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">secondFile</span><span class="hl-0"> = {</span><br/><span class="hl-0">            </span><span class="hl-5">filename:</span><span class="hl-0"> </span><span class="hl-4">&#39;test.jpg&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">            </span><span class="hl-5">data:</span><span class="hl-0"> </span><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-5">fsPromises</span><span class="hl-0">.</span><span class="hl-3">readFile</span><span class="hl-0">(</span><span class="hl-5">filepath1</span><span class="hl-0">)</span><br/><span class="hl-0">        }</span><br/><br/><span class="hl-0">        </span><span class="hl-5">messageParams</span><span class="hl-0">.</span><span class="hl-5">attachment</span><span class="hl-0"> = [</span><span class="hl-5">firstFile</span><span class="hl-0">, </span><span class="hl-5">secondFile</span><span class="hl-0">];</span><br/><span class="hl-0">        </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">result</span><span class="hl-0"> =  </span><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">messages</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-4">&#39;sandbox-123.mailgun.org&#39;</span><span class="hl-0">, </span><span class="hl-5">messageParams</span><span class="hl-0">);</span><br/><span class="hl-0">        </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">result</span><span class="hl-0">);</span><br/><span class="hl-0">        } </span><span class="hl-7">catch</span><span class="hl-0"> (</span><span class="hl-5">error</span><span class="hl-0">) {</span><br/><span class="hl-0">            </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">error</span><span class="hl-0">(</span><span class="hl-5">error</span><span class="hl-0">);</span><br/><span class="hl-0">        }</span><br/><span class="hl-0">})()</span>
+</code></pre>
+</li>
+<li><p>Node.js example of send file as inline image</p>
+<pre><code class="language-js"><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">fsPromises</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">&#39;fs&#39;</span><span class="hl-0">).</span><span class="hl-5">promises</span><span class="hl-0">;</span><br/><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">path</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">&#39;path&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">filepath</span><span class="hl-0"> = </span><span class="hl-5">path</span><span class="hl-0">.</span><span class="hl-3">resolve</span><span class="hl-0">(</span><span class="hl-5">__dirname</span><span class="hl-0">, </span><span class="hl-4">&#39;../test.jpg&#39;</span><span class="hl-0">);</span><br/><span class="hl-0">  </span><span class="hl-1">let</span><span class="hl-0"> </span><span class="hl-5">messageParams</span><span class="hl-0"> = {</span><br/><span class="hl-0">      </span><span class="hl-5">from:</span><span class="hl-0"> </span><span class="hl-4">&quot;Excited User &lt;mailgun@sandbox-123.mailgun.org&gt;&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-5">to:</span><span class="hl-0"> [</span><span class="hl-4">&quot;test@example.com&quot;</span><span class="hl-0">],</span><br/><span class="hl-0">      </span><span class="hl-5">subject:</span><span class="hl-0"> </span><span class="hl-4">&quot;Test subject&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-5">html:</span><span class="hl-0"> </span><span class="hl-4">&#39;&lt;div&gt;&lt;img alt=&quot;image&quot; id=&quot;1&quot; src=&quot;cid:test.jpg&quot;/&gt;&lt;/div&gt; Some extra text&#39;</span><br/><span class="hl-0">  }</span><br/><br/><span class="hl-0">  </span><span class="hl-5">fsPromises</span><span class="hl-0">.</span><span class="hl-3">readFile</span><span class="hl-0">(</span><span class="hl-5">filepath</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">    </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">file</span><span class="hl-0"> = {</span><br/><span class="hl-0">        </span><span class="hl-5">filename:</span><span class="hl-0"> </span><span class="hl-4">&#39;test.jpg&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">        </span><span class="hl-5">data</span><br/><span class="hl-0">    }</span><br/><br/><span class="hl-0">    </span><span class="hl-5">messageParams</span><span class="hl-0">.</span><span class="hl-5">inline</span><span class="hl-0"> = </span><span class="hl-5">file</span><span class="hl-0">;</span><br/><span class="hl-0">    </span><span class="hl-7">return</span><span class="hl-0"> </span><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">messages</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-4">&#39;sandbox-123.mailgun.org&#39;</span><span class="hl-0">, </span><span class="hl-5">messageParams</span><span class="hl-0">);</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">response</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">      </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">response</span><span class="hl-0">);</span><br/><span class="hl-0">  })</span>
+</code></pre>
+</li>
+<li><p>Browser example of send file</p>
+<p>Before sending the file you need to somehow get the Blob of the file.
+Usually can get it from the onChange event of input tag with type file.</p>
+<pre><code class="language-js"><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-3">handleFileSelected</span><span class="hl-0"> = </span><span class="hl-1">async</span><span class="hl-0"> (</span><span class="hl-5">event</span><span class="hl-0">) </span><span class="hl-1">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">files</span><span class="hl-0"> = </span><span class="hl-8">Array</span><span class="hl-0">.</span><span class="hl-3">from</span><span class="hl-0">(</span><span class="hl-5">event</span><span class="hl-0">.</span><span class="hl-5">target</span><span class="hl-0">.</span><span class="hl-5">files</span><span class="hl-0">)</span><br/><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">fileBuffer</span><span class="hl-0"> = </span><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-5">files</span><span class="hl-0">[</span><span class="hl-9">0</span><span class="hl-0">];</span><br/><span class="hl-0">}</span><br/><span class="hl-10">&lt;</span><span class="hl-11">input</span><span class="hl-0"> </span><span class="hl-12">type</span><span class="hl-0">=</span><span class="hl-4">&quot;file&quot;</span><span class="hl-0"> </span><span class="hl-12">onChange</span><span class="hl-0">=</span><span class="hl-1">{</span><span class="hl-5">handleFileSelected</span><span class="hl-1">}</span><span class="hl-0"> </span><span class="hl-12">name</span><span class="hl-0">=</span><span class="hl-4">&quot;file-uploader&quot;</span><span class="hl-10">/&gt;</span>
+</code></pre>
+<p>Then you can use the same approach as shown above for node.js apps.</p>
+<pre><code class="language-js"><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">file</span><span class="hl-0"> = {</span><br/><span class="hl-0">    </span><span class="hl-5">filename:</span><span class="hl-0"> </span><span class="hl-4">&#39;test.pdf&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">data:</span><span class="hl-0"> </span><span class="hl-5">fileBuffer</span><br/><span class="hl-0">  };</span><br/><br/><span class="hl-0">  </span><span class="hl-1">let</span><span class="hl-0"> </span><span class="hl-5">messageParams</span><span class="hl-0"> = {</span><br/><span class="hl-0">    </span><span class="hl-5">from:</span><span class="hl-0"> </span><span class="hl-4">&quot;Excited User &lt;mailgun@sandbox-123.mailgun.org&gt;&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">to:</span><span class="hl-0"> [</span><span class="hl-4">&quot;test@example.com&quot;</span><span class="hl-0">],</span><br/><span class="hl-0">    </span><span class="hl-5">subject:</span><span class="hl-0"> </span><span class="hl-4">&quot;Test subject&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">text:</span><span class="hl-0"> </span><span class="hl-4">&quot;Hello here is a file in the attachment&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">attachment:</span><span class="hl-0"> </span><span class="hl-5">file</span><br/><span class="hl-0">  };</span><br/><br/><span class="hl-0">  </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">res</span><span class="hl-0"> = </span><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">messages</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-2">DOMAIN</span><span class="hl-0">, </span><span class="hl-5">messageParams</span><span class="hl-0">);</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code class="language-js"><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;&lt;20151025002517.117282.79817@sandbox-123.mailgun.org&gt;&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;Queued. Thank you.&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+</li>
+</ul>
+<a href="#templates" id="templates" style="color: inherit; text-decoration: none;">
+  <h4>Templates</h4>
+</a>
+<p>Mailgun’s templates uses a fork of the very popular template engine <a href="https://handlebarsjs.com/">handlebars</a>.</p>
+<p>To provide values for a substitution you need to use &#39;h:X-Mailgun-Variables&#39; property in the message description.</p>
+<p>Make sure that this property is a JSON string like {&quot;title&quot;:&quot;A title&quot;, &quot;body&quot;:&quot;The body&quot;}.</p>
+<p>You can find few examples of how to use templates below.</p>
+<ul>
+<li><p>Providing values for <strong>title</strong> and <strong>slug</strong> variables to render in template
+```js
+...
+const {
+  title,
+  slug,
+} = someDataSource;</p>
+<p>const mailgunData = {
+  from: &#39;<a href="mailto:mailer@example.com">mailer@example.com</a>&gt;&#39;,
+  to: &#39;<a href="mailto:recipient@example.com">recipient@example.com</a>&#39;,
+  subject: <code>Email ${title}</code>,
+  template: &#39;name-of-the-template-you-made-in-mailgun-web-portal&#39;,
+  &#39;h:X-Mailgun-Variables&#39;: JSON.stringify({ // be sure to stringify your payload
+title,
+slug,
+  }),
+  &#39;h:Reply-To&#39;: &#39;<a href="mailto:reply-to@example.com">reply-to@example.com</a>&#39;,
+};</p>
+<p>try {
+  const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);</p>
+</li>
+</ul>
+<p>...</p>
+<pre><code><br/><span class="hl-0">- </span><span class="hl-5">Providing</span><span class="hl-0"> </span><span class="hl-5">an</span><span class="hl-0"> </span><span class="hl-5">array</span><span class="hl-0"> </span><span class="hl-1">of</span><span class="hl-0"> </span><span class="hl-5">objects</span><span class="hl-0"> </span><span class="hl-5">to</span><span class="hl-0"> </span><span class="hl-5">render</span><span class="hl-0"> </span><span class="hl-5">them</span><span class="hl-0"> </span><span class="hl-1">in</span><span class="hl-0"> </span><span class="hl-5">the</span><span class="hl-0"> </span><span class="hl-5">template</span><br/><span class="hl-4">```JS</span><br/><span class="hl-4">  ...</span><br/><span class="hl-4">  const mailgunData = {</span><br/><span class="hl-4">    from: &#39;mailer@example.com&gt;&#39;,</span><br/><span class="hl-4">    to: &#39;recipient@example.com&#39;,</span><br/><span class="hl-4">    subject: `</span><span class="hl-5">Email</span><span class="hl-0"> </span><span class="hl-5">$</span><span class="hl-0">{</span><span class="hl-5">title</span><span class="hl-0">}</span><span class="hl-4">`,</span><br/><span class="hl-4">    template: &#39;name-of-the-another-template-you-made-in-mailgun-web-portal&#39;,</span><br/><span class="hl-4">    &#39;h:X-Mailgun-Variables&#39;: JSON.stringify({</span><br/><span class="hl-4">    &quot;arrayItems&quot;: [</span><br/><span class="hl-4">        {</span><br/><span class="hl-4">            &quot;question&quot;: &quot;test_question&quot;,</span><br/><span class="hl-4">            &quot;answer&quot;: &quot;test_answer&quot;</span><br/><span class="hl-4">        },</span><br/><span class="hl-4">        {</span><br/><span class="hl-4">            &quot;question&quot;: &quot;test_question&quot;,</span><br/><span class="hl-4">            &quot;answer&quot;: &quot;test_answer&quot;</span><br/><span class="hl-4">        }</span><br/><span class="hl-4">    ]})</span><br/><span class="hl-4">  };</span><br/><span class="hl-4">  try {</span><br/><span class="hl-4">    const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);</span><br/><span class="hl-4">  ...</span>
+</code></pre>
+<a href="#recipient-variables" id="recipient-variables" style="color: inherit; text-decoration: none;">
+  <h4>Recipient Variables</h4>
+</a>
+<p><a href="https://documentation.mailgun.com/en/latest/user_manual.html#batch-sending">Docs</a></p>
+<p>Recipient Variables are custom variables that you define, which you can then reference in the message body. They give you the ability to send a custom message to each recipient while still using a single API Call.</p>
+<pre><code class="language-Js"><span class="hl-0">...</span><br/><span class="hl-0"> </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">mailgunData</span><span class="hl-0"> = {</span><br/><span class="hl-0">    </span><span class="hl-5">from:</span><span class="hl-0"> </span><span class="hl-4">&#39;Example.com Mailer &lt;mailer@mailer.example.com&gt;&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">to:</span><span class="hl-0"> [</span><span class="hl-4">&#39;me@example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;you@example.com&#39;</span><span class="hl-0">],</span><br/><span class="hl-0">    </span><span class="hl-5">subject:</span><span class="hl-0"> </span><span class="hl-4">&#39;Recipient - %recipient.title%&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">html:</span><span class="hl-0"> </span><span class="hl-4">&#39;Here</span><span class="hl-14">\&#39;</span><span class="hl-4">s %recipient.title% and &lt;a href=&quot;%recipient.link%&quot;&gt;link&lt;/a&gt;&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-4">&#39;recipient-variables&#39;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-8">JSON</span><span class="hl-0">.</span><span class="hl-3">stringify</span><span class="hl-0">({</span><br/><span class="hl-0">      </span><span class="hl-4">&#39;me@example.com&#39;</span><span class="hl-5">:</span><span class="hl-0"> {</span><br/><span class="hl-0">        </span><span class="hl-5">title:</span><span class="hl-0"> </span><span class="hl-4">&#39;Me&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">        </span><span class="hl-5">link:</span><span class="hl-0"> </span><span class="hl-4">&#39;href-var&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">      },</span><br/><span class="hl-0">      </span><span class="hl-4">&#39;you@example.com&#39;</span><span class="hl-5">:</span><span class="hl-0"> {</span><br/><span class="hl-0">        </span><span class="hl-5">title:</span><span class="hl-0"> </span><span class="hl-4">&#39;You&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">        </span><span class="hl-5">link:</span><span class="hl-0"> </span><span class="hl-4">&#39;slug-recipient-var-c&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">      },</span><br/><span class="hl-0">    }),</span><br/><span class="hl-0">  };</span><br/><br/><span class="hl-0">  </span><span class="hl-7">try</span><span class="hl-0"> {</span><br/><span class="hl-0">    </span><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">response</span><span class="hl-0"> = </span><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-5">mailgun</span><span class="hl-0">.</span><span class="hl-5">messages</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-2">DOMAIN_NAME</span><span class="hl-0">, </span><span class="hl-5">mailgunData</span><span class="hl-0">);</span><br/><span class="hl-0">...</span>
+</code></pre>
+<a href="#domains" id="domains" style="color: inherit; text-decoration: none;">
+  <h3>domains</h3>
+</a>
+<a href="#list" id="list" style="color: inherit; text-decoration: none;">
+  <h4>list</h4>
+</a>
+<p><code>mg.domains.list(query)</code> - <a href="https://documentation.mailgun.com/api-domains.html">api docs</a></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">list</span><span class="hl-0">()</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">domains</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">domains</span><span class="hl-0">)) </span><span class="hl-6">// logs array of domains</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: array of Domain instances</p>
+<pre><code><span class="hl-0">[{</span><br/><span class="hl-0">  </span><span class="hl-5">created_at:</span><span class="hl-0"> </span><span class="hl-4">&#39;Sun, 19 Oct 2014 18:49:36 GMT&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&#39;testing.example.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">receiving_dns_records:</span><span class="hl-0"> </span><span class="hl-1">null</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">require_tls:</span><span class="hl-0"> </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">sending_dns_records:</span><span class="hl-0"> </span><span class="hl-1">null</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">skip_verification:</span><span class="hl-0"> </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">smtp_login:</span><span class="hl-0"> </span><span class="hl-4">&#39;postmaster@testing.example.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">smtp_password:</span><span class="hl-0"> </span><span class="hl-4">&#39;password&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">spam_action:</span><span class="hl-0"> </span><span class="hl-4">&#39;disabled&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">state:</span><span class="hl-0"> </span><span class="hl-4">&#39;unverified&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">type:</span><span class="hl-0"> </span><span class="hl-4">&#39;custom&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-5">wildcard:</span><span class="hl-0"> </span><span class="hl-1">true</span><br/><span class="hl-0">}]</span>
+</code></pre>
+<p>Options</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">limit</td>
+<td align="left">Maximum number of records to return. (100 by default)</td>
+</tr>
+<tr>
+<td align="left">skip</td>
+<td align="left">Number of records to skip. (0 by default)</td>
+</tr>
+</tbody></table>
+<a href="#get" id="get" style="color: inherit; text-decoration: none;">
+  <h4>get</h4>
+</a>
+<p><code>mg.domains.get()</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">()</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">domains</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">domains</span><span class="hl-0">)) </span><span class="hl-6">// logs array of domains</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: Domain instance</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-4">&#39;Sun, 19 Oct 2014 18:49:36 GMT&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">name</span><span class="hl-0">: </span><span class="hl-4">&#39;testing.example.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">receiving_dns_records</span><span class="hl-0">: [{</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;name&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;testing.example.com&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;TXT&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;v=spf1 include:mailgun.org ~all&quot;</span><br/><span class="hl-0">    },</span><br/><span class="hl-0">    {</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;name&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;k1._domainkey.testing.example.com&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;TXT&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;k=rsa; 123456&quot;</span><br/><span class="hl-0">    },</span><br/><span class="hl-0">    {</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;name&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;email.testing.example.com&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;CNAME&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;mailgun.org&quot;</span><br/><span class="hl-0">    }],</span><br/><span class="hl-0">  </span><span class="hl-13">require_tls</span><span class="hl-0">: </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">sending_dns_records</span><span class="hl-0">: [{</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;priority&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;10&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;MX&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;mxa.mailgun.org&quot;</span><br/><span class="hl-0">    },</span><br/><span class="hl-0">    {</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;priority&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;10&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;MX&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;mxb.mailgun.org&quot;</span><br/><span class="hl-0">    }],</span><br/><span class="hl-0">  </span><span class="hl-13">skip_verification</span><span class="hl-0">: </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">smtp_login</span><span class="hl-0">: </span><span class="hl-4">&#39;postmaster@testing.example.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">smtp_password</span><span class="hl-0">: </span><span class="hl-4">&#39;password&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">spam_action</span><span class="hl-0">: </span><span class="hl-4">&#39;disabled&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">state</span><span class="hl-0">: </span><span class="hl-4">&#39;unverified&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">type</span><span class="hl-0">: </span><span class="hl-4">&#39;custom&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">wildcard</span><span class="hl-0">: </span><span class="hl-1">true</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#create-1" id="create-1" style="color: inherit; text-decoration: none;">
+  <h4>create</h4>
+</a>
+<p><code>mg.domains.create(data)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">({</span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">})</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Options:</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">name</td>
+<td align="left">Name of the domain (ex. domain.com)</td>
+</tr>
+<tr>
+<td align="left">smtp_password</td>
+<td align="left">Password for SMTP authentication</td>
+</tr>
+<tr>
+<td align="left">spam_action</td>
+<td align="left">disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged wtih a spam header. See Spam Filter.</td>
+</tr>
+<tr>
+<td align="left">wildcard</td>
+<td align="left">true or false Determines whether the domain will accept email for sub-domains.</td>
+</tr>
+</tbody></table>
+<p>Promise Returns: Domain instance</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-4">&#39;Sun, 19 Oct 2014 18:49:36 GMT&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">name</span><span class="hl-0">: </span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">receiving_dns_records</span><span class="hl-0">: [{</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;name&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;foobar.example.com&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;TXT&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;v=spf1 include:mailgun.org ~all&quot;</span><br/><span class="hl-0">    },</span><br/><span class="hl-0">    {</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;name&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;k1._domainkey.foobar.example.com&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;TXT&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;k=rsa; 123456&quot;</span><br/><span class="hl-0">    },</span><br/><span class="hl-0">    {</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;name&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;email.foobar.example.com&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;CNAME&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;mailgun.org&quot;</span><br/><span class="hl-0">    }],</span><br/><span class="hl-0">  </span><span class="hl-13">require_tls</span><span class="hl-0">: </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">sending_dns_records</span><span class="hl-0">: [{</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;priority&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;10&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;MX&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;mxa.mailgun.org&quot;</span><br/><span class="hl-0">    },</span><br/><span class="hl-0">    {</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;priority&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;10&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;record_type&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;MX&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;valid&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;unknown&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-4">&quot;value&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;mxb.mailgun.org&quot;</span><br/><span class="hl-0">    }],</span><br/><span class="hl-0">  </span><span class="hl-13">skip_verification</span><span class="hl-0">: </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">smtp_login</span><span class="hl-0">: </span><span class="hl-4">&#39;postmaster@foobar.example.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">smtp_password</span><span class="hl-0">: </span><span class="hl-4">&#39;password&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">spam_action</span><span class="hl-0">: </span><span class="hl-4">&#39;disabled&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">state</span><span class="hl-0">: </span><span class="hl-4">&#39;unverified&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">type</span><span class="hl-0">: </span><span class="hl-4">&#39;custom&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">wildcard</span><span class="hl-0">: </span><span class="hl-1">false</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#destroy" id="destroy" style="color: inherit; text-decoration: none;">
+  <h4>destroy</h4>
+</a>
+<p><code>mg.domains.destroy(domain)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">destroy</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&quot;Domain has been deleted&quot;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#gettracking" id="gettracking" style="color: inherit; text-decoration: none;">
+  <h4>getTracking</h4>
+</a>
+<p><code>mg.domains.getTracking(domain)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">getTracking</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-4">&quot;click&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-4">&quot;active&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-1">false</span><br/><span class="hl-0">  },</span><br/><span class="hl-0">  </span><span class="hl-4">&quot;open&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-4">&quot;active&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-1">false</span><br/><span class="hl-0">  },</span><br/><span class="hl-0">  </span><span class="hl-4">&quot;unsubscribe&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-4">&quot;active&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-1">false</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-4">&quot;html_footer&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;</span><span class="hl-14">\n</span><span class="hl-4">&lt;br&gt;</span><span class="hl-14">\n</span><span class="hl-4">&lt;p&gt;&lt;a href=</span><span class="hl-14">\&quot;</span><span class="hl-4">%unsubscribe_url%</span><span class="hl-14">\&quot;</span><span class="hl-4">&gt;unsubscribe&lt;/a&gt;&lt;/p&gt;</span><span class="hl-14">\n</span><span class="hl-4">&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-4">&quot;text_footer&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;</span><span class="hl-14">\n\n</span><span class="hl-4">To unsubscribe click: &lt;%unsubscribe_url%&gt;</span><span class="hl-14">\n\n</span><span class="hl-4">&quot;</span><br/><span class="hl-0">  }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#updatetracking" id="updatetracking" style="color: inherit; text-decoration: none;">
+  <h4>updateTracking</h4>
+</a>
+<p><code>mg.domains.updateTracking(domain, trackingType, data)</code></p>
+<p>Open Tracking Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">updateTracking</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">, {</span><span class="hl-5">active:</span><span class="hl-0"> </span><span class="hl-1">true</span><span class="hl-0">})</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Open Tracking Options</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">active</td>
+<td align="left">Boolean, enables or disables open tracking</td>
+</tr>
+</tbody></table>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;Tracking settings have been updated&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">open</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-13">active</span><span class="hl-0">: </span><span class="hl-1">true</span><br/><span class="hl-0">  }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<p>Click Tracking Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">updateTracking</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;click&#39;</span><span class="hl-0">, {</span><span class="hl-5">active:</span><span class="hl-0"> </span><span class="hl-1">true</span><span class="hl-0">})</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Click Tracking Options</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">active</td>
+<td align="left">Boolean, enables or disables click tracking</td>
+</tr>
+</tbody></table>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;Tracking settings have been updated&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">click</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-13">active</span><span class="hl-0">: </span><span class="hl-1">true</span><br/><span class="hl-0">  }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<p>Unsubscribe Tracking Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">updateTracking</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;unsubscribe&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">    </span><span class="hl-5">active:</span><span class="hl-0"> </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">html_footer:</span><span class="hl-0"> </span><span class="hl-4">&quot;</span><span class="hl-14">\n</span><span class="hl-4">&lt;br&gt;</span><span class="hl-14">\n</span><span class="hl-4">&lt;p&gt;&lt;a href=</span><span class="hl-14">\&quot;</span><span class="hl-4">%unsubscribe_url%</span><span class="hl-14">\&quot;</span><span class="hl-4">&gt;unsubscribe&lt;/a&gt;&lt;/p&gt;</span><span class="hl-14">\n</span><span class="hl-4">&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">text_footer:</span><span class="hl-0"> </span><span class="hl-4">&quot;</span><span class="hl-14">\n\n</span><span class="hl-4">To unsubscribe click: &lt;%unsubscribe_url%&gt;</span><span class="hl-14">\n\n</span><span class="hl-4">&quot;</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Unsubscribe Tracking Options</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">active</td>
+<td align="left">Boolean, enables or disables unsubscribe tracking</td>
+</tr>
+<tr>
+<td align="left">html_footer</td>
+<td align="left">string appended to html emails for managing unsubscribe links</td>
+</tr>
+<tr>
+<td align="left">text_footer</td>
+<td align="left">string appended to html emails for managing unsubscribe links</td>
+</tr>
+</tbody></table>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;Tracking settings have been updated&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-4">&quot;unsubscribe&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-4">&quot;active&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-4">&quot;html_footer&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;</span><span class="hl-14">\n</span><span class="hl-4">&lt;br&gt;</span><span class="hl-14">\n</span><span class="hl-4">&lt;p&gt;&lt;a href=</span><span class="hl-14">\&quot;</span><span class="hl-4">%unsubscribe_url%</span><span class="hl-14">\&quot;</span><span class="hl-4">&gt;unsubscribe&lt;/a&gt;&lt;/p&gt;</span><span class="hl-14">\n</span><span class="hl-4">&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-4">&quot;text_footer&quot;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&quot;</span><span class="hl-14">\n\n</span><span class="hl-4">To unsubscribe click: &lt;%unsubscribe_url%&gt;</span><span class="hl-14">\n\n</span><span class="hl-4">&quot;</span><br/><span class="hl-0">  }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#getips" id="getips" style="color: inherit; text-decoration: none;">
+  <h4>getIps</h4>
+</a>
+<p><code>mg.domains.getIps(domain)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">getIps</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">[</span><span class="hl-4">&quot;192.168.0.1&quot;</span><span class="hl-0">, </span><span class="hl-4">&quot;192.168.0.2&quot;</span><span class="hl-0">]</span>
+</code></pre>
+<a href="#assignip" id="assignip" style="color: inherit; text-decoration: none;">
+  <h4>assignIp</h4>
+</a>
+<p><code>mg.domains.assignIp(domain, ip)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">assignIp</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&quot;192.168.0.3&quot;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;success&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#deleteip" id="deleteip" style="color: inherit; text-decoration: none;">
+  <h4>deleteIp</h4>
+</a>
+<p><code>mg.domains.deleteIp(domain, ip)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">domains</span><span class="hl-0">.</span><span class="hl-3">deleteIp</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&quot;192.168.0.3&quot;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;success&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#events" id="events" style="color: inherit; text-decoration: none;">
+  <h3>events</h3>
+</a>
+<a href="#get-1" id="get-1" style="color: inherit; text-decoration: none;">
+  <h4>get</h4>
+</a>
+<p><code>mg.events.get(domain, query)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">events</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, { </span><span class="hl-5">page:</span><span class="hl-0"> </span><span class="hl-4">&#39;mypageid&#39;</span><span class="hl-0"> })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">.</span><span class="hl-5">items</span><span class="hl-0">)) </span><span class="hl-6">// logs array of event objects</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Options:</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">page</td>
+<td align="left">Fetches the specified page of log records, assuming that the URL was returned by the previous request</td>
+</tr>
+<tr>
+<td align="left">begin</td>
+<td align="left">The beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.</td>
+</tr>
+<tr>
+<td align="left">end</td>
+<td align="left">The end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.</td>
+</tr>
+<tr>
+<td align="left">ascending</td>
+<td align="left">Defines the direction of the search time range if the range end time is not specified. Can be either yes or no. Refer to Time Range for details.</td>
+</tr>
+<tr>
+<td align="left">limit</td>
+<td align="left">Number of entries to return. (300 max)</td>
+</tr>
+<tr>
+<td align="left"><field></td>
+<td align="left"><field> is the name of the Filter Field. The value of the parameter should be a valid Filter Expression. Several field filters can be specified in one request. If the same field is mentioned, more then once, then all its filter expressions are combined with AND operator.</td>
+</tr>
+</tbody></table>
+<p>Promise Returns: items (array of event objects), pages (paging keys grouped by id)</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0"> </span><span class="hl-13">items</span><span class="hl-0">: [{</span><br/><span class="hl-0">    </span><span class="hl-5">type:</span><span class="hl-0"> </span><span class="hl-4">&#39;accepted&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">summary:</span><span class="hl-0"> </span><span class="hl-4">&#39;got it&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">content:</span><span class="hl-0"> { </span><span class="hl-5">more:</span><span class="hl-0"> </span><span class="hl-4">&#39;data&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">    </span><span class="hl-5">timestamp:</span><span class="hl-0"> </span><span class="hl-5">Wed</span><span class="hl-0"> </span><span class="hl-5">Nov</span><span class="hl-0"> </span><span class="hl-9">19</span><span class="hl-0"> </span><span class="hl-9">2014</span><span class="hl-0"> </span><span class="hl-9">10</span><span class="hl-0">:</span><span class="hl-9">32</span><span class="hl-0">:</span><span class="hl-9">57</span><span class="hl-0"> </span><span class="hl-2">GMT</span><span class="hl-0">-</span><span class="hl-9">0800</span><span class="hl-0"> (</span><span class="hl-2">PST</span><span class="hl-0">) },</span><br/><span class="hl-0">  }],</span><br/><span class="hl-0">  </span><span class="hl-13">pages</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-13">first</span><span class="hl-0">: { </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;first&#39;</span><span class="hl-0">, </span><span class="hl-13">number</span><span class="hl-0">: </span><span class="hl-4">&#39;W3siYSI6IGZhbHNlLC&#39;</span><span class="hl-0">, </span><span class="hl-13">url</span><span class="hl-0">: </span><span class="hl-4">&#39;apiurl&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">    </span><span class="hl-13">last</span><span class="hl-0">: { </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;last&#39;</span><span class="hl-0">, </span><span class="hl-13">number</span><span class="hl-0">: </span><span class="hl-4">&#39;W3siYSI6IGZhbHNlLC&#39;</span><span class="hl-0">, </span><span class="hl-13">url</span><span class="hl-0">: </span><span class="hl-4">&#39;apiurl&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">    </span><span class="hl-13">next</span><span class="hl-0">: { </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;next&#39;</span><span class="hl-0">, </span><span class="hl-13">number</span><span class="hl-0">: </span><span class="hl-5">W3siYSI6IGZhbHNlLC</span><span class="hl-4">&#39;&#39;</span><span class="hl-0">, </span><span class="hl-13">url</span><span class="hl-0">: </span><span class="hl-4">&#39;apiurl&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">    </span><span class="hl-13">previous</span><span class="hl-0">: { </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;previous&#39;</span><span class="hl-0">, </span><span class="hl-13">number</span><span class="hl-0">: </span><span class="hl-4">&#39;W3siYSI6IGZhbHNlLC&#39;</span><span class="hl-0">, </span><span class="hl-13">url</span><span class="hl-0">: </span><span class="hl-4">&#39;apiurl&#39;</span><span class="hl-0"> }</span><br/><span class="hl-0">  }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#stats" id="stats" style="color: inherit; text-decoration: none;">
+  <h3>stats</h3>
+</a>
+<p>Stats Options</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">event</td>
+<td align="left">The type of the event. For a complete list of all events written to the log see the <code>Event Types</code> table below. (Required)</td>
+</tr>
+<tr>
+<td align="left">start</td>
+<td align="left">The starting time. Should be in :rfc:<code>2822#page-14</code> or unix epoch format. Default: 7 days from the current time.</td>
+</tr>
+<tr>
+<td align="left">end</td>
+<td align="left">The ending date. Should be in :rfc:<code>2822#page-14</code> or unix epoch format. Default: current time.</td>
+</tr>
+<tr>
+<td align="left">resolution</td>
+<td align="left">Can be either <code>hour</code>, <code>day</code> or <code>month</code>. Default: <code>day</code></td>
+</tr>
+<tr>
+<td align="left">duration</td>
+<td align="left">Period of time with resolution encoded. If provided, overwrites the start date. See list below.</td>
+</tr>
+</tbody></table>
+<p>Duration is a string that represents a period of time with some resolution. It has a format <code>[0-9]+[m,d,h]</code> where</p>
+<ul>
+<li><code>h</code> - an hour</li>
+<li><code>d</code> - a day</li>
+<li><code>m</code> - a month</li>
+</ul>
+<p>Examples:</p>
+<ul>
+<li><code>24h</code> - a period of 24 hours (a day) with hourly resolution</li>
+<li><code>1d</code> - a period of 1 day with daily resolution</li>
+<li><code>2m</code> - a period of 2 months with monthly resolution</li>
+</ul>
+<p>Event Types</p>
+<table>
+<thead>
+<tr>
+<th align="left">Event Type</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">accepted</td>
+<td align="left">Mailgun accepted the request to send/forward the email and the message has been placed in queue.</td>
+</tr>
+<tr>
+<td align="left">delivered</td>
+<td align="left">Mailgun sent the email and it was accepted by the recipient email server.</td>
+</tr>
+<tr>
+<td align="left">failed</td>
+<td align="left">Mailgun could not deliver the email to the recipient email server.</td>
+</tr>
+<tr>
+<td align="left">opened</td>
+<td align="left">The email recipient opened the email and enabled image viewing. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org.</td>
+</tr>
+<tr>
+<td align="left">clicked</td>
+<td align="left">The email recipient clicked on a link in the email. Click tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org.</td>
+</tr>
+<tr>
+<td align="left">unsubscribed</td>
+<td align="left">The email recipient clicked on the unsubscribe link. Unsubscribe tracking must be enabled in the Mailgun control panel.</td>
+</tr>
+<tr>
+<td align="left">complained</td>
+<td align="left">The email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.</td>
+</tr>
+<tr>
+<td align="left">stored</td>
+<td align="left">Mailgun has stored an incoming message</td>
+</tr>
+</tbody></table>
+<a href="#getdomain" id="getdomain" style="color: inherit; text-decoration: none;">
+  <h4>getDomain</h4>
+</a>
+<p><code>mg.stats.getDomain(domain, query)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">stats</span><span class="hl-0">.</span><span class="hl-3">getDomain</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, {</span><span class="hl-5">event:</span><span class="hl-0"> [</span><span class="hl-4">&#39;delivered&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;accepted&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;failed&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;complained&#39;</span><span class="hl-0">]})</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">start</span><span class="hl-0">: </span><span class="hl-5">Sun</span><span class="hl-0"> </span><span class="hl-5">Mar</span><span class="hl-0"> </span><span class="hl-9">15</span><span class="hl-0"> </span><span class="hl-9">2015</span><span class="hl-0"> </span><span class="hl-9">17</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0"> </span><span class="hl-2">GMT</span><span class="hl-0">-</span><span class="hl-9">0700</span><span class="hl-0"> (</span><span class="hl-2">PDT</span><span class="hl-0">),</span><br/><span class="hl-0">  </span><span class="hl-13">end</span><span class="hl-0">: </span><span class="hl-5">Sun</span><span class="hl-0"> </span><span class="hl-5">Mar</span><span class="hl-0"> </span><span class="hl-9">22</span><span class="hl-0"> </span><span class="hl-9">2015</span><span class="hl-0"> </span><span class="hl-9">17</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0"> </span><span class="hl-2">GMT</span><span class="hl-0">-</span><span class="hl-9">0700</span><span class="hl-0"> (</span><span class="hl-2">PDT</span><span class="hl-0">),</span><br/><span class="hl-0">  </span><span class="hl-13">resolution</span><span class="hl-0">: </span><span class="hl-4">&#39;day&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">stats</span><span class="hl-0">: [{</span><br/><span class="hl-0">    </span><span class="hl-5">time:</span><span class="hl-0"> </span><span class="hl-5">Sun</span><span class="hl-0"> </span><span class="hl-5">Mar</span><span class="hl-0"> </span><span class="hl-9">15</span><span class="hl-0"> </span><span class="hl-9">2015</span><span class="hl-0"> </span><span class="hl-9">17</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0"> </span><span class="hl-2">GMT</span><span class="hl-0">-</span><span class="hl-9">0700</span><span class="hl-0"> (</span><span class="hl-2">PDT</span><span class="hl-0">),</span><br/><span class="hl-0">    </span><span class="hl-5">delivered:</span><span class="hl-0"> { </span><span class="hl-5">smtp:</span><span class="hl-0"> </span><span class="hl-9">2</span><span class="hl-0">, </span><span class="hl-5">http:</span><span class="hl-0"> </span><span class="hl-9">1</span><span class="hl-0">, </span><span class="hl-5">total:</span><span class="hl-0"> </span><span class="hl-9">3</span><span class="hl-0"> }</span><br/><span class="hl-0">  }]</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#getaccount" id="getaccount" style="color: inherit; text-decoration: none;">
+  <h4>getAccount</h4>
+</a>
+<p><code>mg.stats.getDomain(domain, query)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">stats</span><span class="hl-0">.</span><span class="hl-3">getDomain</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, {</span><span class="hl-5">event:</span><span class="hl-0"> [</span><span class="hl-4">&#39;delivered&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;accepted&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;failed&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;complained&#39;</span><span class="hl-0">]})</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">start</span><span class="hl-0">: </span><span class="hl-5">Sun</span><span class="hl-0"> </span><span class="hl-5">Mar</span><span class="hl-0"> </span><span class="hl-9">15</span><span class="hl-0"> </span><span class="hl-9">2015</span><span class="hl-0"> </span><span class="hl-9">17</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0"> </span><span class="hl-2">GMT</span><span class="hl-0">-</span><span class="hl-9">0700</span><span class="hl-0"> (</span><span class="hl-2">PDT</span><span class="hl-0">),</span><br/><span class="hl-0">  </span><span class="hl-13">end</span><span class="hl-0">: </span><span class="hl-5">Sun</span><span class="hl-0"> </span><span class="hl-5">Mar</span><span class="hl-0"> </span><span class="hl-9">22</span><span class="hl-0"> </span><span class="hl-9">2015</span><span class="hl-0"> </span><span class="hl-9">17</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0"> </span><span class="hl-2">GMT</span><span class="hl-0">-</span><span class="hl-9">0700</span><span class="hl-0"> (</span><span class="hl-2">PDT</span><span class="hl-0">),</span><br/><span class="hl-0">  </span><span class="hl-13">resolution</span><span class="hl-0">: </span><span class="hl-4">&#39;day&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">stats</span><span class="hl-0">: [{</span><br/><span class="hl-0">    </span><span class="hl-5">time:</span><span class="hl-0"> </span><span class="hl-5">Sun</span><span class="hl-0"> </span><span class="hl-5">Mar</span><span class="hl-0"> </span><span class="hl-9">15</span><span class="hl-0"> </span><span class="hl-9">2015</span><span class="hl-0"> </span><span class="hl-9">17</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0">:</span><span class="hl-9">00</span><span class="hl-0"> </span><span class="hl-2">GMT</span><span class="hl-0">-</span><span class="hl-9">0700</span><span class="hl-0"> (</span><span class="hl-2">PDT</span><span class="hl-0">),</span><br/><span class="hl-0">    </span><span class="hl-5">delivered:</span><span class="hl-0"> { </span><span class="hl-5">smtp:</span><span class="hl-0"> </span><span class="hl-9">2</span><span class="hl-0">, </span><span class="hl-5">http:</span><span class="hl-0"> </span><span class="hl-9">1</span><span class="hl-0">, </span><span class="hl-5">total:</span><span class="hl-0"> </span><span class="hl-9">3</span><span class="hl-0"> }</span><br/><span class="hl-0">  }]</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#suppressions" id="suppressions" style="color: inherit; text-decoration: none;">
+  <h3>suppressions</h3>
+</a>
+<a href="#list-1" id="list-1" style="color: inherit; text-decoration: none;">
+  <h4>list</h4>
+</a>
+<p><code>mg.suppressions.list(domain, suppressionType, query)</code></p>
+<p>Bounces Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">suppressions</span><span class="hl-0">.</span><span class="hl-3">list</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;bounces&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Unsubscribes Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">suppressions</span><span class="hl-0">.</span><span class="hl-3">list</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;unsubscribes&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Complaints Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">suppressions</span><span class="hl-0">.</span><span class="hl-3">list</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;complaints&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">items</span><span class="hl-0">: [</span><br/><span class="hl-0">    {</span><br/><span class="hl-0">      </span><span class="hl-5">type:</span><span class="hl-0"> </span><span class="hl-4">&#39;bounces&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;unknown@unknown.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-5">code:</span><span class="hl-0"> </span><span class="hl-9">550</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-5">error:</span><span class="hl-0"> </span><span class="hl-4">&#39;No such mailbox&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-5">created_at:</span><span class="hl-0"> </span><span class="hl-5">Fri</span><span class="hl-0"> </span><span class="hl-5">Oct</span><span class="hl-0"> </span><span class="hl-9">21</span><span class="hl-0"> </span><span class="hl-9">2011</span><span class="hl-0"> </span><span class="hl-9">04</span><span class="hl-0">:</span><span class="hl-9">02</span><span class="hl-0">:</span><span class="hl-9">55</span><span class="hl-0"> </span><span class="hl-2">GMT</span><span class="hl-0">-</span><span class="hl-9">0700</span><span class="hl-0"> (</span><span class="hl-2">PDT</span><span class="hl-0">)</span><br/><span class="hl-0">    }</span><br/><span class="hl-0">  ],</span><br/><span class="hl-0">  </span><span class="hl-13">pages</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-13">first</span><span class="hl-0">: { </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;first&#39;</span><span class="hl-0">, </span><span class="hl-13">page</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">, </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">, </span><span class="hl-13">url</span><span class="hl-0">: </span><span class="hl-4">&#39;apiurl&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">    </span><span class="hl-13">last</span><span class="hl-0">: { </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;last&#39;</span><span class="hl-0">, </span><span class="hl-13">page</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">, </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">, </span><span class="hl-13">url</span><span class="hl-0">: </span><span class="hl-4">&#39;apiurl&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">    </span><span class="hl-13">next</span><span class="hl-0">: { </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;next&#39;</span><span class="hl-0">, </span><span class="hl-13">page</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">, </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">, </span><span class="hl-13">url</span><span class="hl-0">: </span><span class="hl-4">&#39;apiurl&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">    </span><span class="hl-13">previous</span><span class="hl-0">: { </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;prev&#39;</span><span class="hl-0">, </span><span class="hl-13">page</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">, </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">, </span><span class="hl-13">url</span><span class="hl-0">: </span><span class="hl-4">&#39;apiurl&#39;</span><span class="hl-0"> }</span><br/><span class="hl-0">  }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#get-2" id="get-2" style="color: inherit; text-decoration: none;">
+  <h4>get</h4>
+</a>
+<p><code>mg.suppressions.get(domain, suppressionType, address)</code></p>
+<p>Bounces Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">suppressions</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;bounces&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;address@example.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Unsubscribes Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">suppressions</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;unsubscribes&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;address@example.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Complaints Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">suppressions</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;complaints&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;address@example.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Options:</p>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">type</span><span class="hl-0">: </span><span class="hl-4">&#39;bounces&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;address?@unknown.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">tags</span><span class="hl-0">: [ </span><span class="hl-4">&#39;*&#39;</span><span class="hl-0"> ],</span><br/><span class="hl-0">  </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-5">Fri</span><span class="hl-0"> </span><span class="hl-5">Oct</span><span class="hl-0"> </span><span class="hl-9">21</span><span class="hl-0"> </span><span class="hl-9">2011</span><span class="hl-0"> </span><span class="hl-9">05</span><span class="hl-0">:</span><span class="hl-9">02</span><span class="hl-0">:</span><span class="hl-9">55</span><span class="hl-0"> </span><span class="hl-2">GMT</span><span class="hl-0">-</span><span class="hl-9">0700</span><span class="hl-0"> (</span><span class="hl-2">PDT</span><span class="hl-0">)</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#create-2" id="create-2" style="color: inherit; text-decoration: none;">
+  <h4>create</h4>
+</a>
+<p><code>mg.suppressions.create(domain, suppressionType, array)</code></p>
+<p>Bounces Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">suppressions</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;bounces&#39;</span><span class="hl-0">, [{</span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;bob@example.com&#39;</span><span class="hl-0">}])</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Bounces Options: Contains an array with the following object properties</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">address</td>
+<td align="left">Valid email address</td>
+</tr>
+<tr>
+<td align="left">code</td>
+<td align="left">Error code (optional, default: 550)</td>
+</tr>
+<tr>
+<td align="left">error</td>
+<td align="left">Error description (optional, default: empty string)</td>
+</tr>
+<tr>
+<td align="left">created_at</td>
+<td align="left">Timestamp of a bounce event in RFC2822 format (optional, default: current time)</td>
+</tr>
+</tbody></table>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&quot;1 address has been added to the bounces table&quot;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<p>Unsubscribes Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">suppressions</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;unsubscribes&#39;</span><span class="hl-0">, [{</span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;bob@example.com&#39;</span><span class="hl-0">}])</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Unsubscribes Options: Contains an array with the following object properties</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">address</td>
+<td align="left">Valid email address</td>
+</tr>
+<tr>
+<td align="left">tag</td>
+<td align="left">Tag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *)</td>
+</tr>
+<tr>
+<td align="left">created_at</td>
+<td align="left">Timestamp of a bounce event in RFC2822 format (optional, default: current time)</td>
+</tr>
+</tbody></table>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&quot;1 address has been added to the unsubscribes table&quot;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<p>Complaints Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">suppressions</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;complaints&#39;</span><span class="hl-0">, [{</span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;bob@example.com&#39;</span><span class="hl-0">}])</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Complaints Options: Contains an array with the following object properties</p>
+<table>
+<thead>
+<tr>
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">address</td>
+<td align="left">Valid email address</td>
+</tr>
+<tr>
+<td align="left">created_at</td>
+<td align="left">Timestamp of a bounce event in RFC2822 format (optional, default: current time)</td>
+</tr>
+</tbody></table>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&quot;1 address has been added to the complaints table&quot;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#webhooks" id="webhooks" style="color: inherit; text-decoration: none;">
+  <h3>webhooks</h3>
+</a>
+<a href="#list-2" id="list-2" style="color: inherit; text-decoration: none;">
+  <h4>list</h4>
+</a>
+<p><code>mg.webhooks.list(domain, query)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">webhooks</span><span class="hl-0">.</span><span class="hl-3">list</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">open</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">  </span><span class="hl-13">click</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">  </span><span class="hl-13">bounce</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">  </span><span class="hl-13">deliver</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">  </span><span class="hl-13">drop</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">  </span><span class="hl-13">spam</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">  </span><span class="hl-13">unsubscribe</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">  </span><span class="hl-13">click</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">  </span><span class="hl-13">open</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#get-3" id="get-3" style="color: inherit; text-decoration: none;">
+  <h4>get</h4>
+</a>
+<p><code>mg.webhooks.get(domain, id)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">webhooks</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">) </span><span class="hl-6">// bounce, deliver, drop, spam, unsubscribe, click, open</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#create-3" id="create-3" style="color: inherit; text-decoration: none;">
+  <h4>create</h4>
+</a>
+<p><code>mg.webhooks.create(domain, id, data, test)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">webhooks</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0">) </span><span class="hl-6">// bounce, deliver, drop, spam, unsubscribe, click, open</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<p>Test Webhook Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">webhooks</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0">, </span><span class="hl-1">true</span><span class="hl-0">) </span><span class="hl-6">// bounce, deliver, drop, spam, unsubscribe, click, open</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-4">&#39;code&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;500&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-4">&#39;message&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;Hi!&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#update" id="update" style="color: inherit; text-decoration: none;">
+  <h4>update</h4>
+</a>
+<p><code>mg.webhooks.update(domain, id, url, test)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">webhooks</span><span class="hl-0">.</span><span class="hl-3">update</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0">) </span><span class="hl-6">// bounce, deliver, drop, spam, unsubscribe, click, open</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#destroy-1" id="destroy-1" style="color: inherit; text-decoration: none;">
+  <h4>destroy</h4>
+</a>
+<p><code>mg.webhooks.destroy(domain, id)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">webhooks</span><span class="hl-0">.</span><span class="hl-3">update</span><span class="hl-0">(</span><span class="hl-4">&#39;foobar.example.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">) </span><span class="hl-6">// bounce, deliver, drop, spam, unsubscribe, click, open</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">msg</span><span class="hl-0">)) </span><span class="hl-6">// logs response data</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns:</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-4">&#39;open&#39;</span><span class="hl-0">: { </span><span class="hl-4">&#39;url&#39;</span><span class="hl-5">:</span><span class="hl-0"> </span><span class="hl-4">&#39;http://requestb.in&#39;</span><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#routes" id="routes" style="color: inherit; text-decoration: none;">
+  <h3>routes</h3>
+</a>
+<a href="#list-3" id="list-3" style="color: inherit; text-decoration: none;">
+  <h4>list</h4>
+</a>
+<p><code>mg.routes.list(query)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">routes</span><span class="hl-0">.</span><span class="hl-3">list</span><span class="hl-0">()</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">[</span><br/><span class="hl-0">  {</span><br/><span class="hl-0">    </span><span class="hl-5">actions:</span><span class="hl-0"> [ </span><span class="hl-4">&#39;forward(&quot;http://myhost.com/messages/&quot;)&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;stop()&#39;</span><span class="hl-0"> ],</span><br/><span class="hl-0">    </span><span class="hl-5">created_at:</span><span class="hl-0"> </span><span class="hl-4">&#39;Mon, 26 Oct 2015 03:56:51 GMT&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">description:</span><span class="hl-0"> </span><span class="hl-4">&#39;sample&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">expression:</span><span class="hl-0"> </span><span class="hl-4">&#39;match_recipient(&quot;.*@example.com&quot;)&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">id:</span><span class="hl-0"> </span><span class="hl-4">&#39;562da483125730608a7d1719&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">priority:</span><span class="hl-0"> </span><span class="hl-9">0</span><br/><span class="hl-0">  }</span><br/><span class="hl-0">]</span>
+</code></pre>
+<a href="#get-4" id="get-4" style="color: inherit; text-decoration: none;">
+  <h4>get</h4>
+</a>
+<p><code>mg.routes.get(id)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">routes</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;562da483125730608a7d1719&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">actions</span><span class="hl-0">: [ </span><span class="hl-4">&#39;forward(&quot;http://myhost.com/messages/&quot;)&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;stop()&#39;</span><span class="hl-0"> ],</span><br/><span class="hl-0">  </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-4">&#39;Mon, 26 Oct 2015 03:56:51 GMT&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">description</span><span class="hl-0">: </span><span class="hl-4">&#39;sample&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">expression</span><span class="hl-0">: </span><span class="hl-4">&#39;match_recipient(&quot;.*@example.com&quot;)&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;562da483125730608a7d1719&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">priority</span><span class="hl-0">: </span><span class="hl-9">0</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#create-4" id="create-4" style="color: inherit; text-decoration: none;">
+  <h4>create</h4>
+</a>
+<p><code>mg.routes.create(options)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">routes</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">({</span><br/><span class="hl-0">    </span><span class="hl-5">priority:</span><span class="hl-0"> </span><span class="hl-9">0</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">description:</span><span class="hl-0"> </span><span class="hl-4">&#39;sample&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">expression:</span><span class="hl-0"> </span><span class="hl-4">&#39;match_recipient(&quot;.*@example.org&quot;)&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">action:</span><span class="hl-0"> [</span><span class="hl-4">&#39;forward(&quot;http://myhost.com/messages/&quot;)&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;stop()&#39;</span><span class="hl-0">]</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">actions</span><span class="hl-0">: [ </span><span class="hl-4">&#39;forward(&quot;http://myhost.com/messages/&quot;)&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;stop()&#39;</span><span class="hl-0"> ],</span><br/><span class="hl-0">  </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-4">&#39;Mon, 26 Oct 2015 03:56:51 GMT&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">description</span><span class="hl-0">: </span><span class="hl-4">&#39;sample&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">expression</span><span class="hl-0">: </span><span class="hl-4">&#39;match_recipient(&quot;.*@example.com&quot;)&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;562da483125730608a7d1719&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">priority</span><span class="hl-0">: </span><span class="hl-9">0</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#update-1" id="update-1" style="color: inherit; text-decoration: none;">
+  <h4>update</h4>
+</a>
+<p><code>mg.routes.update(id, options)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">routes</span><span class="hl-0">.</span><span class="hl-3">update</span><span class="hl-0">(</span><span class="hl-4">&#39;562da483125730608a7d1719&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">    </span><span class="hl-5">priority:</span><span class="hl-0"> </span><span class="hl-9">0</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">description:</span><span class="hl-0"> </span><span class="hl-4">&#39;sample&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">expression:</span><span class="hl-0"> </span><span class="hl-4">&#39;match_recipient(&quot;.*@example.org&quot;)&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">action:</span><span class="hl-0"> [</span><span class="hl-4">&#39;forward(&quot;http://myhost.com/messages/&quot;)&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;stop()&#39;</span><span class="hl-0">]</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">actions</span><span class="hl-0">: [ </span><span class="hl-4">&#39;forward(&quot;http://myhost.com/messages/&quot;)&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;stop()&#39;</span><span class="hl-0"> ],</span><br/><span class="hl-0">  </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-4">&#39;Mon, 26 Oct 2015 03:56:51 GMT&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">description</span><span class="hl-0">: </span><span class="hl-4">&#39;sample&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">expression</span><span class="hl-0">: </span><span class="hl-4">&#39;match_recipient(&quot;.*@example.com&quot;)&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;562da483125730608a7d1719&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;Route has been updated&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">priority</span><span class="hl-0">: </span><span class="hl-9">0</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#destroy-2" id="destroy-2" style="color: inherit; text-decoration: none;">
+  <h4>destroy</h4>
+</a>
+<p><code>mg.routes.destroy(id)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">routes</span><span class="hl-0">.</span><span class="hl-3">destroy</span><span class="hl-0">(</span><span class="hl-4">&#39;562da483125730608a7d1719&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">id</span><span class="hl-0">: </span><span class="hl-4">&#39;562da483125730608a7d1719&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;Route has been deleted&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#validate" id="validate" style="color: inherit; text-decoration: none;">
+  <h3>validate</h3>
+</a>
+<a href="#get-5" id="get-5" style="color: inherit; text-decoration: none;">
+  <h4>get</h4>
+</a>
+<p><code>mg.validate.get(address)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">validate</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;alice@example.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;alice@example.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">did_you_mean</span><span class="hl-0">: </span><span class="hl-1">null</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">is_valid</span><span class="hl-0">: </span><span class="hl-1">false</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">parts</span><span class="hl-0">: { </span><span class="hl-13">display_name</span><span class="hl-0">: </span><span class="hl-1">null</span><span class="hl-0">, </span><span class="hl-13">domain</span><span class="hl-0">: </span><span class="hl-1">null</span><span class="hl-0">, </span><span class="hl-13">local_part</span><span class="hl-0">: </span><span class="hl-1">null</span><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#parse" id="parse" style="color: inherit; text-decoration: none;">
+  <h3>parse</h3>
+</a>
+<a href="#get-6" id="get-6" style="color: inherit; text-decoration: none;">
+  <h4>get</h4>
+</a>
+<p><code>mg.parse.get(addresses, enableDnsEspChecks)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">parse</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;Alice &lt;alice@example.com&gt;, example.com&#39;</span><span class="hl-0">, </span><span class="hl-1">true</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">parsed</span><span class="hl-0">: [],</span><br/><span class="hl-0">  </span><span class="hl-13">unparseable</span><span class="hl-0">: [</span><br/><span class="hl-0">    </span><span class="hl-4">&#39;Alice &lt;alice@example.com&gt;&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-4">&#39;example.com&#39;</span><br/><span class="hl-0">  ]</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#lists" id="lists" style="color: inherit; text-decoration: none;">
+  <h3>lists</h3>
+</a>
+<p>A client to manage mailing lists.</p>
+<a href="#list-4" id="list-4" style="color: inherit; text-decoration: none;">
+  <h4>list</h4>
+</a>
+<p><code>mg.lists.list()</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-3">list</span><span class="hl-0">()</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">[</span><br/><span class="hl-0">  {</span><br/><span class="hl-0">    </span><span class="hl-5">access_level:</span><span class="hl-0"> </span><span class="hl-4">&#39;readonly&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;noreply@sample.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">created_at:</span><span class="hl-0"> </span><span class="hl-4">&#39;Wed, 27 Oct 2021 21:59:21 -0000&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">description:</span><span class="hl-0"> </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">members_count:</span><span class="hl-0"> </span><span class="hl-9">0</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">reply_preference:</span><span class="hl-0"> </span><span class="hl-4">&#39;list&#39;</span><br/><span class="hl-0">  }</span><br/><span class="hl-0">]</span>
+</code></pre>
+<a href="#get-7" id="get-7" style="color: inherit; text-decoration: none;">
+  <h4>get</h4>
+</a>
+<p><code>mg.lists.get(mailListAddress)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-3">get</span><span class="hl-0">(</span><span class="hl-4">&#39;noreply@sample.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">access_level</span><span class="hl-0">: </span><span class="hl-4">&#39;readonly&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;noreply@sample.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-4">&#39;Thu, 28 Oct 2021 00:16:56 -0000&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">description</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">members_count</span><span class="hl-0">: </span><span class="hl-9">0</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">name</span><span class="hl-0">: </span><span class="hl-4">&#39;&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">reply_preference</span><span class="hl-0">: </span><span class="hl-4">&#39;list&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#create-5" id="create-5" style="color: inherit; text-decoration: none;">
+  <h4>create</h4>
+</a>
+<p><code>mg.lists.create(data)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-3">create</span><span class="hl-0">({</span><br/><span class="hl-0">    </span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&#39;Reply Address&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">description:</span><span class="hl-0"> </span><span class="hl-4">&#39;Mailing lists for repliable address&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">access_level:</span><span class="hl-0"> </span><span class="hl-4">&#39;readonly&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">reply_preference:</span><span class="hl-0"> </span><span class="hl-4">&#39;list&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">access_level</span><span class="hl-0">: </span><span class="hl-4">&#39;readonly&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-4">&#39;Thu, 28 Oct 2021 03:12:17 -0000&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">description</span><span class="hl-0">: </span><span class="hl-4">&#39;Mailing lists for repliable address&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">members_count</span><span class="hl-0">: </span><span class="hl-9">0</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">name</span><span class="hl-0">: </span><span class="hl-4">&#39;Reply Address&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">reply_preference</span><span class="hl-0">: </span><span class="hl-4">&#39;list&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#update-2" id="update-2" style="color: inherit; text-decoration: none;">
+  <h4>update</h4>
+</a>
+<p><code>mg.lists.update(mailListAddress)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-3">update</span><span class="hl-0">(</span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">    </span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;foo@sample.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&#39;Foo&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">description:</span><span class="hl-0"> </span><span class="hl-4">&#39;Foo bar bat&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">access_level:</span><span class="hl-0"> </span><span class="hl-4">&#39;members&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">reply_preference:</span><span class="hl-0"> </span><span class="hl-4">&#39;sender&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">access_level</span><span class="hl-0">: </span><span class="hl-4">&#39;members&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;foo@sample.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-4">&#39;Thu, 28 Oct 2021 03:21:15 -0000&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">description</span><span class="hl-0">: </span><span class="hl-4">&#39;Foo bar bat&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">members_count</span><span class="hl-0">: </span><span class="hl-9">0</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">name</span><span class="hl-0">: </span><span class="hl-4">&#39;Foo&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">reply_preference</span><span class="hl-0">: </span><span class="hl-4">&#39;sender&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#destroy-3" id="destroy-3" style="color: inherit; text-decoration: none;">
+  <h4>destroy</h4>
+</a>
+<p><code>mg.lists.destroy(mailListAddress)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-3">destroy</span><span class="hl-0">(</span><span class="hl-4">&#39;foo@sample.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;foo@sample.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;Mailing list has been removed&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#maillistmembers" id="maillistmembers" style="color: inherit; text-decoration: none;">
+  <h3>mailListMembers</h3>
+</a>
+<p>A client to manage members within a specific mailing list.</p>
+<a href="#listmembers" id="listmembers" style="color: inherit; text-decoration: none;">
+  <h4>listMembers</h4>
+</a>
+<p><code>mg.lists.members.listMembers(mailListAddress)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-5">members</span><span class="hl-0">.</span><span class="hl-3">listMembers</span><span class="hl-0">(</span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">[</span><br/><span class="hl-0">  {</span><br/><span class="hl-0">    </span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;foo@bar.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&#39;Jane Doe&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">subscribed:</span><span class="hl-0"> </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">vars:</span><span class="hl-0"> { </span><span class="hl-5">age:</span><span class="hl-0"> </span><span class="hl-9">50</span><span class="hl-0"> }</span><br/><span class="hl-0">  }</span><br/><span class="hl-0">]</span>
+</code></pre>
+<a href="#getmember" id="getmember" style="color: inherit; text-decoration: none;">
+  <h4>getMember</h4>
+</a>
+<p><code>mg.lists.members.getMember(mailListAddress, mailListMemberAddress)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-5">members</span><span class="hl-0">.</span><span class="hl-3">getMember</span><span class="hl-0">(</span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;foo@bar.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;foo@bar.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">name</span><span class="hl-0">: </span><span class="hl-4">&#39;Jane Doe&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">subscribed</span><span class="hl-0">: </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">vars</span><span class="hl-0">: { </span><span class="hl-13">age</span><span class="hl-0">: </span><span class="hl-9">50</span><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#createmember" id="createmember" style="color: inherit; text-decoration: none;">
+  <h4>createMember</h4>
+</a>
+<p><code>mg.lists.members.createMember(mailListAddress, data)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-5">members</span><span class="hl-0">.</span><span class="hl-3">createMember</span><span class="hl-0">(</span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">    </span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;bat@bar.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&#39;John Smith&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">vars:</span><span class="hl-0"> {</span><span class="hl-5">hobby:</span><span class="hl-0"> </span><span class="hl-4">&quot;chess&quot;</span><span class="hl-0">}, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">subscribed:</span><span class="hl-0"> </span><span class="hl-4">&#39;no&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">upsert:</span><span class="hl-0"> </span><span class="hl-4">&#39;yes&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, choose yes to insert if not exist, or update it exist</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;bat@bar.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">name</span><span class="hl-0">: </span><span class="hl-4">&#39;John Smith&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">subscribed</span><span class="hl-0">: </span><span class="hl-1">false</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">vars</span><span class="hl-0">: { </span><span class="hl-13">hobby</span><span class="hl-0">: </span><span class="hl-4">&#39;chess&#39;</span><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#createmembers" id="createmembers" style="color: inherit; text-decoration: none;">
+  <h4>createMembers</h4>
+</a>
+<p><code>mg.lists.members.createMembers(mailListAddress, data)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-5">members</span><span class="hl-0">.</span><span class="hl-3">createMembers</span><span class="hl-0">(</span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">    </span><span class="hl-5">members:</span><span class="hl-0"> [</span><br/><span class="hl-0">      {</span><br/><span class="hl-0">        </span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&quot;bot1@foobar.com&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">        </span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&quot;Bot1 Superbot&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">        </span><span class="hl-5">vars:</span><span class="hl-0"> {</span><span class="hl-5">location:</span><span class="hl-0"> </span><span class="hl-4">&quot;loc1&quot;</span><span class="hl-0">},</span><br/><span class="hl-0">        </span><span class="hl-5">subscribed:</span><span class="hl-0"> </span><span class="hl-1">true</span><span class="hl-0">,</span><br/><span class="hl-0">      },</span><br/><span class="hl-0">      {</span><br/><span class="hl-0">        </span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&quot;bot2@foobar.com&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">        </span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&quot;Bot2 Superbot&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">        </span><span class="hl-5">vars:</span><span class="hl-0"> {</span><span class="hl-5">location:</span><span class="hl-0"> </span><span class="hl-4">&quot;loc2&quot;</span><span class="hl-0">},</span><br/><span class="hl-0">        </span><span class="hl-5">subscribed:</span><span class="hl-0"> </span><span class="hl-1">false</span><span class="hl-0">,</span><br/><span class="hl-0">      },</span><br/><span class="hl-0">    ],</span><br/><span class="hl-0">    </span><span class="hl-5">upsert:</span><span class="hl-0"> </span><span class="hl-4">&quot;yes&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">list</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-13">access_level</span><span class="hl-0">: </span><span class="hl-4">&#39;readonly&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-13">created_at</span><span class="hl-0">: </span><span class="hl-4">&#39;Thu, 28 Oct 2021 03:21:15 -0000&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-13">description</span><span class="hl-0">: </span><span class="hl-4">&#39;For reply purpose&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-13">members_count</span><span class="hl-0">: </span><span class="hl-9">2</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-13">name</span><span class="hl-0">: </span><span class="hl-4">&#39;Reply&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-13">reply_preference</span><span class="hl-0">: </span><span class="hl-4">&#39;list&#39;</span><br/><span class="hl-0">  },</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;Mailing list has been updated&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-4">&#39;task-id&#39;</span><span class="hl-0">: </span><span class="hl-4">&#39;575b943c37a211ec8a520242ac11000a&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#updatemember" id="updatemember" style="color: inherit; text-decoration: none;">
+  <h4>updateMember</h4>
+</a>
+<p><code>mg.lists.members.updateMember(mailListAddress, mailListMemberAddress, data)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-5">members</span><span class="hl-0">.</span><span class="hl-3">updateMember</span><span class="hl-0">(</span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;bot1@foobar.com&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">    </span><span class="hl-5">address:</span><span class="hl-0"> </span><span class="hl-4">&#39;bot0@barfoo.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-4">&#39;Bot0 Normalbot&#39;</span><span class="hl-0">, </span><span class="hl-6">// optional, modifiable on website</span><br/><span class="hl-0">    </span><span class="hl-5">vars:</span><span class="hl-0"> {</span><span class="hl-5">location:</span><span class="hl-0"> </span><span class="hl-4">&quot;space&quot;</span><span class="hl-0">},</span><br/><span class="hl-0">    </span><span class="hl-5">subscribed:</span><span class="hl-0"> </span><span class="hl-1">false</span><span class="hl-0">,</span><br/><span class="hl-0">  })</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;bot0@barfoo.com&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">name</span><span class="hl-0">: </span><span class="hl-4">&#39;Bot0 Normalbot&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">subscribed</span><span class="hl-0">: </span><span class="hl-1">false</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">vars</span><span class="hl-0">: { </span><span class="hl-13">location</span><span class="hl-0">: </span><span class="hl-4">&#39;space&#39;</span><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#destroymember" id="destroymember" style="color: inherit; text-decoration: none;">
+  <h4>destroyMember</h4>
+</a>
+<p><code>mg.lists.members.destroyMember(mailListAddress, mailListMemberAddress)</code></p>
+<p>Example:</p>
+<pre><code class="language-js"><span class="hl-5">mg</span><span class="hl-0">.</span><span class="hl-5">lists</span><span class="hl-0">.</span><span class="hl-5">members</span><span class="hl-0">.</span><span class="hl-3">destroyMember</span><span class="hl-0">(</span><span class="hl-4">&#39;reply@sample.com&#39;</span><span class="hl-0">, </span><span class="hl-4">&#39;bot2@foobar.com&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">  .</span><span class="hl-3">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">)) </span><span class="hl-6">// logs response body</span><br/><span class="hl-0">  .</span><span class="hl-3">catch</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0"> </span><span class="hl-1">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-5">err</span><span class="hl-0">)); </span><span class="hl-6">// logs any error</span>
+</code></pre>
+<p>Promise Returns: response body</p>
+<pre><code><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-13">member</span><span class="hl-0">: { </span><span class="hl-13">address</span><span class="hl-0">: </span><span class="hl-4">&#39;bot2@foobar.com&#39;</span><span class="hl-0"> },</span><br/><span class="hl-0">  </span><span class="hl-13">message</span><span class="hl-0">: </span><span class="hl-4">&#39;Mailing list member has been deleted&#39;</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#browser-demo" id="browser-demo" style="color: inherit; text-decoration: none;">
+  <h2>Browser Demo</h2>
+</a>
+<p><img src="https://cloud.githubusercontent.com/assets/399776/10718632/e8fe56e4-7b34-11e5-84c8-cfcfde978711.png" alt="image"></p>
+<p>For this demo to work, you&#39;ll need to install and run <code>http-proxy</code> locally. Install it with:</p>
+<pre><code class="language-sh"><span class="hl-0">npm install -g http-proxy</span>
+</code></pre>
+<p>Then run the following command from the mailgun-js directory:</p>
+<pre><code class="language-sh"><span class="hl-0">http-server -p 4001 --proxy=</span><span class="hl-4">&quot;https://api.mailgun.net&quot;</span>
+</code></pre>
+<p>Demo should be up and running at <a href="http://0.0.0.0:4001/examples/">http://0.0.0.0:4001/examples/</a></p>
+<a href="#development" id="development" style="color: inherit; text-decoration: none;">
+  <h1>Development</h1>
+</a>
+<a href="#requirements" id="requirements" style="color: inherit; text-decoration: none;">
+  <h2>Requirements</h2>
+</a>
+<ul>
+<li>Requires node.js &gt;= 4.x</li>
+</ul>
+<p>Install node dependencies with:</p>
+<pre><code class="language-sh"><span class="hl-0">npm install</span>
+</code></pre>
+<a href="#build" id="build" style="color: inherit; text-decoration: none;">
+  <h2>Build</h2>
+</a>
+<pre><code class="language-sh"><span class="hl-0">npm run build</span>
+</code></pre>
+<a href="#tests" id="tests" style="color: inherit; text-decoration: none;">
+  <h2>Tests</h2>
+</a>
+<pre><code class="language-sh"><span class="hl-0">npm run tests</span>
+</code></pre>
+<p>Watch tests with</p>
+<pre><code class="language-sh"><span class="hl-0">npm run watch-tests</span>
+</code></pre>
+<a href="#release-process" id="release-process" style="color: inherit; text-decoration: none;">
+  <h2>Release Process</h2>
+</a>
+<p>Releases occur after feature branches have been tested and merged into master.</p>
+<p>First, checkout master and pull the latest commits.</p>
+<pre><code class="language-sh"><span class="hl-0">git checkout master</span><br/><span class="hl-0">git pull</span>
+</code></pre>
+<p>Next, run <code>npm run release</code>.</p>
+<p>After that, run <code>npm login</code> and <code>npm publish</code> to publish changes on npm.</p>
+<a href="#todo" id="todo" style="color: inherit; text-decoration: none;">
+  <h2>TODO</h2>
+</a>
+<ul>
+<li>add browser demo to heroku</li>
+</ul>
+</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/client.html">client</a></li><li class=" tsd-kind-module"><a href="modules/domains.html">domains</a></li><li class=" tsd-kind-module"><a href="modules/domainsCredentials.html">domains<wbr/>Credentials</a></li><li class=" tsd-kind-module"><a href="modules/domainsTemplates.html">domains<wbr/>Templates</a></li><li class=" tsd-kind-module"><a href="modules/error.html">error</a></li><li class=" tsd-kind-module"><a href="modules/events.html">events</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_APIErrorOptions.html">interfaces/APIError<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_ApiResponse.html">interfaces/<wbr/>Api<wbr/>Response</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_DomainCredentials.html">interfaces/<wbr/>Domain<wbr/>Credentials</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_DomainTemplates.html">interfaces/<wbr/>Domain<wbr/>Templates</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_DomainTracking.html">interfaces/<wbr/>Domain<wbr/>Tracking</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_Domains.html">interfaces/<wbr/>Domains</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_Events.html">interfaces/<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_IFormData.html">interfaces/IForm<wbr/>Data</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_IpPools.html">interfaces/<wbr/>Ip<wbr/>Pools</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_Ips.html">interfaces/<wbr/>Ips</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_MultipleValidation.html">interfaces/<wbr/>Multiple<wbr/>Validation</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_Options.html">interfaces/<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_RequestOptions.html">interfaces/<wbr/>Request<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_StatsOptions.html">interfaces/<wbr/>Stats<wbr/>Options</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_Supressions.html">interfaces/<wbr/>Supressions</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_Validate.html">interfaces/<wbr/>Validate</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_Webhooks.html">interfaces/<wbr/>Webhooks</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_lists.html">interfaces/lists</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_mailListMembers.html">interfaces/mail<wbr/>List<wbr/>Members</a></li><li class=" tsd-kind-module"><a href="modules/interfaces_routes.html">interfaces/routes</a></li><li class=" tsd-kind-module"><a href="modules/ip_pools.html">ip-<wbr/>pools</a></li><li class=" tsd-kind-module"><a href="modules/ips.html">ips</a></li><li class=" tsd-kind-module"><a href="modules/lists.html">lists</a></li><li class=" tsd-kind-module"><a href="modules/mailListMembers.html">mail<wbr/>List<wbr/>Members</a></li><li class=" tsd-kind-module"><a href="modules/messages.html">messages</a></li><li class=" tsd-kind-module"><a href="modules/multipleValidation.html">multiple<wbr/>Validation</a></li><li class=" tsd-kind-module"><a href="modules/request.html">request</a></li><li class=" tsd-kind-module"><a href="modules/routes.html">routes</a></li><li class=" tsd-kind-module"><a href="modules/stats.html">stats</a></li><li class=" tsd-kind-module"><a href="modules/suppressions.html">suppressions</a></li><li class=" tsd-kind-module"><a href="modules/validate.html">validate</a></li><li class=" tsd-kind-module"><a href="modules/webhooks.html">webhooks</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>