mirror of
				https://github.com/knadh/listmonk.git
				synced 2025-10-31 19:15:56 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			1091 lines
		
	
	
		
			No EOL
		
	
	
		
			21 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			1091 lines
		
	
	
		
			No EOL
		
	
	
		
			21 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| 
 | |
| <!doctype html>
 | |
| <html lang="en" class="no-js">
 | |
|   <head>
 | |
|     
 | |
|       <meta charset="utf-8">
 | |
|       <meta name="viewport" content="width=device-width,initial-scale=1">
 | |
|       
 | |
|       
 | |
|       
 | |
|       
 | |
|         <link rel="prev" href="../messengers/">
 | |
|       
 | |
|       
 | |
|         <link rel="next" href="../i18n/">
 | |
|       
 | |
|       
 | |
|       <link rel="icon" href="../images/favicon.png">
 | |
|       <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.14">
 | |
|     
 | |
|     
 | |
|       
 | |
|         <title>Archives - listmonk / Documentation</title>
 | |
|       
 | |
|     
 | |
|     
 | |
|       <link rel="stylesheet" href="../assets/stylesheets/main.10ba22f1.min.css">
 | |
|       
 | |
|         
 | |
|         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
 | |
|       
 | |
|       
 | |
| 
 | |
| 
 | |
|     
 | |
|     
 | |
|       
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|         
 | |
|         <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
 | |
|         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
 | |
|         <style>:root{--md-text-font:"Inter";--md-code-font:"Roboto Mono"}</style>
 | |
|       
 | |
|     
 | |
|     
 | |
|       <link rel="stylesheet" href="../static/style.css">
 | |
|     
 | |
|     <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 | |
|     
 | |
|       
 | |
| 
 | |
|     
 | |
|     
 | |
|     
 | |
|   </head>
 | |
|   
 | |
|   
 | |
|     
 | |
|     
 | |
|     
 | |
|     
 | |
|     
 | |
|     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="red">
 | |
|   
 | |
|     
 | |
|     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
 | |
|     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
 | |
|     <label class="md-overlay" for="__drawer"></label>
 | |
|     <div data-md-component="skip">
 | |
|       
 | |
|         
 | |
|         <a href="#archives" class="md-skip">
 | |
|           Skip to content
 | |
|         </a>
 | |
|       
 | |
|     </div>
 | |
|     <div data-md-component="announce">
 | |
|       
 | |
|     </div>
 | |
|     
 | |
|     
 | |
|       
 | |
| 
 | |
|   
 | |
| 
 | |
| <header class="md-header md-header--shadow" data-md-component="header">
 | |
|   <nav class="md-header__inner md-grid" aria-label="Header">
 | |
|     <a href=".." title="listmonk / Documentation" class="md-header__button md-logo" aria-label="listmonk / Documentation" data-md-component="logo">
 | |
|       
 | |
|   <img src="../images/favicon.png" alt="logo">
 | |
| 
 | |
|     </a>
 | |
|     <label class="md-header__button md-icon" for="__drawer">
 | |
|       
 | |
|       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 | |
|     </label>
 | |
|     <div class="md-header__title" data-md-component="header-title">
 | |
|       <div class="md-header__ellipsis">
 | |
|         <div class="md-header__topic">
 | |
|           <span class="md-ellipsis">
 | |
|             listmonk / Documentation
 | |
|           </span>
 | |
|         </div>
 | |
|         <div class="md-header__topic" data-md-component="header-topic">
 | |
|           <span class="md-ellipsis">
 | |
|             
 | |
|               Archives
 | |
|             
 | |
|           </span>
 | |
|         </div>
 | |
|       </div>
 | |
|     </div>
 | |
|     
 | |
|       
 | |
|     
 | |
|     
 | |
|     
 | |
|     
 | |
|       <label class="md-header__button md-icon" for="__search">
 | |
|         
 | |
|         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
 | |
|       </label>
 | |
|       <div class="md-search" data-md-component="search" role="dialog">
 | |
|   <label class="md-search__overlay" for="__search"></label>
 | |
|   <div class="md-search__inner" role="search">
 | |
|     <form class="md-search__form" name="search">
 | |
|       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
 | |
|       <label class="md-search__icon md-icon" for="__search">
 | |
|         
 | |
|         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
 | |
|         
 | |
|         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
 | |
|       </label>
 | |
|       <nav class="md-search__options" aria-label="Search">
 | |
|         
 | |
|         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 | |
|           
 | |
|           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
 | |
|         </button>
 | |
|       </nav>
 | |
|       
 | |
|     </form>
 | |
|     <div class="md-search__output">
 | |
|       <div class="md-search__scrollwrap" data-md-scrollfix>
 | |
|         <div class="md-search-result" data-md-component="search-result">
 | |
|           <div class="md-search-result__meta">
 | |
|             Initializing search
 | |
|           </div>
 | |
|           <ol class="md-search-result__list" role="presentation"></ol>
 | |
|         </div>
 | |
|       </div>
 | |
|     </div>
 | |
