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

deploy: e332622db9

Browse source
This commit is contained in:
github-actions[bot] 2023-04-25 16:48:21 +00:00
parent 242dadc8e8
commit af1b2f6b4c
24 changed files with 339 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/404.html
View file

@ -11,7 +11,7 @@
<link rel="icon" href="/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -101,6 +101,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

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

@ -13,7 +13,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -108,6 +108,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -108,6 +108,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
docs/messengers/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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

40
docs/sitemap.xml
View file

@ -2,102 +2,102 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-04-11</lastmod>
<lastmod>2023-04-25</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
docs/sitemap.xml.gz
View file

Binary file not shown.

257
docs/swagger/collections.yaml
View file

@ -123,6 +123,46 @@ paths:
schema:
$ref: "#/components/schemas/Settings"
put:
tags:
- Settings
description: update settings
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Settings"
responses:
"200":
description: response
content:
application/json:
schema:
type: object
properties:
data:
type: boolean
/settings/smtp/test:
post:
tags:
- Settings
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SMTPTest"
responses:
"200":
description: response
content:
application/json:
schema:
type: object
properties:
data:
type: boolean
/admin/reload:
post:
tags:
@ -531,7 +571,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/SubscriberData"
$ref: "#/components/schemas/Bounce"
delete:
description: handles bounce deletion, either a single one (ID in the URI), or a list.
@ -838,6 +878,25 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/Campaign"
put:
tags:
- Campaigns
parameters:
- in: path
name: campaign_id
required: true
description: the id value of campaign you want to update
schema:
type: number
responses:
"200":
description: response
content:
application/json:
schema:
$ref: "#/components/schemas/CampaignUpdate"
delete:
description: deletes specified campaign
tags:
@ -896,6 +955,33 @@ paths:
description: The id value of the campaign you want to get the preview of
schema:
type: number
responses:
"200":
description: response
content:
text/html:
schema:
type: string
example: <h3>Hi John!</h3>This is a e-mail campaign. Your second name is Doe and you are from Bengaluru
"/campaigns/{campaign_id}/text":
get:
description: renders the HTML preview of a campaign body
tags:
- Campaigns
parameters:
- in: path
name: id
required: True
description: The id value of the campaign you want to get the preview of
schema:
type: number
- in: path
name: template_id
required: True
description: The id of the template you want to get the preview of
schema:
type: number
responses:
"200":
description: response
@ -934,6 +1020,62 @@ paths:
schema:
$ref: "#/components/schemas/Campaign"
"/campaigns/{campaign_id}/content":
post:
description: handles campaign content (body) format conversions.
tags:
- Campaigns
parameters:
- in: path
name: campaign_id
required: true
schema:
type: number
responses:
"200":
description: response
content:
application/json:
schema:
type: object
properties:
data:
type: string
"/campaigns/{campaign_id}/test":
post:
description: handles sending of campaign message to arbitrary subscribers for testing
tags:
- Campaigns
parameters:
- in: path
name: campaign_id
required: true
schema:
type: number
- in: path
name: template_id
required: true
schema:
type: number
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CampaignRegistrationInfo"
responses:
"200":
description: response
content:
application/json:
schema:
type: object
properties:
data:
type: boolean
"/media":
get:
description: handles retrieval of uploaded media.
@ -1173,6 +1315,13 @@ paths:
responses:
"200":
description: response
content:
application/json:
schema:
type: object
properties:
data:
type: boolean
"/maintenance/subscriptions/unconfirmed":
delete:
@ -1209,6 +1358,28 @@ paths:
name:
type: string
"/public/subscription":
post:
description: handles subscription requests coming from public API calls.
tags:
- Public
responses:
"200":
description: response
content:
application/json:
schema:
type: object
properties:
name:
type: string
email:
type: string
list_uuids:
type: array
items:
type: string
components:
schemas:
LanguagePack:
@ -2420,6 +2591,46 @@ components:
tls_skip_verify:
type: boolean
SMTPTest:
type: object
properties:
uuid:
type: string
enabled:
type: boolean
host:
type: string
hello_hostname:
type: string
port:
type: number
auth_protocol:
type: string
username:
type: string
email_headers:
type: array
items:
type: object
max_conns:
type: number
max_msg_retries:
type: number
idle_timeout:
type: string
wait_timeout:
type: string
tls_type:
type: string
tls_skip_verify:
type: boolean
strEmailHeaders:
type: string
password:
type: string
email:
type: string
MailBoxBounces:
type: object
properties:
@ -2963,6 +3174,50 @@ components:
items:
type: string
CampaignUpdate:
type: object
properties:
name:
type: string
subject:
type: string
lists:
type: array
items:
type: number
from_email:
type: string
messenger:
type: string
type:
type: string
tags:
type: array
items:
type: string
send_later:
type: boolean
send_at:
type: object
headers:
type: array
items:
type: object
template_id:
type: number
content_type:
type: string
body:
type: string
altbody:
type: string
archive:
type: boolean
archive_template_id:
type: number
archive_meta:
type: object
MediaFileObject:
type: object
properties:

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">

4
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.4.2, mkdocs-material-9.1.6">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
@ -110,6 +110,8 @@
</div>
</div>
<label class="md-header__button md-icon" for="__search">