You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

501 lines
15 KiB

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
  7. <title>Mail tracking for Mailgun</title>
  8. <style type="text/css">
  9. /*
  10. :Author: David Goodger (goodger@python.org)
  11. :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
  12. :Copyright: This stylesheet has been placed in the public domain.
  13. Default cascading style sheet for the HTML output of Docutils.
  14. See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
  15. customize this style sheet.
  16. */
  17. /* used to remove borders from tables and images */
  18. .borderless, table.borderless td, table.borderless th {
  19. border: 0 }
  20. table.borderless td, table.borderless th {
  21. /* Override padding for "table.docutils td" with "! important".
  22. The right padding separates the table cells. */
  23. padding: 0 0.5em 0 0 ! important }
  24. .first {
  25. /* Override more specific margin styles with "! important". */
  26. margin-top: 0 ! important }
  27. .last, .with-subtitle {
  28. margin-bottom: 0 ! important }
  29. .hidden {
  30. display: none }
  31. .subscript {
  32. vertical-align: sub;
  33. font-size: smaller }
  34. .superscript {
  35. vertical-align: super;
  36. font-size: smaller }
  37. a.toc-backref {
  38. text-decoration: none ;
  39. color: black }
  40. blockquote.epigraph {
  41. margin: 2em 5em ; }
  42. dl.docutils dd {
  43. margin-bottom: 0.5em }
  44. object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  45. overflow: hidden;
  46. }
  47. /* Uncomment (and remove this text!) to get bold-faced definition list terms
  48. dl.docutils dt {
  49. font-weight: bold }
  50. */
  51. div.abstract {
  52. margin: 2em 5em }
  53. div.abstract p.topic-title {
  54. font-weight: bold ;
  55. text-align: center }
  56. div.admonition, div.attention, div.caution, div.danger, div.error,
  57. div.hint, div.important, div.note, div.tip, div.warning {
  58. margin: 2em ;
  59. border: medium outset ;
  60. padding: 1em }
  61. div.admonition p.admonition-title, div.hint p.admonition-title,
  62. div.important p.admonition-title, div.note p.admonition-title,
  63. div.tip p.admonition-title {
  64. font-weight: bold ;
  65. font-family: sans-serif }
  66. div.attention p.admonition-title, div.caution p.admonition-title,
  67. div.danger p.admonition-title, div.error p.admonition-title,
  68. div.warning p.admonition-title, .code .error {
  69. color: red ;
  70. font-weight: bold ;
  71. font-family: sans-serif }
  72. /* Uncomment (and remove this text!) to get reduced vertical space in
  73. compound paragraphs.
  74. div.compound .compound-first, div.compound .compound-middle {
  75. margin-bottom: 0.5em }
  76. div.compound .compound-last, div.compound .compound-middle {
  77. margin-top: 0.5em }
  78. */
  79. div.dedication {
  80. margin: 2em 5em ;
  81. text-align: center ;
  82. font-style: italic }
  83. div.dedication p.topic-title {
  84. font-weight: bold ;
  85. font-style: normal }
  86. div.figure {
  87. margin-left: 2em ;
  88. margin-right: 2em }
  89. div.footer, div.header {
  90. clear: both;
  91. font-size: smaller }
  92. div.line-block {
  93. display: block ;
  94. margin-top: 1em ;
  95. margin-bottom: 1em }
  96. div.line-block div.line-block {
  97. margin-top: 0 ;
  98. margin-bottom: 0 ;
  99. margin-left: 1.5em }
  100. div.sidebar {
  101. margin: 0 0 0.5em 1em ;
  102. border: medium outset ;
  103. padding: 1em ;
  104. background-color: #ffffee ;
  105. width: 40% ;
  106. float: right ;
  107. clear: right }
  108. div.sidebar p.rubric {
  109. font-family: sans-serif ;
  110. font-size: medium }
  111. div.system-messages {
  112. margin: 5em }
  113. div.system-messages h1 {
  114. color: red }
  115. div.system-message {
  116. border: medium outset ;
  117. padding: 1em }
  118. div.system-message p.system-message-title {
  119. color: red ;
  120. font-weight: bold }
  121. div.topic {
  122. margin: 2em }
  123. h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
  124. h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  125. margin-top: 0.4em }
  126. h1.title {
  127. text-align: center }
  128. h2.subtitle {
  129. text-align: center }
  130. hr.docutils {
  131. width: 75% }
  132. img.align-left, .figure.align-left, object.align-left, table.align-left {
  133. clear: left ;
  134. float: left ;
  135. margin-right: 1em }
  136. img.align-right, .figure.align-right, object.align-right, table.align-right {
  137. clear: right ;
  138. float: right ;
  139. margin-left: 1em }
  140. img.align-center, .figure.align-center, object.align-center {
  141. display: block;
  142. margin-left: auto;
  143. margin-right: auto;
  144. }
  145. table.align-center {
  146. margin-left: auto;
  147. margin-right: auto;
  148. }
  149. .align-left {
  150. text-align: left }
  151. .align-center {
  152. clear: both ;
  153. text-align: center }
  154. .align-right {
  155. text-align: right }
  156. /* reset inner alignment in figures */
  157. div.align-right {
  158. text-align: inherit }
  159. /* div.align-center * { */
  160. /* text-align: left } */
  161. .align-top {
  162. vertical-align: top }
  163. .align-middle {
  164. vertical-align: middle }
  165. .align-bottom {
  166. vertical-align: bottom }
  167. ol.simple, ul.simple {
  168. margin-bottom: 1em }
  169. ol.arabic {
  170. list-style: decimal }
  171. ol.loweralpha {
  172. list-style: lower-alpha }
  173. ol.upperalpha {
  174. list-style: upper-alpha }
  175. ol.lowerroman {
  176. list-style: lower-roman }
  177. ol.upperroman {
  178. list-style: upper-roman }
  179. p.attribution {
  180. text-align: right ;
  181. margin-left: 50% }
  182. p.caption {
  183. font-style: italic }
  184. p.credits {
  185. font-style: italic ;
  186. font-size: smaller }
  187. p.label {
  188. white-space: nowrap }
  189. p.rubric {
  190. font-weight: bold ;
  191. font-size: larger ;
  192. color: maroon ;
  193. text-align: center }
  194. p.sidebar-title {
  195. font-family: sans-serif ;
  196. font-weight: bold ;
  197. font-size: larger }
  198. p.sidebar-subtitle {
  199. font-family: sans-serif ;
  200. font-weight: bold }
  201. p.topic-title {
  202. font-weight: bold }
  203. pre.address {
  204. margin-bottom: 0 ;
  205. margin-top: 0 ;
  206. font: inherit }
  207. pre.literal-block, pre.doctest-block, pre.math, pre.code {
  208. margin-left: 2em ;
  209. margin-right: 2em }
  210. pre.code .ln { color: grey; } /* line numbers */
  211. pre.code, code { background-color: #eeeeee }
  212. pre.code .comment, code .comment { color: #5C6576 }
  213. pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
  214. pre.code .literal.string, code .literal.string { color: #0C5404 }
  215. pre.code .name.builtin, code .name.builtin { color: #352B84 }
  216. pre.code .deleted, code .deleted { background-color: #DEB0A1}
  217. pre.code .inserted, code .inserted { background-color: #A3D289}
  218. span.classifier {
  219. font-family: sans-serif ;
  220. font-style: oblique }
  221. span.classifier-delimiter {
  222. font-family: sans-serif ;
  223. font-weight: bold }
  224. span.interpreted {
  225. font-family: sans-serif }
  226. span.option {
  227. white-space: nowrap }
  228. span.pre {
  229. white-space: pre }
  230. span.problematic {
  231. color: red }
  232. span.section-subtitle {
  233. /* font-size relative to parent (h1..h6 element) */
  234. font-size: 80% }
  235. table.citation {
  236. border-left: solid 1px gray;
  237. margin-left: 1px }
  238. table.docinfo {
  239. margin: 2em 4em }
  240. table.docutils {
  241. margin-top: 0.5em ;
  242. margin-bottom: 0.5em }
  243. table.footnote {
  244. border-left: solid 1px black;
  245. margin-left: 1px }
  246. table.docutils td, table.docutils th,
  247. table.docinfo td, table.docinfo th {
  248. padding-left: 0.5em ;
  249. padding-right: 0.5em ;
  250. vertical-align: top }
  251. table.docutils th.field-name, table.docinfo th.docinfo-name {
  252. font-weight: bold ;
  253. text-align: left ;
  254. white-space: nowrap ;
  255. padding-left: 0 }
  256. /* "booktabs" style (no vertical lines) */
  257. table.docutils.booktabs {
  258. border: 0px;
  259. border-top: 2px solid;
  260. border-bottom: 2px solid;
  261. border-collapse: collapse;
  262. }
  263. table.docutils.booktabs * {
  264. border: 0px;
  265. }
  266. table.docutils.booktabs th {
  267. border-bottom: thin solid;
  268. text-align: left;
  269. }
  270. h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
  271. h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  272. font-size: 100% }
  273. ul.auto-toc {
  274. list-style-type: none }
  275. </style>
  276. </head>
  277. <body>
  278. <div class="document" id="mail-tracking-for-mailgun">
  279. <h1 class="title">Mail tracking for Mailgun</h1>
  280. <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  281. !! This file is generated by oca-gen-addon-readme !!
  282. !! changes will be overwritten. !!
  283. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
  284. <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/social/tree/12.0/mail_tracking_mailgun"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/social-12-0/social-12-0-mail_tracking_mailgun"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/205/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
  285. <p>This module integrates mail_tracking events with Mailgun webhooks.</p>
  286. <p>Mailgun (<a class="reference external" href="https://www.mailgun.com/">https://www.mailgun.com/</a>) is a service that provides an e-mail
  287. sending infrastructure through an SMTP server or via API. You can also
  288. query that API for seeing statistics of your sent e-mails, or provide
  289. hooks that processes the status changes in real time, which is the
  290. function used here.</p>
  291. <p><strong>Table of contents</strong></p>
  292. <div class="contents local topic" id="contents">
  293. <ul class="simple">
  294. <li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
  295. <li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
  296. <li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li>
  297. <li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
  298. <li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
  299. <li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
  300. <li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
  301. <li><a class="reference internal" href="#other-credits" id="id8">Other credits</a><ul>
  302. <li><a class="reference internal" href="#images" id="id9">Images</a></li>
  303. </ul>
  304. </li>
  305. <li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li>
  306. </ul>
  307. </li>
  308. </ul>
  309. </div>
  310. <div class="section" id="configuration">
  311. <h1><a class="toc-backref" href="#id1">Configuration</a></h1>
  312. <p>You must configure Mailgun webhooks in order to receive mail events:</p>
  313. <ol class="arabic simple">
  314. <li>Got a Mailgun account and validate your sending domain.</li>
  315. <li>Go to Webhook tab and configure the below URL for each event:</li>
  316. </ol>
  317. <pre class="code html literal-block">
  318. https://<span class="p">&lt;</span><span class="nt">your_domain</span><span class="p">&gt;</span>/mail/tracking/all/<span class="p">&lt;</span><span class="nt">your_database</span><span class="p">&gt;</span>
  319. </pre>
  320. <p>Replace ‘&lt;your_domain&gt;’ with your Odoo install domain name
  321. and ‘&lt;your_database&gt;’ with your database name.</p>
  322. <p>In order to validate Mailgun webhooks you have to configure the following system
  323. parameters:</p>
  324. <ul class="simple">
  325. <li><cite>mailgun.apikey</cite>: You can find Mailgun api_key in your validated sending
  326. domain.</li>
  327. <li><cite>mailgun.api_url</cite>: It should be fine as it is, but it could change in the
  328. future.</li>
  329. <li><cite>mailgun.domain</cite>: In case your sending domain is different from the one
  330. configured in <cite>mail.catchall.domain</cite>.</li>
  331. <li><cite>mailgun.validation_key</cite>: If you want to be able to check mail address
  332. validity you must config this parameter with your account Public Validation
  333. Key.</li>
  334. </ul>
  335. <p>You can also config partner email autocheck with this system parameter:</p>
  336. <ul class="simple">
  337. <li><cite>mailgun.auto_check_partner_email</cite>: Set it to True.</li>
  338. </ul>
  339. </div>
  340. <div class="section" id="usage">
  341. <h1><a class="toc-backref" href="#id2">Usage</a></h1>
  342. <p>In your mail tracking status screens (explained on module <em>mail_tracking</em>), you
  343. will see a more accurate information, like the ‘Received’ or ‘Bounced’ status,
  344. which are not usually detected by normal SMTP servers.</p>
  345. <p>It’s also possible to make some checks to the partner’s email addresses against
  346. the Mailgun API:</p>
  347. <ul class="simple">
  348. <li>Check if the partner’s email is in Mailgun’s bounced list.</li>
  349. <li>Check the validity of the partner’s mailbox.</li>
  350. <li>Force the partner’s email into Mailgun’s bounced list or delete from it.</li>
  351. </ul>
  352. <p>It’s also possible to manually check a message mailgun tracking when the webhook
  353. couldn’t be captured. For that, go to that message tracking form, press the
  354. button <em>Check Mailgun</em>. It’s important to note that tracking events have quite a
  355. short lifespan, so after 24h they won’t be recoverable.</p>
  356. </div>
  357. <div class="section" id="known-issues-roadmap">
  358. <h1><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h1>
  359. <ul class="simple">
  360. <li>There’s no support for more than one Mailgun mail server.</li>
  361. </ul>
  362. </div>
  363. <div class="section" id="bug-tracker">
  364. <h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
  365. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>.
  366. In case of trouble, please check there if your issue has already been reported.
  367. If you spotted it first, help us smashing it by providing a detailed and welcomed
  368. <a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mail_tracking_mailgun%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
  369. <p>Do not contact contributors directly about support or help with technical issues.</p>
  370. </div>
  371. <div class="section" id="credits">
  372. <h1><a class="toc-backref" href="#id5">Credits</a></h1>
  373. <div class="section" id="authors">
  374. <h2><a class="toc-backref" href="#id6">Authors</a></h2>
  375. <ul class="simple">
  376. <li>Tecnativa</li>
  377. </ul>
  378. </div>
  379. <div class="section" id="contributors">
  380. <h2><a class="toc-backref" href="#id7">Contributors</a></h2>
  381. <ul class="simple">
  382. <li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
  383. <li>Antonio Espinosa</li>
  384. <li>Carlos Dauden</li>
  385. <li>Pedro M. Baeza</li>
  386. <li>David Vidal</li>
  387. <li>Rafael Blasco</li>
  388. <li>Ernesto Tejeda</li>
  389. </ul>
  390. </li>
  391. </ul>
  392. </div>
  393. <div class="section" id="other-credits">
  394. <h2><a class="toc-backref" href="#id8">Other credits</a></h2>
  395. <div class="section" id="images">
  396. <h3><a class="toc-backref" href="#id9">Images</a></h3>
  397. <ul class="simple">
  398. <li>Mailgun logo: <a class="reference external" href="http://seeklogo.com/mailgun-logo-273630.html">SVG Icon</a>.</li>
  399. </ul>
  400. </div>
  401. </div>
  402. <div class="section" id="maintainers">
  403. <h2><a class="toc-backref" href="#id10">Maintainers</a></h2>
  404. <p>This module is maintained by the OCA.</p>
  405. <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
  406. <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
  407. mission is to support the collaborative development of Odoo features and
  408. promote its widespread use.</p>
  409. <p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/12.0/mail_tracking_mailgun">OCA/social</a> project on GitHub.</p>
  410. <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
  411. </div>
  412. </div>
  413. </div>
  414. </body>
  415. </html>