|   </div>
 | |
| </div>
 | |
|     
 | |
|     
 | |
|   </nav>
 | |
|   
 | |
| </header>
 | |
|     
 | |
|     <div class="md-container" data-md-component="container">
 | |
|       
 | |
|       
 | |
|         
 | |
|           
 | |
|         
 | |
|       
 | |
|       <main class="md-main" data-md-component="main">
 | |
|         <div class="md-main__inner md-grid">
 | |
|           
 | |
|             
 | |
|               
 | |
|               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 | |
|                 <div class="md-sidebar__scrollwrap">
 | |
|                   <div class="md-sidebar__inner">
 | |
|                     
 | |
| 
 | |
| 
 | |
| 
 | |
| <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 | |
|   <label class="md-nav__title" for="__drawer">
 | |
|     <a href=".." title="listmonk / Documentation" class="md-nav__button md-logo" aria-label="listmonk / Documentation" data-md-component="logo">
 | |
|       
 | |
|   <img src="../images/favicon.png" alt="logo">
 | |
| 
 | |
|     </a>
 | |
|     listmonk / Documentation
 | |
|   </label>
 | |
|   
 | |
|   <ul class="md-nav__list" data-md-scrollfix>
 | |
|     
 | |
|       
 | |
|       
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href=".." class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Introduction
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|     
 | |
|       
 | |
|       
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|     <li class="md-nav__item md-nav__item--section md-nav__item--nested">
 | |
|       
 | |
|         
 | |
|         
 | |
|         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 | |
|         
 | |
|           
 | |
|           <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
 | |
|             
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Getting Started
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|           </label>
 | |
|         
 | |
|         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 | |
|           <label class="md-nav__title" for="__nav_2">
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|             Getting Started
 | |
|           </label>
 | |
|           <ul class="md-nav__list" data-md-scrollfix>
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../installation/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Installation
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../configuration/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Configuration
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../upgrade/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Upgrade
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|           </ul>
 | |
|         </nav>
 | |
|       
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|     
 | |
|       
 | |
|       
 | |
|   
 | |
|   
 | |
|     
 | |
|   
 | |
|   
 | |
|   
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|     <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
 | |
|       
 | |
|         
 | |
|         
 | |
|         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
 | |
|         
 | |
|           
 | |
|           <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
 | |
|             
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Using Listmonk
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|           </label>
 | |
|         
 | |
|         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
 | |
|           <label class="md-nav__title" for="__nav_3">
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|             Using Listmonk
 | |
|           </label>
 | |
|           <ul class="md-nav__list" data-md-scrollfix>
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../concepts/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Concepts
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../templating/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Templating
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../querying-and-segmentation/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Querying and segmenting subscribers
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../bounces/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Bounce processing
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../messengers/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Messengers
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|     
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item md-nav__item--active">
 | |
|       
 | |
|       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
 | |
|       
 | |
|       
 | |
|         
 | |
|       
 | |
|       
 | |
|       <a href="./" class="md-nav__link md-nav__link--active">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Archives
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|       
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../i18n/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Internationalization
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../external-integration/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Integrating with external systems
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|           </ul>
 | |
|         </nav>
 | |
|       
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|     
 | |
|       
 | |
|       
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|     <li class="md-nav__item md-nav__item--section md-nav__item--nested">
 | |
|       
 | |
|         
 | |
|         
 | |
|         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 | |
|         
 | |
|           
 | |
|           <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
 | |
|             
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     API
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|           </label>
 | |
|         
 | |
|         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 | |
|           <label class="md-nav__title" for="__nav_4">
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|             API
 | |
|           </label>
 | |
|           <ul class="md-nav__list" data-md-scrollfix>
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../apis/apis/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Introduction
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../apis/sdks/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     SDKs and libs
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../apis/subscribers/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Subscribers
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../apis/lists/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Lists
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../apis/import/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Import
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../apis/campaigns/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Campaigns
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../apis/media/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Media
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../apis/templates/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Templates
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../apis/transactional/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Transactional
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|           </ul>
 | |
|         </nav>
 | |
|       
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|     
 | |
|       
 | |
|       
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|     <li class="md-nav__item md-nav__item--section md-nav__item--nested">
 | |
|       
 | |
|         
 | |
|         
 | |
|         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
 | |
|         
 | |
|           
 | |
|           <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
 | |
|             
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Maintenance
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|           </label>
 | |
|         
 | |
|         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
 | |
|           <label class="md-nav__title" for="__nav_5">
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|             Maintenance
 | |
|           </label>
 | |
|           <ul class="md-nav__list" data-md-scrollfix>
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../maintenance/performance/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Performance
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|           </ul>
 | |
|         </nav>
 | |
|       
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|     
 | |
|       
 | |
|       
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|       
 | |
|         
 | |
|         
 | |
|       
 | |
|     
 | |
|     
 | |
|     <li class="md-nav__item md-nav__item--section md-nav__item--nested">
 | |
|       
 | |
|         
 | |
|         
 | |
|         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
 | |
