Sending Messages

相关文章推荐

一直单身的抽屉 · 孕妈妈怎样减轻早孕反应？ - 四川省卫生健康委员会· 1 年前 ·

跑龙套的大白菜 · 先秦秦汉史研究-清华大学出土文献研究与保护中心· 1 年前 ·

鼻子大的汤圆 · What Is WebAR? How ...· 1 年前 ·

温柔的牛肉面 · 昏君，暴君和明君的区别是什么？一文给你说明白 ...· 1 年前 ·

腼腆的香槟 · “黄金一代”带领阿根廷男篮惊艳世界· 1 年前 ·

</noscript><div id="___gatsby"><div style="outline:none" tabindex="-1" id="gatsby-focus-wrapper"><div class="LayoutWrapper-sc-1s9fetx-0 iODoMJ"><nav class="NavBar__NavWrapper-sc-6tkv6u-9 gVdQcJ"><div class="sc-havuDZ sc-cfARRi fmUfmi dZWiQr"><a href="/"><img src="/static/mailgun-sinch-light-4453c0c3ed6acdc8f5d0df40dee8907c.svg" alt="Sinch logo " height="55" width="170"/></a><ul class="NavBar__NavItems-sc-6tkv6u-10 htEKGX"><li class="NavBar__NavItem-sc-6tkv6u-7 hkqnjM"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif" href="https://www.mailgun.com" target="_blank" class="sc-knSFqH dRoZbY undefined" data-cy="universalLink-Home">Home</a></li><li class="NavBar__NavItemMenu-sc-6tkv6u-8 gxPsTs"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif">Sinch Email</a><div><div class="NavBar__NavSubMenu-sc-6tkv6u-2 dBgEKw"><a href="https://www.mailgun.com/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Mailgun</div></a><a href="https://www.mailjet.com/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Mailjet</div></a><a href="https://www.emailonacid.com/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Email on Acid</div></a><a class="NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb"/></a></div></div></li><li class="NavBar__NavItemMenu-sc-6tkv6u-8 gxPsTs"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif">About</a><div><div class="NavBar__NavSubMenu-sc-6tkv6u-2 dBgEKw"><a href="https://www.mailgun.com/about/company/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Company</div></a><a href="https://www.mailgun.com/about/partners/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Partners</div></a><a href="https://www.mailgun.com/about/jobs/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Careers</div></a><a href="https://www.sinch.com/insights/events/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Events</div></a></div></div></li><li class="NavBar__NavItemMenu-sc-6tkv6u-8 gxPsTs"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif" href="https://www.mailgun.com/blog/" target="_blank" class="sc-knSFqH dRoZbY undefined" data-cy="universalLink-Blog">Blog</a><div><div class="NavBar__NavSubMenu-sc-6tkv6u-2 dBgEKw"><a href="https://www.mailgun.com/blog/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Blog</div></a></div></div></li><li class="NavBar__NavItemMenu-sc-6tkv6u-8 gxPsTs"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif">Help</a><div><div class="NavBar__NavSubMenu-sc-6tkv6u-2 dBgEKw"><a href="https://www.mailgun.com/contact/support/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Contact Support</div></a><a href="https://help.mailgun.com/hc/en-us" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Help Center</div></a><a href="https://status.mailgun.com/?_gl=1*1ysqabo*_ga*MTcxNTMyNTI0Mi4xNzA1NjE2NjU1*_ga_PZB2JSMCGC*MTcxODAzNjI5NS4xNi4xLjE3MTgwMzY5MDYuMC4wLjA." target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Status</div></a><a href="https://www.mailgun.com/release-notes/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Release Notes</div></a><a href="https://security.mailgun.com/?_gl=1*e2dg6y*_ga*MTcxNTMyNTI0Mi4xNzA1NjE2NjU1*_ga_PZB2JSMCGC*MTcxODAzNjI5NS4xNi4xLjE3MTgwMzY5OTUuMC4wLjA." target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Security Portal</div></a><a href="https://www.mailgun.com/resources/learn/gdpr/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">GDPR</div></a><a class="NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb"/></a></div></div></li><li class="NavBar__NavItem-sc-6tkv6u-7 hkqnjM"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif" href="https://login.mailgun.com/login/" target="_blank" class="sc-knSFqH dRoZbY undefined" data-cy="universalLink-Login">Login</a></li></ul></div><div class="sc-havuDZ sc-cfARRi lkFjeH hcbaNr"><div class="NavBar__SearchArea-sc-6tkv6u-4 dIxSBX"><span class="sc-bnFVBq krHaRf NavBar__StyledSearchBox-sc-6tkv6u-6 kiWHTW"><span class="sc-bXmHAB fmzdVB"><input type="text" autocomplete="off" value="" id="search" placeholder="Search the docs" aria-label="Search the docs" class="sc-ezHeEz jZneQJ"/><span class="sc-cTsKDU sc-fvNhHS BwyBz kPzCET"/></span><ul class="sc-iKUVsf lgkDlf"><div class="sc-gLwjMs ixXdyG"> Nothing Found </div></ul></span></div></div><div class="sc-havuDZ sc-cfARRi iKkaQy gkwvcp"><span style="margin-right:20px"/></div><div class="NavBar__NavControls-sc-6tkv6u-12 fqgFWb"><span class="NavBar__MobileMenuIcon-sc-6tkv6u-13 ioQYkF"/></div><ul class="NavBar__MobileMenu-sc-6tkv6u-11 dIpntg"><i class="NavBar__CloseIcon-sc-6tkv6u-14 fWXItM"/><li class="NavBar__NavItem-sc-6tkv6u-7 hkqnjM"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif" href="https://www.mailgun.com" target="_blank" class="sc-knSFqH dRoZbY undefined" data-cy="universalLink-Home">Home</a></li><li class="NavBar__NavItemMenu-sc-6tkv6u-8 gxPsTs"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif">Sinch Email</a><div><div class="NavBar__NavSubMenu-sc-6tkv6u-2 dBgEKw"><a href="https://www.mailgun.com/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Mailgun</div></a><a href="https://www.mailjet.com/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Mailjet</div></a><a href="https://www.emailonacid.com/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Email on Acid</div></a><a class="NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb"/></a></div></div></li><li class="NavBar__NavItemMenu-sc-6tkv6u-8 gxPsTs"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif">About</a><div><div class="NavBar__NavSubMenu-sc-6tkv6u-2 dBgEKw"><a href="https://www.mailgun.com/about/company/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Company</div></a><a href="https://www.mailgun.com/about/partners/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Partners</div></a><a href="https://www.mailgun.com/about/jobs/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Careers</div></a><a href="https://www.sinch.com/insights/events/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Events</div></a></div></div></li><li class="NavBar__NavItemMenu-sc-6tkv6u-8 gxPsTs"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif" href="https://www.mailgun.com/blog/" target="_blank" class="sc-knSFqH dRoZbY undefined" data-cy="universalLink-Blog">Blog</a><div><div class="NavBar__NavSubMenu-sc-6tkv6u-2 dBgEKw"><a href="https://www.mailgun.com/blog/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Blog</div></a></div></div></li><li class="NavBar__NavItemMenu-sc-6tkv6u-8 gxPsTs"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif">Help</a><div><div class="NavBar__NavSubMenu-sc-6tkv6u-2 dBgEKw"><a href="https://www.mailgun.com/contact/support/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Contact Support</div></a><a href="https://help.mailgun.com/hc/en-us" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Help Center</div></a><a href="https://status.mailgun.com/?_gl=1*1ysqabo*_ga*MTcxNTMyNTI0Mi4xNzA1NjE2NjU1*_ga_PZB2JSMCGC*MTcxODAzNjI5NS4xNi4xLjE3MTgwMzY5MDYuMC4wLjA." target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Status</div></a><a href="https://www.mailgun.com/release-notes/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Release Notes</div></a><a href="https://security.mailgun.com/?_gl=1*e2dg6y*_ga*MTcxNTMyNTI0Mi4xNzA1NjE2NjU1*_ga_PZB2JSMCGC*MTcxODAzNjI5NS4xNi4xLjE3MTgwMzY5OTUuMC4wLjA." target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">Security Portal</div></a><a href="https://www.mailgun.com/resources/learn/gdpr/" target="_self" class="sc-knSFqH dRoZbY NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ" data-cy="universalLink-with-nested-jsx"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb">GDPR</div></a><a class="NavBar__NavSubLink-sc-6tkv6u-0 gSthbZ"><div class="NavBar__NavSubLinkTitle-sc-6tkv6u-1 fZaCQb"/></a></div></div></li><li class="NavBar__NavItem-sc-6tkv6u-7 hkqnjM"><a style="font-weight:400;font-family:Gilroy-Regular, Helvetica, Arial, sans-serif" href="https://login.mailgun.com/login/" target="_blank" class="sc-knSFqH dRoZbY undefined" data-cy="universalLink-Login">Login</a></li><span class="sc-bnFVBq krHaRf"><span class="sc-bXmHAB fmzdVB"><input type="text" autocomplete="off" value="" id="search" placeholder="Search the docs" aria-label="Search the docs" class="sc-ezHeEz jZneQJ"/><span class="sc-cTsKDU sc-fvNhHS BwyBz kPzCET"/></span><ul class="sc-iKUVsf lgkDlf"><div class="sc-gLwjMs ixXdyG"> Nothing Found </div></ul></span></ul></nav><div class="sc-havuDZ sc-cfARRi sc-lMZDC etbizb jRTDpo eKHMoM"><span class="sc-fSvVUw eaYAeH"/><aside class="sc-hLiTib kfMAvv"><div class="sc-iMCRTP ehAVpt"><ul class="sc-eTTTle mJSVO"><div><a href="/docs/mailgun/"><div data-cy="sidebar-item-Mailgun Send API" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__CustomHeaderItem-x3zjw7-5 hkowkY jEwybU"><span class="MenuItem__ProductMenuLabel-x3zjw7-9 dAiRFT"><div style="color:#0A273D">Mailgun Send API</div></span></div></a></div><ul class="sc-eTTTle mJSVO"><div data-cy="sidebar-item-Quickstart Guide" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItem-x3zjw7-2 fbnrTv hUuGgg"><div class="MenuItem__ArrowWrapper-x3zjw7-10 iyAKUn"><i width="10px" height="10px" color="#272727" direction="right" data-cy="arrow" class="sc-cxxZvF gfpuWf"/></div><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Quickstart Guide</span></div><div data-cy="sidebar-item-User Manual" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItem-x3zjw7-2 fbnrTv hUuGgg"><div class="MenuItem__ArrowWrapper-x3zjw7-10 iyAKUn"><i width="10px" height="10px" color="#272727" direction="down" data-cy="arrow" class="sc-cxxZvF caNzlL"/></div><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">User Manual</span></div><ul class="sc-eTTTle mJSVO"><a href="/docs/mailgun/user-manual/get-started/"><div data-cy="sidebar-item-Getting Started" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItemLvl1-x3zjw7-3 fbnrTv jNZXlo"><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Getting Started</span></div></a><a aria-current="page" class="" href="/docs/mailgun/user-manual/sending-messages/"><div data-cy="sidebar-item-Sending Messages" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItemLvl1-x3zjw7-3 dTvBPR jNZXlo"><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Sending Messages</span></div></a><a href="/docs/mailgun/user-manual/tracking-messages/"><div data-cy="sidebar-item-Tracking Messages" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItemLvl1-x3zjw7-3 fbnrTv jNZXlo"><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Tracking Messages</span></div></a><a href="/docs/mailgun/user-manual/receive-forward-store/"><div data-cy="sidebar-item-Receiving, Forwarding, and Storing Messages" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItemLvl1-x3zjw7-3 fbnrTv jNZXlo"><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Receiving, Forwarding, and Storing Messages</span></div></a><a href="/docs/mailgun/user-manual/events/"><div data-cy="sidebar-item-Events" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItemLvl1-x3zjw7-3 fbnrTv jNZXlo"><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Events</span></div></a><a href="/docs/mailgun/user-manual/smtp-protocol/"><div data-cy="sidebar-item-SMTP Protocol" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItemLvl1-x3zjw7-3 fbnrTv jNZXlo"><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">SMTP Protocol</span></div></a><a href="/docs/mailgun/user-manual/tls-sending/"><div data-cy="sidebar-item-TLS Sending Connection Settings" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItemLvl1-x3zjw7-3 fbnrTv jNZXlo"><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">TLS Sending Connection Settings</span></div></a><a href="/docs/mailgun/user-manual/internationalization/"><div data-cy="sidebar-item-Internationalization" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItemLvl1-x3zjw7-3 fbnrTv jNZXlo"><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Internationalization</span></div></a><a href="/docs/mailgun/user-manual/subaccounts/"><div data-cy="sidebar-item-Subaccounts" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItemLvl1-x3zjw7-3 fbnrTv jNZXlo"><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Subaccounts</span></div></a></ul><div data-cy="sidebar-item-Libraries" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItem-x3zjw7-2 fbnrTv hUuGgg"><div class="MenuItem__ArrowWrapper-x3zjw7-10 iyAKUn"><i width="10px" height="10px" color="#272727" direction="right" data-cy="arrow" class="sc-cxxZvF gfpuWf"/></div><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Libraries</span></div><div data-cy="sidebar-item-API Reference" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItem-x3zjw7-2 fbnrTv hUuGgg"><div class="MenuItem__ArrowWrapper-x3zjw7-10 iyAKUn"><i width="10px" height="10px" color="#272727" direction="right" data-cy="arrow" class="sc-cxxZvF gfpuWf"/></div><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">API Reference</span></div><div data-cy="sidebar-item-FAQ" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItem-x3zjw7-2 fbnrTv hUuGgg"><div class="MenuItem__ArrowWrapper-x3zjw7-10 iyAKUn"><i width="10px" height="10px" color="#272727" direction="right" data-cy="arrow" class="sc-cxxZvF gfpuWf"/></div><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">FAQ</span></div><div data-cy="sidebar-item-Email Best Practices" class="MenuItem__MenuItemTitle-x3zjw7-1 MenuItem__NestedItem-x3zjw7-2 fbnrTv hUuGgg"><div class="MenuItem__ArrowWrapper-x3zjw7-10 iyAKUn"><i width="10px" height="10px" color="#272727" direction="right" data-cy="arrow" class="sc-cxxZvF gfpuWf"/></div><span class="MenuItem__MenuLabel-x3zjw7-7 iUJUaS">Email Best Practices</span></div></ul></ul></div></aside><div width="0" class="sc-havuDZ sc-cfARRi hmaQyK elEZud"><div style="background-color:#F6F6F6" class="Markdown__PageWrapper-f2h43u-2 kWEPxm"><section class="Markdown__ContentWrapper-f2h43u-5 bCNkdm"><section class="Markdown__InnerWrapper-f2h43u-7 euuAsD"><article class="sc-eqLmJG fDZIEZ"><h1 style="position:relative;"><a href="#sending-messages" aria-label="sending messages permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sending-messages"/>Sending Messages</h1> <h3 style="position:relative;"><a href="#table-of-contents" aria-label="table of contents permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="table-of-contents"/>Table of Contents</h3> <p><a href="#how-to-start-sending-messages">How to Start Sending Messages</a></p> <p><a href="#send-via-http">Send via HTTP</a></p> <p><a href="#send-via-smtp">Send via SMTP</a></p> <p><a href="#sending-a-message-with-sto">Send a Message with STO</a></p> <p><a href="#sending-a-message-with-tzo">Send a Message with TZO</a></p> <p><a href="#send-with-attachments">Send Message with Attachments</a></p> <p><a href="#message-queue">Message Queue</a></p> <p><a href="#batch-sending">Batch Sending</a></p> <p><a href="#mailing-lists">Mailing Lists</a></p> <p><a href="#templates">Templates</a></p> <p><a href="#scheduling-delivery">Scheduling Delivery</a></p> <p><a href="#sending-in-test-mode">Test Mode</a></p> <p><a href="#smtp-credentials">SMTP Credentials</a></p> <h2 style="position:relative;"><a href="#how-to-start-sending-messages" aria-label="how to start sending messages permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="how-to-start-sending-messages"/>How to Start Sending Messages</h2> <p>There are two ways to send messages using Mailgun that work great to support the same feature set. </p> <a href="#send-via-http">HTTP API</a> <p>Choose the one you'd like to use based on your preferences and requirements.</p> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>Since Mailgun does not host mailboxes, our service does not use the POP or IMAP protocols.</p></div></div> <h2 style="position:relative;"><a href="#send-via-http" aria-label="send via http permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="send-via-http"/>Send via HTTP</h2> <p>When sending an email via our HTTP API, Mailgun offers two options:</p> You can send a pre-built MIME. This assumes you've built an RFC-compliant MIME in your choice of tooling You can use our HTTP API to submit the individual parts (text, HTML, attachments, etc.) of your messages to Mailgun. <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>Some things to consider when sending emails with Mailgun:</p><ul> The maximum message size Mailgun supports is 25MB An error will be returned with <code class="language-text">"parameter is not a valid address"</code> if the provided email address fails syntax checks in accordance with RFC5321, RFC5322, RFC6854 Mailgun support receiving GZIP-compressed HTTP bodies if the <code class="language-text">Content-Encoding: gzip</code> header is present Bodies must be gzip-compressed as defined by <a href="https://www.rfc-editor.org/rfc/rfc1952.html">RFC1952</a> Compressing message bodies does bypass the above limit. This limit is enforced on the <em>uncompressed</em> Mailgun does have rate limits in place to protect our system. In the unlikely case you encounter them and need them raised, please reach out to our support team. <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>Please reference our <a href="http://localhost:3000/docs/mailgun/api-reference/intro/">API documentation</a> to see all available options when sending emails! Here's a couple examples using cURL to get you familiar with interacting with the API</p><p>If your domain exists in our EU region be sure to substitute “<a href="https://api.mailgun.net%E2%80%9D">https://api.mailgun.net”</a> with “<a href="https://api.eu.mailgun.net%E2%80%9D">https://api.eu.mailgun.net”</a> in the examples below.</p></div></div> <h3 style="position:relative;"><a href="#sending-basic-text" aria-label="sending basic text permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sending-basic-text"/>Sending Basic Text</h3> <p>Sending a simple text-based email using Mailgun's HTTP API requires a few parameters at minimum:</p> <div class="done-indicator done-indicator-46430578125216470000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages <span class="token punctuation">\</span> -F <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'Excited User &lt;postmaster@YOUR_DOMAIN_NAME&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>recipient-1@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>recipient-2@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">'Hello there!'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">text</span><span class="token operator">=</span><span class="token string">'Testing some Mailgun awesomeness!'</span></code></pre></div> <p>What actually happened:</p> Mailgun assembled a valid MIME message based on your input parameters Delivered the email to both recipients listed with the parameters Added log entries to our full text index that we Accepted the email, and if delivered successfully, added a Delivered event. (See the Events API for more details) <h3 style="position:relative;"><a href="#send-with-text-and-html-versions" aria-label="send with text and html versions permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="send-with-text-and-html-versions"/>Send With Text and HTML Versions</h3> <p>By including both the 'text' and 'html' parameters, you can offer two different versions of your email to the user:</p> <div class="done-indicator done-indicator-24620788859089980000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages <span class="token punctuation">\</span> -F <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'Excited User &lt;postmaster@YOUR_DOMAIN_NAME&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>recipient@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">"Hello there!"</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">text</span><span class="token operator">=</span><span class="token string">'This will be the text-only version'</span> <span class="token punctuation">\</span> --form-string <span class="token assign-left variable">html</span><span class="token operator">=</span><span class="token string">'&lt;html&gt;&lt;body&gt;&lt;p&gt;This is the HTML version&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;'</span></code></pre></div> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>A common gotcha: note the use of <code class="language-text">--form-string</code> in this example for the HTML part. Without this, your cURL command may fail to execute properly!</p></div></div> <h3 style="position:relative;"><a href="#send-a-single-message-with-tracking" aria-label="send a single message with tracking permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="send-a-single-message-with-tracking"/>Send a Single Message With Tracking</h3> <p>While tracking can be enabled for all messages in your Dashboard, you can also selectively enable tracking on a per-message basis. To enable all tracking types you use the 'o:tracking="yes"' parameter. Otherwise, you can enable only specific tracking for opens ('o:tracking-opens') or clicks ('o:tracking-clicks'):</p> <div class="done-indicator done-indicator-79429310679037300000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages <span class="token punctuation">\</span> -F <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'Excited User &lt;postmaster@YOUR_DOMAIN_NAME&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>recipient@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">"Hello there!"</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">text</span><span class="token operator">=</span><span class="token string">'Testing some Mailgun awesomeness!'</span> <span class="token punctuation">\</span> -F o:tracking-opens<span class="token operator">=</span><span class="token string">"yes"</span></code></pre></div> <h3 style="position:relative;"><a href="#send-a-message-with-specified-delivery-time" aria-label="send a message with specified delivery time permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="send-a-message-with-specified-delivery-time"/>Send a Message With Specified Delivery Time</h3> <p>The 'o:deliverytime' option allows you to specify when an email should be sent. It uses RFC822 date formatting and can be no more than 3 days in the future:</p> <div class="done-indicator done-indicator-53473156537416620000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages <span class="token punctuation">\</span> -F <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'Excited User &lt;postmaster@YOUR_DOMAIN_NAME&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>recipient@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">"Hello there!"</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">text</span><span class="token operator">=</span><span class="token string">'Testing some Mailgun awesomeness!'</span> <span class="token punctuation">\</span> -F o:deliverytime<span class="token operator">=</span><span class="token string">'Fri, 14 Oct 2011 23:10:10 -0000'</span></code></pre></div> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>If your billing plan supports 7 or more days of storage capability, you can now schedule emails out up to 7 days.</p></div></div> <h3 style="position:relative;"><a href="#send-a-message-using-tags" aria-label="send a message using tags permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="send-a-message-using-tags"/>Send a Message using Tags</h3> <p>Mailgun allows you to Tag emails for further analytics within our platform:</p> <div class="done-indicator done-indicator-23046201155613440000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages <span class="token punctuation">\</span> -F <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'Excited User &lt;postmaster@YOUR_DOMAIN_NAME&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>recipient@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">"Hello there!"</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">text</span><span class="token operator">=</span><span class="token string">'Testing some Mailgun awesomeness!'</span> <span class="token punctuation">\</span> -F o:tag<span class="token operator">=</span><span class="token string">'September newsletter'</span> <span class="token punctuation">\</span> -F o:tag<span class="token operator">=</span><span class="token string">'newsletters'</span></code></pre></div> <p>See <strong>Tags</strong> for more information!</p> <h3 style="position:relative;"><a href="#re-delivering-a-previously-sent-email" aria-label="re delivering a previously sent email permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="re-delivering-a-previously-sent-email"/>Re-Delivering a Previously-Sent Email</h3> <p>By default: emails sent through our APIs are stored for 72 hours. If you navigate to your Dashboard, check the Logs page and find a message sent within this time frame that you wish to resend, you should have a 'storage.url' field. Using that exact URL in your POST request, along with one or more 'to' parameters, you can deliver that MIME to the provided recipients:</p> <div class="done-indicator done-indicator-18880277979516813000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"> <span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">{</span><span class="token punctuation">{</span>STORAGE.URL<span class="token punctuation">}</span><span class="token punctuation">}</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span><span class="token string">'bob@example.com, john@example.com'</span></code></pre></div> <h2 style="position:relative;"><a href="#send-via-smtp" aria-label="send via smtp permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="send-via-smtp"/>Send via SMTP</h2> <p>First you'll need to grab your SMTP credentials (user and password).</p> <p>SMTP credentials are set and managed on a per-domain basis. You can view and modify them via our HTTP API or UI. To access them in our UI, navigate on the sidebar to <code class="language-text">Sending</code> -&gt; <code class="language-text">Domain Settings</code>, select your domain from the dropdown, then select the <code class="language-text">SMTP Credentials</code> tab.</p> <p>To send an email via SMTP you can utilize Swaks via your command line.</p> <div class="done-indicator done-indicator-86490247759653730000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token comment"># Swaks is the cURL equivalent for SMTP, install it first:</span> <span class="token function">curl</span> http://www.jetmore.org/john/code/swaks/files/swaks-20130209.0/swaks -o swaks <span class="token comment"># Set the permissions for the script so you can run it</span> <span class="token function">chmod</span> +x swaks <span class="token comment"># It's based on perl, so install perl</span> <span class="token function">sudo</span> <span class="token function">apt-get</span> -y <span class="token function">install</span> perl <span class="token comment"># now send!</span> ./swaks --auth <span class="token punctuation">\</span> --server smtp.mailgun.org <span class="token punctuation">\</span> --au YOUR-SMTP-<span class="token environment constant">USER</span> <span class="token punctuation">\</span> --ap YOUR-SMTP-PASSWORD <span class="token punctuation">\</span> --to recipient@example.com <span class="token punctuation">\</span> --h-Subject: <span class="token string">"Hello"</span> <span class="token punctuation">\</span> --body <span class="token string">'Testing some Mailgun awesomness!'</span></code></pre></div> <p>Mailgun SMTP servers listen on ports <code class="language-text">25</code>, <code class="language-text">465</code>, <code class="language-text">587</code>, and <code class="language-text">2525</code>. Port 465 requires a TLS connection. Ports <code class="language-text">25</code>, <code class="language-text">587</code>, and <code class="language-text">2525</code> require a non-TLS connection but may be upgraded to TLS using the STARTTLS command. We offer many different ports due to some ISPs blocking / throttling certain SMTP ports.</p> <p>Learn more about ports by reading our article, <a href="https://www.mailgun.com/blog/email/which-smtp-port-understanding-ports-25-465-587" target="_blank"> WHich SMTP Port Should I Use? Undertsanding Ports 25, 465,&amp; 587</a>.</p> <th><strong>Requirements</strong></th> SMTP send will error with "Cannot parse to address" or "cannot parse from address" if the provided email address fails syntax checks in accordance with RFC5321, RFC5322, RFC6854 <div class="admonition admonition-attention"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Warning!</h5></div><div class="admonition-content"><p><i> IP addresses for HTTP and SMTP API endpoints will change frequently and be subjected to change without notice. Be sure there are no IP-based ACLs that would prevent communication to new IP addresses that may be added or removed at any time. .</i></p></div></div> <h3 style="position:relative;"><a href="#passing-sending-options" aria-label="passing sending options permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="passing-sending-options"/>Passing Sending Options</h3> <p>When sending a message via SMTP, you can pass additional sending options via custom MIME headers listed in the table below:</p> <th>Header</th> <th>Description</th> <td><code class="language-text">X-Mailgun-Tag</code></td> <td>The Tag string is used for aggregating stats. You can make a message with several categories by setting multiple X-Mailgun-Tag headers.</td> <td><code class="language-text">X-Mailgun-Dkim</code></td> <td>Enables/disables DKIM signatures on a per-message basis. Use <code class="language-text">yes</code> or <code class="language-text">no</code></td> <td><code class="language-text">X-Mailgun-Deliver-By</code></td> <td>Use this to indicate the desired time of delivery.</td> <td><code class="language-text">X-Mailgun-Drop-Message</code></td> <td>Enables sending in test mode. Nte: Sending in Test Mode will not actually deliver an email but will emit a <code class="language-text">delivered</code> event with a 650 status code <code class="language-text">Pass</code>, <code class="language-text">yes</code>, or <code class="language-text">no</code> if needed.</td> <td><code class="language-text">X-Mailgun-Track</code></td> <td>Toggles tracking on a per-message basis. <code class="language-text">Pass</code>, <code class="language-text">yes</code> or <code class="language-text">no</code>.</td> <td><code class="language-text">X-Mailgun-Track-Clicks</code></td> <td>Toggles clicks tracking on a per-message basis. It has a higher priority than the domain-level setting. <code class="language-text">Pass</code>, <code class="language-text">yes</code>, <code class="language-text">no</code>, or <code class="language-text">htmlonly</code></td> <td><code class="language-text">X-Mailgun-Track-Opens</code></td> <td>Toggles opens tracking on a per-message basis. It has a higher priority than the domain-level setting. <code class="language-text">Pass</code>, <code class="language-text">yes</code> or <code class="language-text">no</code></td> <td><code class="language-text">X-Mailgun-Sending-Ip</code></td> <td>Used to specify an IP Address to send an email that is owned by your account</td> <td><code class="language-text">X-Mailgun-Sending-Ip-Pool</code></td> <td>If an IP Pool ID is provided, the email will be delivered with an IP that belongs in that pool</td> <td><code class="language-text">X-Mailgun-Require-TLS</code></td> <td>Use this header to control TLS connection settings. If set, Mailgun will only deliver the message over a secure TLS connection with the ESP. If TLS is not available, the delivery will fail</td> <td><code class="language-text">X-Mailgun-Skip-Verification</code></td> <td>Use this header to control TLS (Transport Layer Security) connection settings.</td> <td><code class="language-text">X-Mailgun-Secondary-DKIM</code></td> <td>Specify a second domain key to sign the email with. the value is formatted as <code class="language-text">signing_domain/selector</code>, e.g. <code class="language-text">example.com/s1</code>. This tells Mailgun to also sign the message with the signing domaing <code class="language-text">example.com</code> uaing the selector <code class="language-text">s1</code>. Note: the domain key specified must have been created and is active.</td> <td><code class="language-text">X-Mailgun-Secondary-DKIM-Public</code></td> <td>This header specified an alias of the domain key specified in <code class="language-text">X-Mailgun-SEcondary-DKIM</code>. Also formatted as <code class="language-text">public_signing_domain/selector</code>. The <code class="language-text">X-Mailgun-Secondary-DKIM</code> header must also be provided if this header is used. Mailgun will sign the message with the provate key of the secondary DKIM, but use the public secondary SKIM name and selector. Note: We will perform a DNS check prior to singing the message to ensure the public keye matches the secondiary DKIM.</td> <td><code class="language-text">X-Mailgun-Recipient-Variables</code></td> <td>Use this header to provide a JSON dictionary of variables to substitute for Batch messages.</td> <td><code class="language-text">X-Mailgun-Variables</code></td> <td>Use this header to attach custom JSON data to the message.</td> <td><code class="language-text">X-Mailgun-Delivery-Time-Optimize-Period</code></td> <td>Toggles STO on a per-message basis. The string should be set to the number of hours in <code class="language-text">[0-9]+h</code> format.</td> <td><code class="language-text">X-Mailgun-Time-Zone-Localize</code></td> <td>Toggles TZO on a per-message basis. The string should be set to the preferred delivery time in <code class="language-text">HH:mm</code> or <code class="language-text">hh:mmaa</code> format, where <code class="language-text">HH:mm</code> is used for a 24-hour format without AM/PM, and <code class="language-text">hh:mmaa</code> is used for 12-hour format with AM/PM.</td> <td><code class="language-text">X-Mailgun-Template-Name</code></td> <td>Name for the template to be rendered as the message body.</td> <td><code class="language-text">X-Mailgun-Template-Version</code></td> <td>Optional: Version of the template to be used, if different from the current active template.</td> <td><code class="language-text">X-Mailgun-Template-Template_variables</code></td> <td>Template specific variables to be used when rendering a template. Note: These variables will be preferred over X-Mailgun-Variables, e.g. user variables</td> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Tip:</h5></div><div class="admonition-content"><p>Yes, you can customize your SMTP Credentials. Go to the article, <a href="https://help.mailgun.com/hc/en-us/articles/8110785978267" target="_blank"> Can I Customize My SMTP Credentials?</a> for more information.</p></div></div> <h3 style="position:relative;"><a href="#a-common-gotcha-with-templates" aria-label="a common gotcha with templates permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="a-common-gotcha-with-templates"/>A common gotcha with Templates</h3> <p>If you send an email with, only, a <code class="language-text">text/plain body</code> <em>and</em> use the <code class="language-text">X-Mailgun-Template-Name</code> header: this will <em>not</em> result in a template-rendered email. <code class="language-text">text/plain</code> bodies are, typically, what you get when you send with Swaks!</p> <p>To get around this issue, add the correct <code class="language-text">Content-Type</code> header accordingly:</p> <div class="done-indicator done-indicator-91418683864877470000">Copied</div> <div class="gatsby-highlight" data-language="text"><pre class="language-text"><code class="language-text">--add-header 'Content-Type: text/html; charset="utf-8"'</code></pre></div> <p>You do <em>not</em> have to add this header explicitly via the HTTP API!</p> <h1 style="position:relative;"><a href="#sending-a-message-with-sto" aria-label="sending a message with sto permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sending-a-message-with-sto"/>Sending a Message with STO</h1> <p>Mailgun's <strong>Send Time Optimization</strong> (STO) feature uses machine learning to analyze engagement data (opens and clicks) for a recipient to determine when a user is most engaged with their messages. If there is enough engagement data to determine when the user is most engaged, Mailgun will hold onto the message and deliver it during that optimal period. The idea is to deliver the message to the recipient at a time when they are most likely to be engaged with their messages.</p> <h3 style="position:relative;"><a href="#sending-an-sto-message-via-api-and-smtp" aria-label="sending an sto message via api and smtp permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sending-an-sto-message-via-api-and-smtp"/>Sending an STO message via API and SMTP</h3> Send a message via API by passing the parameter: <strong><em>o:deliverytime-optimize-period</em></strong> Send an SMTP message using the MIME header: <strong>X-Mailgun-Delivery-Time-Optimize-Period</strong> The value should be a string in the [0-9] +h format. This format defines the window in which Mailgun will run optimization algorithm against the data that has been delivered to the message. Using a minimum value of 24h for best results, and the max value is 72h is highly recommended. <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>For more information on STO, see the article, <a href="https://help.mailgun.com/hc/en-us/articles/360042135833-What-is-Send-Time-Optimization-" target="_blank"> What is Send Time Optimization?</a>. Also, check out the <a href="https://help.mailgun.com/hc/en-us/articles/360041663454-Send-Time-Optimization-FAQ" target="_blank"> Send Time Optimization FAQ</a> </p></div></div> <h2 style="position:relative;"><a href="#sending-a-message-with-tzo" aria-label="sending a message with tzo permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sending-a-message-with-tzo"/>Sending a Message with TZO</h2> <p> Time Zone Optimization (TZO) allows senders to schedule messages to be delivered in a recipient's local time zone. TZO is like message scheduling, however, the focus is on passing the message on to the desired delivery time based on the recipient's local time zone.</p> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>Mailgun will convert the message to use the recipient's local time zone, when there is data present for the recipient. If Mailgun does not have data for that recipient, the message will be delivered immediately.</p></div></div> Time zones are based on a recipient's IP address Mailgun collects IP addresses on click events and uses a geo-location service to translate the IP address into a time zone for the user. The time zone is hashed and stored in a database, which Mailgun will look up for that user when a TZO message is sent. <h2 style="position:relative;"><a href="#sending-an-amp-message" aria-label="sending an amp message permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sending-an-amp-message"/>Sending an AMP Message</h2> <p>Google's Accelerated Mobile Pages (AMP) for email is a web component framework that you can use to easily create user-first websites, stories, emails, and ads. The AMP email format provides a subset of AMPHTML components for use in email messages, that allows recipients of AMP emails to interact dynamically with content directly in the message. Mailgun allows senders to include AMP components within their email message(s) using the <code class="language-text">amp-html</code> parameter. This allows recipients to interact within the email message.</p> <p>Some examples include:</p> Answering surveys Replying to documents Viewing inventory in real-time Submitting updates <h3 style="position:relative;"><a href="#amp-requirements" aria-label="amp requirements permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="amp-requirements"/>AMP Requirements</h3> <p>While AMP is a really exciting email tool, it takes a bit of setup before you can successfully send an AMP email message to your recipients.</p> <h4 style="position:relative;"><a href="#registration" aria-label="registration permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="registration"/>Registration</h4> <p>Here's what you'll need to know to register:</p> In order to send AMP emails to mailboxes that support it (Gmail for now), you’ll need to register your sending domain with Google. <a href="https://support.google.com/mail/answer/81126">Click here</a> to register. <h4 style="position:relative;"><a href="#content" aria-label="content permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="content"/>Content</h4> Your AMP email content must comply with Google's requirements. Be sure to look at Google's <a href="https://support.google.com/mail/answer/81126">Bulk Senders Guidelines</a> before composing your email. AMP messages must follow the <a href="https://amp.dev/documentation/guides-and-tutorials/learn/email-spec/amp-email-format">AMP for Email Specifications</a> . Specifically, the required markup, AMP components, and CSS requirements. To ensure your content will pass the validation process, use Gmail's <a href="https://amp.gmail.dev/playground/">AMP for Email Playground</a> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>If you follow the AMP requirements set by Google, you should be well on your way to sending AMP messages.</p></div></div> <h4 style="position:relative;"><a href="#https-urls" aria-label="https urls permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="https-urls"/>HTTPS URLs</h4> <p>All URLs must use HTTPS, including tracking and unsubscribe URLs. If you're using Mailgun for your open/click tracking and unsubscribe UR:s, you'll need to <a href="https://help.mailgun.com/hc/en-us/articles/360011566033-How-to-Enable-HTTPS-Tracking-Links">Follow these steps</a> to enable HTTPS on your Mailgun tracking URLs. </p> <h3 style="position:relative;"><a href="#sending-amp-emails" aria-label="sending amp emails permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sending-amp-emails"/>Sending AMP emails</h3> <p>Mailgun has made it easy to send an AMP email using our API by providing the optional <code class="language-text">amp-html</code> parameter along with your AMP content. Mailgun will take care of building the proper <code class="language-text">text/x-amp-html</code> MIME portion. As long as you’re following the AMP requirements set by Google, you should be well on your way to sending your AMP messages.</p> <h3 style="position:relative;"><a href="#testing-your-amp-email-messages" aria-label="testing your amp email messages permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="testing-your-amp-email-messages"/>Testing your AMP email messages</h3> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>You can build and test your AMP email messages even while you're waiting for Google to register your domain.</p></div></div> <h3 style="position:relative;"><a href="#amp-best-practices" aria-label="amp best practices permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="amp-best-practices"/>AMP Best Practices</h3> Visit your Gmail settings page ( <em>GSuite users will need their admins to enable the Dynamic Email Option</em> Click the <strong>Dynamic Email</strong> section, check the box to <strong>Enable Dynamic Email</strong> Click <strong>Developer Settings</strong> Enter your sending address in the field – This will whitelist your sending address. Click <p>Following the proper requirements and these steps for sending AMP messages will allow you to be able to receive an AMP email from your sending address to your Gmail account.</p> <h2 style="position:relative;"><a href="#send-with-attachments" aria-label="send with attachments permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="send-with-attachments"/>Send with Attachments</h2> <p>Adding attachments uses the 'attachment' parameter. This example attaches 2 files to the email:</p> <div class="done-indicator done-indicator-53727480718377270000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages <span class="token punctuation">\</span> -F <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'Excited User &lt;postmaster@YOUR_DOMAIN_NAME&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>recipient@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">"Hello there!"</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">text</span><span class="token operator">=</span><span class="token string">'Testing some Mailgun awesomeness!'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">attachment</span><span class="token operator">=</span>@tps-report.txt <span class="token punctuation">\</span> -F <span class="token assign-left variable">attachment</span><span class="token operator">=</span>@cover-letter.txt</code></pre></div> <p>You can also use the 'inline' parameter to include inline files that are intended to be displayed in the message itself (note the <code class="language-text">cid:email.jpg</code> reference):</p> <div class="done-indicator done-indicator-90101081373431380000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages <span class="token punctuation">\</span> -F <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'Excited User &lt;postmaster@YOUR_DOMAIN_NAME&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>recipient@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">"Hello there!"</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">inline</span><span class="token operator">=</span>@email.jpg <span class="token punctuation">\</span> --form-string <span class="token assign-left variable">html</span><span class="token operator">=</span><span class="token string">'&lt;html&gt;&lt;body&gt;&lt;p&gt;Hello from &lt;img src="cid:email.jpg"/&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;'</span></code></pre></div> <h3 style="position:relative;"><a href="#attaching-data-to-messages" aria-label="attaching data to messages permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="attaching-data-to-messages"/>Attaching Data to Messages</h3> <p>When sending messages, you can attach data for later retrieval. For instance, you can attach campaign or recipient identifiers to messages to help relate webhook payloads or events retrieved from mailgun back to marketing campaigns or individual recipients in your system.</p> <p>There are two methods for attaching data to emails depending on if you're sending messages via SMTP or via API.</p> <h3 style="position:relative;"><a href="#attaching-data-to-emails-via-smtp" aria-label="attaching data to emails via smtp permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="attaching-data-to-emails-via-smtp"/>Attaching Data to emails via SMTP</h3> <p>When sending messages via SMTP, you can attach data by providing a X-Mailgun-Variables header. You can provide multiple X-Mailgun-Variables headers, their map values will be combined. The header data must be in JSON map format, as shown in the example below.</p> <div class="done-indicator done-indicator-34032192464851830000">Copied</div> <div class="gatsby-highlight" data-language="json"><pre class="language-json"><code class="language-json">X-Mailgun-Variables<span class="token operator">:</span> <span class="token punctuation">{</span><span class="token property">"first_name"</span><span class="token operator">:</span> <span class="token string">"John"</span><span class="token punctuation">,</span> <span class="token property">"last_name"</span><span class="token operator">:</span> <span class="token string">"Smith"</span><span class="token punctuation">}</span> X-Mailgun-Variables<span class="token operator">:</span> <span class="token punctuation">{</span><span class="token property">"my_message_id"</span><span class="token operator">:</span> <span class="token number">123</span><span class="token punctuation">}</span></code></pre></div> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>The value of the "X-Mailgun-Variables" header must be a valid JSON string, otherwise Mailgun won't be able to parse it. If your "X-Mailgun-Variables" header exceeds 998 characters, you should use folding to spread the variables over multiple lines.</p></div></div> <h3 style="position:relative;"><a href="#attaching-data-to-emails-via-api" aria-label="attaching data to emails via api permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="attaching-data-to-emails-via-api"/>Attaching Data to emails via API</h3> <p> If you are sending email via the HTTP API, you can attach data by providing a form parameter with v:</p> <p>For example:</p> <div class="done-indicator done-indicator-57026828839060740000">Copied</div> <div class="gatsby-highlight" data-language="json"><pre class="language-json"><code class="language-json">v<span class="token operator">:</span>first_name=John v<span class="token operator">:</span>last_name=Smith v<span class="token operator">:</span>my_message_id=<span class="token number">123</span></code></pre></div> <p> The data provided will be included in the recipient's email via a header called X-Mailgun-Variables. Additionally, the data will also be available via webhook payloads, and events returned from the events API. The data will be attached to these payloads via the user-variables field as a JSON map. For example:</p> <div class="done-indicator done-indicator-30153984382122045000">Copied</div> <span class="token property">"event"</span><span class="token operator">:</span> <span class="token string">"delivered"</span><span class="token punctuation">,</span> <span class="token property">"user-variables"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"first_name"</span><span class="token operator">:</span> <span class="token string">"John"</span><span class="token punctuation">,</span> <span class="token property">"last_name"</span><span class="token operator">:</span> <span class="token string">"Smith"</span><span class="token punctuation">,</span> <span class="token property">"my_message_id"</span><span class="token operator">:</span> <span class="token string">"123"</span> <p>When sending batches of emails, you can use values from recipient variables to provide a custom variable per recipient using templating. For example, given a variable of v:recipient-id=%recipient.id%and a recipient variable of{"user1@example.com" : { "id": 123 }}events andwebhooks associated with the recipient user1@example.comwill contain auser-variablefield with the content of{ "recipient-id": "123" }</p> <p>When using variables, the X-Mailgun-Variables header will be included in the MIME of the delivered email. This means that recipients who receive emails when variables are used will be able to see the variables if they view the MIME headers.</p> <h2 style="position:relative;"><a href="#message-queue" aria-label="message queue permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="message-queue"/>Message Queue</h2> <p>The queuing algorithms are one of the most important features of Mailgun. If you try sending bulk mailings all at once, most ISPs will block you. Mailgun will put your messages in a message queue when you submit them for delivery.</p> A large number of messages can be submitted. Mailgun will automatically queue for the delivery in compliance with the receiving domains' guidelines and maximum sending rate optimized for each ESP (email service provider), such as Yahoo, Gmail, etc. Your messages may take longer at first, however, your sending rates will increase the more you send messages. As your reputation grows, your sending rate will grow too. <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>Note: It is important to make sure you are sending quality traffic to ensure sending rates.</p></div></div> <p>It is important to gradually increase your sending rates according to many factors, including:</p> Consistency of traffic IP address sending history Domain reputation. <h2 style="position:relative;"><a href="#batch-sending" aria-label="batch sending permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="batch-sending"/>Batch Sending</h2> <p>Mailgun supports the ability to send to a group of recipients through a single API call, or SMTP session. This is achieved by:</p> Using Batch Sending by specifying multiple recipient email addresses as parameters and using Recipient Variables. Using Mailing Lists with the Template Variables <div class="admonition admonition-attention"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Warning!</h5></div><div class="admonition-content"><p><i> When using Batch Sending, it is important to also use Recipient Variables. This will ensure that Mailgun will send an individual to each recipient in the <strong>to</strong> field. If this is not done, the email will show all recipients emails in the <strong>to</strong> field for all recipients </i></p></div></div> <h3 style="position:relative;"><a href="#recipient-variables" aria-label="recipient variables permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="recipient-variables"/>Recipient Variables</h3> <p><strong>Recipient Variables</strong> are custom variables that you define to allow the ability to send a custom message to each recipient while using a single API call (or SMTP session).</p> <p>To access a Recipient Variable within your email, simply reference %recipient.yourkey%. For example, consider the following JSON:</p> <div class="done-indicator done-indicator-73449830746693490000">Copied</div> <span class="token property">"user1@example.com"</span> <span class="token operator">:</span> <span class="token punctuation">{</span><span class="token property">"unique_id"</span><span class="token operator">:</span> <span class="token string">"ABC123456789"</span><span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"user2@example.com"</span> <span class="token operator">:</span> <span class="token punctuation">{</span><span class="token property">"unique_id"</span><span class="token operator">:</span> <span class="token string">"ZXY987654321"</span><span class="token punctuation">}</span> <p> To reference the above variable within your email, use %recipient.unique_id%</p> <p>Recipient Variables allow to:</p> Submit a message template Include multiple recipients Include a set of key value pairs with unique data for each recipient <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages <span class="token punctuation">\</span> -F <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'Excited User &lt;postmaster@YOUR_DOMAIN_NAME&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>alice@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>bob@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">"Hey %recipient.name%"</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">text</span><span class="token operator">=</span><span class="token string">'If you wish to unsubscribe, click &lt;https://mailgun.com/unsubscribe/%recipient.id%&gt;'</span> <span class="token punctuation">\</span> -F recipient-variables<span class="token operator">=</span><span class="token string">'{"alice@example.com": {"name":"Alice", "id":1}, "bob@example.com": {"name":"Bob", "id":2}}'</span> <span class="token punctuation">\</span></code></pre></div> <p>The example above: Alice and Bob both will get personalized subject lines, "Hey, Alice", and "Hey, Bob", as well as unique unsubscribe links.</p> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><ul> The maximum number of recipients allowed for batch is 1,000 Recipient variables should be set as a valid JSON-encoded dictionary where key is a plain recipient address, and value is a dictionary with variables. <p>When sent via SMTP, recipient variables can be included by adding the following header to your email:</p> <p><code class="language-text">X-Mailgun-Recipient-Variables: {"user1@example.com": {"unique\_id": "ABC123456789"}}</code></p> <p>Example:</p> <div class="done-indicator done-indicator-89831723590012350000">Copied</div> <div class="gatsby-highlight" data-language="mime"><pre class="language-mime"><code class="language-mime">X-Mailgun-Recipient-Variables: {"bob@example.com": {"first":"Bob", "id":1}, "alice@example.com": {"first":"Alice", "id": 2}} From: me@example.com To: %recipient% Date: 29 Mar 2016 00:23:35 -0700 Subject: Hello, %recipient.first%! Message-Id: &lt;20160329071939.35138.9413.6915422C@example.com&gt; Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Hi, %recipient.first%, Please review your profile at example.com/orders/%recipient.id%. Thanks, Example.com Team</code></pre></div> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><ul> The value of the "X-Mailgun-Recipient-Variables" header should be a valid JSON string, otherwise Mailgun won't be able to parse it. If your "X-Mailgun-Recipient-Variables" header exceeds 998 characters, you should use folding to spread the variables over multiple lines. <p>They can also be supplied through a special construct called a Variable Container.</p> <p>To contain variables, create the following MIME construct:</p> <div class="done-indicator done-indicator-17579921697132317000">Copied</div> <div class="gatsby-highlight" data-language="mime"><pre class="language-mime"><code class="language-mime">multipart/mailgun-variables --application/json (base64 encoded) --message/rfc822 ----original-message</code></pre></div> <p> In this construct, JSON will be Base64 encoded, and will be stored inside the part of the body which will handle recipient variables containing special characters.</p> <p>Example:</p> <div class="done-indicator done-indicator-70152967955463640000">Copied</div> <div class="gatsby-highlight" data-language="json"><pre class="language-json"><code class="language-json">Content-Type<span class="token operator">:</span> multipart/mailgun-variables; boundary=<span class="token string">"8686cc907910484e9d21c54776cd791c"</span> Mime-Version<span class="token operator">:</span> <span class="token number">1.0</span> From<span class="token operator">:</span> me@example.com Date<span class="token operator">:</span> Thu<span class="token punctuation">,</span> <span class="token number">26</span> Jul <span class="token number">2012</span> <span class="token number">15</span><span class="token operator">:</span><span class="token number">43</span><span class="token operator">:</span><span class="token number">07</span> +<span class="token number">0000</span> Message-Id<span class="token operator">:</span> &lt;<span class="token number">20120726154307.29852</span>.<span class="token number">44460</span>@definebox.com&gt; Sender<span class="token operator">:</span> bob=bob-mg@definebox.com --8686cc907910484e9d21c54776cd791c Mime-Version<span class="token operator">:</span> <span class="token number">1.0</span> Content-Type<span class="token operator">:</span> application/json Content-Transfer-Encoding<span class="token operator">:</span> base64 eyJkZXNjcmlwdGlvbiI6ICJrbGl6aGVudGFzIn0= --8686cc907910484e9d21c54776cd791c Content-Type<span class="token operator">:</span> message/rfc822 Mime-Version<span class="token operator">:</span> <span class="token number">1.0</span> Date<span class="token operator">:</span> Thu<span class="token punctuation">,</span> <span class="token number">26</span> Jul <span class="token number">2012</span> <span class="token number">19</span><span class="token operator">:</span><span class="token number">42</span><span class="token operator">:</span><span class="token number">55</span> +<span class="token number">0400</span> To<span class="token operator">:</span> %recipient.description% &lt;support@mailgunhq.com&gt; From<span class="token operator">:</span> me@example.com Subject<span class="token operator">:</span> (rackspace) Hello MSK <span class="token number">2012</span> support@mailgunhq.com %recipient.description% Message-Id<span class="token operator">:</span> &lt;<span class="token number">20120726154302.29322</span>.<span class="token number">40670</span>@definebox.com&gt; support@mailgunhq.com %recipient.description% --8686cc907910484e9d21c54776cd791c--</code></pre></div> <h2 style="position:relative;"><a href="#mailing-lists" aria-label="mailing lists permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="mailing-lists"/>Mailing Lists</h2> <p>Mailing Lists are a great way to send to multiple recipients while using an email alias. When you use mailing lists, Mailgun will send a copy of the message to each subscribed member using the email alias. You can create and maintain your subscriber lists using the API or Control Panel. In addition, you can use Template Variables to create a unique message for each member of the mailing list.</p> <h3 style="position:relative;"><a href="#using-mailing-lists" aria-label="using mailing lists permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="using-mailing-lists"/>Using Mailing Lists</h3> Create a mailing list email address (example: devs@example.com) Add member email addresses to the mailing list Each time you send a message using the mailing list email address (example: devs@example.com), a copy of the email is delivered to each subscribed member. <h3 style="position:relative;"><a href="#managing-a-mailing-list" aria-label="managing a mailing list permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="managing-a-mailing-list"/>Managing a Mailing List</h3> <p>You can create Mailing Lists using the Mailing Lists tab in the Control Panel or through the API. To make it easier, Mailgun has support for a couple different formats to upload Mailing List members:</p> You can upload a CSV file with the members. You can use a JSON array form parameter You can use form-like file upload <p>Creating a mailing list through the API:</p> <div class="done-indicator done-indicator-48024116661512430000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/lists <span class="token punctuation">\</span> -F <span class="token assign-left variable">address</span><span class="token operator">=</span><span class="token string">'LIST@YOUR_DOMAIN_NAME'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">description</span><span class="token operator">=</span><span class="token string">'Mailgun developers list'</span></code></pre></div> <p>Adding a single member through the API:</p> <div class="done-indicator done-indicator-38841851522993490000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/lists/LIST@YOUR_DOMAIN_NAME/members <span class="token punctuation">\</span> -F <span class="token assign-left variable">subscribed</span><span class="token operator">=</span>True <span class="token punctuation">\</span> -F <span class="token assign-left variable">address</span><span class="token operator">=</span><span class="token string">'bar@example.com'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'Bob Bar'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">description</span><span class="token operator">=</span><span class="token string">'Developer'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">vars</span><span class="token operator">=</span><span class="token string">'{"age": 26}'</span></code></pre></div> <p>Adding multiple members using the JSON array approach, you can either send a flat list of member addresses:</p> <div class="done-indicator done-indicator-96293842006228350000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/lists/LIST@YOUR_DOMAIN_NAME/members.json <span class="token punctuation">\</span> -F <span class="token assign-left variable">members</span><span class="token operator">=</span><span class="token string">'["alice@example.com","bob@example.com"]'</span></code></pre></div> <p>Members added this way are implicitly set as <code class="language-text">subscribed</code>.</p> <p>Alternatively, you can provide the full JSON payload expected for a member for the same fine-grained control when adding a single member:</p> <div class="done-indicator done-indicator-18903740008101290000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/lists/LIST@YOUR_DOMAIN_NAME/members.json <span class="token punctuation">\</span> -F <span class="token assign-left variable">members</span><span class="token operator">=</span><span class="token string">'[{"name": "Bob Bar", "address": "bar@example.com", "subscribed": true, "vars": "{}"}]'</span></code></pre></div> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>Note the use of <code class="language-text">vars</code> to attach a JSON dictionary with structured data to each member of the mailing list. You can reference that data in the body of the message using Template Variables.</p><p>There are two modes available when adding a new member, strict and upsert.</p><ul> Strict will raise an error in case the member already exists. Upsert will update an existing member if it's already in the list or insert a new one. </ul><p>Learn how to toggle between the modes and skip malformed addresses in the API documentation pages for the Mailing Lists API </p></div></div> <h3 style="position:relative;"><a href="#sending-to-a-mailing-list" aria-label="sending to a mailing list permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sending-to-a-mailing-list"/>Sending to a Mailing List</h3> <p>Sending to a Mailing List is as easy as using one of our APIs, HTTP or SMTP, and sending an email to the address created for the Mailing List as the recipient.</p> <p>You can set the access level on Mailing Lists to:</p> Only allow the administrator to post to the list (limited to an API call or authenticated SMTP session) Allow Mailing List members to post to the list Allow anybody to post to the list <h3 style="position:relative;"><a href="#replying-to-a-mailing-list" aria-label="replying to a mailing list permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="replying-to-a-mailing-list"/>Replying to a Mailing List</h3> <p>You can set the preferred method to where a reply to the list should go:</p> Replies to the list go to the list address. This is the default setting for any new list created, except for read-only lists, where replies can only go to the sender. Reply-all will still go to the list. <code class="language-text">sender</code> Replies to the list going to the sender (FROM) address. This is the default and the only option for read-only lists. <h3 style="position:relative;"><a href="#template-variables" aria-label="template variables permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="template-variables"/>Template Variables</h3> <p>There are some pre-defined variables you can use to personalize your message to each recipient.</p> <th>Header</th> <th>Description</th> <td><code class="language-text">%recipient%</code></td> <td>Full recipient spec, like “Bob <a href="mailto:bob@example.com">bob@example.com</a>” (for using as value for “To” MIME header).</td> <td><code class="language-text">%recipient_email%</code></td> <td>Recipient’s email address, like bob@example.com.</td> <td><code class="language-text">%recipient_name%</code></td> <td>Recipient’s full name, like “John Q. Public”.</td> <td><code class="language-text">%recipient_fname%</code></td> <td>Recipient’s first name.</td> <td><code class="language-text">%recipient_lname%</code></td> <td>Recipient’s last name.</td> <td><code class="language-text">%unsubscribe_url%</code></td> <td>A generated URL which allows users to unsubscribe from messages.</td> <td><code class="language-text">%mailing_list_unsubscribe_url%</code></td> <td>A generated URL which allows users to unsubscribe from mailing lists.</td> <td><code class="language-text">%unsubscribe_email%</code></td> <td>An email address which can be used for automatic unsubscription by adding it to List-Unsubscribe MIME header.</td> <td><code class="language-text">%recipient.yourvar%</code></td> <td>Accessing a custom datavalue. (see Attaching Data to Messages)</td> <h3 style="position:relative;"><a href="#unsubscribing" aria-label="unsubscribing permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="unsubscribing"/>Unsubscribing</h3> <p>To manage unsubscribes in Mailing Lists, you can use %mailing_list_unsubscribe_url%. Mailgun will generate a unique link to unsubscribe from the mailing list. Once a recipient clicks on the unsubscribe link. The recipient is marked as "unsubscribed" from this mailing list and won't get any further emails addressed to this list.</p> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>You can still override the "unsubscribe" setting via the API or the Control Panel (in case of user error or accidental unsubscribe). You can also manually unsubscribe to the customer without using any links via the API or the Control Panel. Read more in the Mailing Lists API section.</p></div></div> <h3 style="position:relative;"><a href="#mailing-lists-and-routes" aria-label="mailing lists and routes permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="mailing-lists-and-routes"/>Mailing Lists and Routes</h3> <p>Mailing lists work independently from Routes. When there is a Mailing List or Route with the same address, the incoming message will hit the Route and Mailing List simultaneously. This can be convenient for processing replies to the Mailing List and integrating into things like forums or commenting systems.</p> <h2 style="position:relative;"><a href="#templates" aria-label="templates permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="templates"/>Templates</h2> <p>Mailgun allows you to store predefined templates via the Template API and use them to send messages via the Sending API by providing the template name. The hard defined limit for templates is 100 templates per domain. Each template can have up to 10 versions. </p> <p>To learn more about templates and how to use them, see the article: <a href="https://help.mailgun.com/hc/en-us/articles/360021380793-What-s-Up-with-Mailgun-Templates-" target="_blank"> What's Up with Mailgun Templates?</a></p> <p>To send a message using the template feature:</p> <p>First, you must create a template. You can do this via the Template API, or via our Template Builder in our UI.</p> <div class="done-indicator done-indicator-21334385149054947000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -X POST -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/templates <span class="token punctuation">\</span> --form-string <span class="token assign-left variable">template</span><span class="token operator">=</span><span class="token string">'&lt;div class="entry"&gt; &lt;h1&gt;{{title}}&lt;/h1&gt; &lt;div class="body"&gt; {{body}} &lt;/div&gt; &lt;/div&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'template.test'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">description</span><span class="token operator">=</span><span class="token string">'Sample template'</span></code></pre></div> <p>The response returns stored template information:</p> <div class="done-indicator done-indicator-4113853557191582000">Copied</div> <span class="token property">"template"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"createdAt"</span><span class="token operator">:</span> <span class="token string">"Wed, 29 Aug 2018 23:31:13 UTC"</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"Sample template"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"template.test"</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"template has been stored"</span> <p>The template is now ready to use for sending messages:</p> <div class="done-indicator done-indicator-80093490384696560000">Copied</div> <div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -s --user <span class="token string">'api:YOUR_API_KEY'</span> <span class="token punctuation">\</span> https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages <span class="token punctuation">\</span> -F <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'Excited User &lt;postmaster@YOUR_DOMAIN_NAME&gt;'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">to</span><span class="token operator">=</span>recipient@example.com <span class="token punctuation">\</span> -F <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">'Hello there!'</span> <span class="token punctuation">\</span> -F <span class="token assign-left variable">template</span><span class="token operator">=</span><span class="token string">"template.test"</span> <span class="token punctuation">\</span> -F t:variables<span class="token operator">=</span><span class="token string">'{"title": "API documentation", "body": "Sending messages with templates"}'</span></code></pre></div> <p>If you are sending a MIME, you can instead pass template variables via the X-Mailgun-Template-Variables header.</p> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>Values can be defined via the v: option or X-Mailgun-Variables in your templates. However, if you do so, the variables are included in the delivered message via the X-Mailgun-Variables header. If this is not desired, use the t:variables option or X-Mailgun-Template-Variables header instead.</p></div></div> <h3 style="position:relative;"><a href="#handlebars" aria-label="handlebars permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="handlebars"/>Handlebars</h3> <p>Mailgun's templates use a fork of the template engine, <a href="https://handlebarsjs.com/">Handlebars.</a> To provide values for substitution, you must use <a href="#_Attaching_Data_to">Attaching Data to Messages</a>.</p> <p>One of the easy ways to implement dynamic content in your template is to use Handlebar's Block Helpers. Mailgun's implementation of Handlebars supports the following block helpers: if, unless, each, with, equal.</p> <th>Helper</th> <th>Description</th> <td>The if helper allows you to conditionally render a block in your template. For example, if you wanted to use a template that would dynamically change the language in the body.</td> <td><code class="language-text">unless</code></td> <td>The unless helper is essentially the inverse of the if helper. The block will only be rendered if the expression returns a false value.</td> <td>The each helper allows you to iterate through a list.</td> <td><code class="language-text">equal</code></td> <td>The equal helper renders a block if the string version of both arguments are equal.</td> <h2 style="position:relative;"><a href="#scheduling-delivery" aria-label="scheduling delivery permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="scheduling-delivery"/>Scheduling Delivery</h2> <p>Mailgun allows you to request a specific time for delivering messages.</p> <p>Use o:deliverytime parameter if sending via the API. Use the MIME header X-Mailgun-Deliver-By when sending via SMTP.</p> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>If your billing plan supports 7 or more days of storage capability, you can now schedule emails out up to 7 days.</p></div></div> <h2 style="position:relative;"><a href="#sending-in-test-mode" aria-label="sending in test mode permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sending-in-test-mode"/>Sending in Test Mode</h2> <p>You can send messages in test mode by setting the <code class="language-text">o:testmode</code> parameter to true. When you do this, Mailgun will accept the message but will not send it. This is useful for testing purposes.</p> <div class="admonition admonition-info"><div class="admonition-heading"><h5><span class="admonition-icon"><i/></span>Note:</h5></div><div class="admonition-content"><p>You are charged for messages sent in test mode!</p></div></div> <h2 style="position:relative;"><a href="#smtp-credentials" aria-label="smtp credentials permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="smtp-credentials"/>SMTP Credentials</h2> <p>Mailgun gives you the ability to programmatically create SMTP credentials which can be used to send mail. SMTP credentials can be used to relay email, through Mailgun, using the SMTP protocol.</p> <h4 style="position:relative;"><a href="#listing-all-credentials" aria-label="listing all credentials permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="listing-all-credentials"/>Listing all credentials:</h4> <div class="done-indicator done-indicator-13261710407333106000">Copied</div> <div class="gatsby-highlight" data-language="json"><pre class="language-json"><code class="language-json">import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.JsonNode; import com.mashape.unirest.http.Unirest; import com.mashape.unirest.http.exceptions.UnirestException; public class MGSample <span class="token punctuation">{</span> <span class="token comment">// ...</span> public static JsonNode getCredentials() throws UnirestException <span class="token punctuation">{</span> HttpResponse&lt;JsonNode&gt; request = Unirest.get(<span class="token string">"https://api.mailgun.net/v3/domains/"</span> + YOUR_DOMAIN_NAME + <span class="token string">"/credentials"</span>) .basicAuth(<span class="token string">"api"</span><span class="token punctuation">,</span> API_KEY) .asJson(); return request.getBody(); <p>Sample response</p> <div class="done-indicator done-indicator-46675641625926840000">Copied</div> <span class="token property">"total_count"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token property">"size_bytes"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"created_at"</span><span class="token operator">:</span> <span class="token string">"Tue, 27 Sep 2011 20:24:22 GMT"</span><span class="token punctuation">,</span> <span class="token property">"mailbox"</span><span class="token operator">:</span> <span class="token string">"user@samples.mailgun.org"</span> <span class="token property">"login"</span><span class="token operator">:</span> <span class="token string">"user@samples.mailgun.org"</span> <span class="token property">"size_bytes"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"created_at"</span><span class="token operator">:</span> <span class="token string">"Thu, 06 Oct 2011 10:22:36 GMT"</span><span class="token punctuation">,</span> <span class="token property">"mailbox"</span><span class="token operator">:</span> <span class="token string">"user@samples.mailgun.org"</span> <span class="token property">"login"</span><span class="token operator">:</span> <span class="token string">"user@samples.mailgun.org"</span> <h4 style="position:relative;"><a href="#creating-a-new-smtp-credential" aria-label="creating a new smtp credential permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="creating-a-new-smtp-credential"/>Creating a new SMTP credential:</h4> <span class="tab-header active" data-lang="JSON" data-snippet-id="JSON">JSON</span><span class="tab-header " data-lang="JSON" data-snippet-id="JSON-1">JSON</span> <div class="gatsby-highlight" data-language="json"><pre class="language-json"><code class="language-json">import com.mailgun.api.v3.MailgunDomainsApi; import com.mailgun.model.ResponseWithMessage; import com.mailgun.model.domains.DomainCredentials; <span class="token comment">// ...</span> public ResponseWithMessage createCredentials() <span class="token punctuation">{</span> MailgunDomainsApi mailgunDomainsApi = MailgunClient.config(API_KEY) .createApi(MailgunDomainsApi.class); DomainCredentials domainCredentials = DomainCredentials.builder() .login(<span class="token string">"alice@YOUR_DOMAIN_NAME.com"</span>) .password( <span class="token string">"super_secret_password"</span>) .build(); return mailgunDomainsApi.createNewCredentials(YOUR_DOMAIN_NAME<span class="token punctuation">,</span> domainCredentials); <div class="done-indicator done-indicator-83213827068916270000">Copied</div> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Created 1 credentials pair(s)"</span> <h4 style="position:relative;"><a href="#updating-the-password-for-a-given-credential" aria-label="updating the password for a given credential permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="updating-the-password-for-a-given-credential"/>Updating the password for a given credential:</h4> <div class="done-indicator done-indicator-86123399909921360000">Copied</div> <div class="gatsby-highlight" data-language="json"><pre class="language-json"><code class="language-json">import com.mailgun.api.v3.MailgunDomainsApi; import com.mailgun.model.ResponseWithMessage; <span class="token comment">// ...</span> public ResponseWithMessage updatePassword() <span class="token punctuation">{</span> MailgunDomainsApi mailgunDomainsApi = MailgunClient.config(API_KEY) .createApi(MailgunDomainsApi.class); return mailgunDomainsApi.updateCredentials(YOUR_DOMAIN_NAME<span class="token punctuation">,</span> YOUR_LOGIN<span class="token punctuation">,</span> <span class="token string">"super_secret_password"</span>); <h4 style="position:relative;"><a href="#sample-response" aria-label="sample response permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sample-response"/>Sample Response</h4> <div class="done-indicator done-indicator-11386884206207482000">Copied</div> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Password changed"</span> <h4 style="position:relative;"><a href="#deleting-a-given-credential" aria-label="deleting a given credential permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="deleting-a-given-credential"/>Deleting a given credential:</h4> <div class="done-indicator done-indicator-64414482085267790000">Copied</div> <div class="gatsby-highlight" data-language="json"><pre class="language-json"><code class="language-json">import com.mailgun.api.v3.MailgunDomainsApi; import com.mailgun.model.ResponseWithMessage; public ResponseWithMessage deleteCredentials() <span class="token punctuation">{</span> MailgunDomainsApi mailgunDomainsApi = MailgunClient.config(API_KEY) .createApi(MailgunDomainsApi.class); return mailgunDomainsApi.deleteCredentials(YOUR_DOMAIN_NAME<span class="token punctuation">,</span> YOUR_LOGIN);</code></pre></div> <h4 style="position:relative;"><a href="#sample-response-1" aria-label="sample response 1 permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewbox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"/></svg></a><div class="hidden-anchor" id="sample-response-1"/>Sample Response:</h4> <div class="done-indicator done-indicator-54966583357341570000">Copied</div>