knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-11-19 00:29:06 +08:00
Code Issues Projects Releases Packages Wiki Activity

deploy: b1fa28980e

Browse source
This commit is contained in:
github-actions[bot] 2023-08-07 11:00:04 +00:00
parent a5fb9f597d
commit 83375e9b7b
24 changed files with 61 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/404.html
View file

@ -11,7 +11,7 @@
<link rel="icon" href="/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/apis/apis/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../subscribers/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/apis/campaigns/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../media/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/apis/import/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../campaigns/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/apis/lists/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../import/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/apis/media/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../templates/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/apis/subscribers/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../lists/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/apis/templates/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../transactional/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

41
docs/apis/transactional/index.html
View file

@ -13,7 +13,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
@ -548,6 +548,13 @@
Response
</a>
</li>
<li class="md-nav__item">
<a href="#file-attachments" class="md-nav__link">
File Attachments
</a>
</li>
</ul>
@ -616,6 +623,13 @@
Response
</a>
</li>
<li class="md-nav__item">
<a href="#file-attachments" class="md-nav__link">
File Attachments
</a>
</li>
</ul>
@ -656,7 +670,7 @@
</tbody>
</table>
<h2 id="post-apitx">POST /api/tx<a class="headerlink" href="#post-apitx" title="Permanent link">&para;</a></h2>
<p>Send a transactional message to a subscriber using a predefined transactional template.</p>
<p>Send a transactional message to one or multiple subscribers using a predefined transactional template.</p>
<h5 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">&para;</a></h5>
<table>
<thead>
@ -681,6 +695,18 @@
<td style="text-align: left;">ID of the subscriber. Either this or <code>subscriber_email</code> should be passed.</td>
</tr>
<tr>
<td style="text-align: left;"><code>subscriber_emails</code></td>
<td style="text-align: left;">[]String</td>
<td style="text-align: left;">Optional</td>
<td style="text-align: left;">E-mails of the subscribers. This is an alternative to <code>subscriber_email</code> for multiple recipients. <code>["email1@example.com", "emailX@example.com"]</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>subscriber_ids</code></td>
<td style="text-align: left;">[]Number</td>
<td style="text-align: left;">Optional</td>
<td style="text-align: left;">IDs of the subscribers. This is an alternative to <code>subscriber_id</code> for multiple recipients. <code>[1,2,3]</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>template_id</code></td>
<td style="text-align: left;">Number</td>
<td style="text-align: left;">Required</td>
@ -735,6 +761,17 @@
<span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="p">}</span>
</code></pre></div>
<h3 id="file-attachments">File Attachments<a class="headerlink" href="#file-attachments" title="Permanent link">&para;</a></h3>
<p>To include file attachments in a transactional message, use Content-Type <code>multipart/form-data</code>.
Use the parameters described above as a JSON object via the <code>data</code> form key and include an arbitrary number of attachments via the <code>file</code> key.</p>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">&quot;username:password&quot;</span><span class="w"> </span><span class="s2">&quot;http://localhost:9000/api/tx&quot;</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="se">\</span>
-F<span class="w"> </span><span class="s1">&#39;data=\&quot;{</span>
<span class="s1"> \&quot;subscriber_email\&quot;: \&quot;user@test.com\&quot;,</span>
<span class="s1"> \&quot;template_id\&quot;: 4</span>
<span class="s1">}&quot;&#39;</span><span class="w"> </span><span class="se">\</span>
-F<span class="w"> </span><span class="s1">&#39;file=@&quot;/path/to/attachment.pdf&quot;&#39;</span><span class="w"> </span><span class="se">\</span>
-F<span class="w"> </span><span class="s1">&#39;file=@&quot;/path/to/attachment2.pdf&quot;&#39;</span>
</code></pre></div>

2
docs/archives/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../i18n/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/bounces/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../messengers/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/concepts/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../querying-and-segmentation/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/configuration/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../developer-setup/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/developer-setup/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../concepts/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/external-integration/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../apis/apis/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/i18n/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../external-integration/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/index.html
View file

@ -13,7 +13,7 @@
<link rel="next" href="installation/">
<link rel="icon" href="images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/installation/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../upgrade/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/messengers/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../archives/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/querying-and-segmentation/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../templating/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/search/search_index.json
View file

File diff suppressed because one or more lines are too long

BIN
docs/sitemap.xml.gz
View file

Binary file not shown.

2
docs/templating/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../bounces/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">

2
docs/upgrade/index.html
View file

@ -15,7 +15,7 @@
<link rel="next" href="../configuration/">
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.0, mkdocs-material-9.1.21">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">