|         
 | |
|           
 | |
|           <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
 | |
|             
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Contributions
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|           </label>
 | |
|         
 | |
|         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
 | |
|           <label class="md-nav__title" for="__nav_6">
 | |
|             <span class="md-nav__icon md-icon"></span>
 | |
|             Contributions
 | |
|           </label>
 | |
|           <ul class="md-nav__list" data-md-scrollfix>
 | |
|             
 | |
|               
 | |
|                 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
|     <li class="md-nav__item">
 | |
|       <a href="../developer-setup/" class="md-nav__link">
 | |
|         
 | |
|   
 | |
|   <span class="md-ellipsis">
 | |
|     Developer setup
 | |
|   </span>
 | |
|   
 | |
| 
 | |
|       </a>
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|               
 | |
|             
 | |
|           </ul>
 | |
|         </nav>
 | |
|       
 | |
|     </li>
 | |
|   
 | |
| 
 | |
|     
 | |
|   </ul>
 | |
| </nav>
 | |
|                   </div>
 | |
|                 </div>
 | |
|               </div>
 | |
|             
 | |
|             
 | |
|               
 | |
|               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
 | |
|                 <div class="md-sidebar__scrollwrap">
 | |
|                   <div class="md-sidebar__inner">
 | |
|                     
 | |
| 
 | |
| <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 | |
|   
 | |
|   
 | |
|   
 | |
|     
 | |
|   
 | |
|   
 | |
| </nav>
 | |
|                   </div>
 | |
|                 </div>
 | |
|               </div>
 | |
|             
 | |
|           
 | |
|           
 | |
|             <div class="md-content" data-md-component="content">
 | |
|               <article class="md-content__inner md-typeset">
 | |
|                 
 | |
|                   
 | |
| 
 | |
| 
 | |
| <h1 id="archives">Archives<a class="headerlink" href="#archives" title="Permanent link">¶</a></h1>
 | |
| <p>A global public archive is maintained on the public web interface. It can be
 | |
| enabled under Settings -> Settings -> General -> Enable public mailing list
 | |
| archive.</p>
 | |
| <p>To make a campaign available in the public archive (provided it has been
 | |
| enabled in the settings as described above), enable the option
 | |
| 'Publish to public archive' under Campaigns -> Create new -> Archive.</p>
 | |
| <p>When using template variables that depend on subscriber data (such as any
 | |
| template variable referencing <code>.Subscriber</code>), such data must be supplied
 | |
| as 'Campaign metadata', which is a JSON object that will be used in place
 | |
| of <code>.Subscriber</code> when rendering the archive template and content.</p>
 | |
| <p>When individual subscriber tracking is enabled, TrackLink requires that a UUID
 | |
| of an existing user is provided as part of the campaign metadata. Any clicks on
 | |
| a TrackLink from the archived campaign will be counted towards that subscriber.</p>
 | |
| <p>As an example:</p>
 | |
| <div class="highlight"><pre><span></span><code><span class="p">{</span>
 | |
| <span class="w">  </span><span class="nt">"UUID"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5a837423-a186-5623-9a87-82691cbe3631"</span><span class="p">,</span>
 | |
| <span class="w">  </span><span class="nt">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example@example.com"</span><span class="p">,</span>
 | |
| <span class="w">  </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Reader"</span><span class="p">,</span>
 | |
| <span class="w">  </span><span class="nt">"attribs"</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
 | |
| <span class="p">}</span>
 | |
| </code></pre></div>
 | |
| <p><img alt="Archive campaign" src="../images/archived-campaign-metadata.png" /></p>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
|                 
 | |
|               </article>
 | |
|             </div>
 | |
|           
 | |
|           
 | |
| <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
 | |
|         </div>
 | |
|         
 | |
|       </main>
 | |
|       
 | |
|         <footer class="md-footer">
 | |
|   
 | |
|   <div class="md-footer-meta md-typeset">
 | |
|     <div class="md-footer-meta__inner md-grid">
 | |
|       <div class="md-copyright">
 | |
|   
 | |
|     <div class="md-copyright__highlight">
 | |
|       CC BY-SA 4.0
 | |
|     </div>
 | |
|   
 | |
|   
 | |
|     Made with
 | |
|     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
 | |
|       Material for MkDocs
 | |
|     </a>
 | |
|   
 | |
| </div>
 | |
|       
 | |
|     </div>
 | |
|   </div>
 | |
| </footer>
 | |
|       
 | |
|     </div>
 | |
|     <div class="md-dialog" data-md-component="dialog">
 | |
|       <div class="md-dialog__inner md-typeset"></div>
 | |
|     </div>
 | |
|     
 | |
|     
 | |
|     <script id="__config" type="application/json">{"base": "..", "features": ["navigation.indexes", "navigation.sections", "content.code.copy"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 | |
|     
 | |
|     
 | |
|       <script src="../assets/javascripts/bundle.bd41221c.min.js"></script>
 | |
|       
 | |
|     
 | |
|   </body>
 | |
| </html> |