387 lines
No EOL
8.9 KiB
HTML
387 lines
No EOL
8.9 KiB
HTML
<!-- title: Email Alert -->
|
|
|
|
|
|
|
|
|
|
|
|
<div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.x.x</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/frappe/email/doctype/email_alert"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<p><b>Table Name:</b> <code>tabEmail Alert</code></p>
|
|
|
|
|
|
|
|
|
|
<h3>Fields</h3>
|
|
|
|
<table class="table table-bordered" style="table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 5%">Sr</th>
|
|
<th style="width: 25%">Fieldname</th>
|
|
<th style="width: 20%">Type</th>
|
|
<th style="width: 25%">Label</th>
|
|
<th style="width: 25%">Options</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr >
|
|
<td>1</td>
|
|
<td ><code>enabled</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Enabled
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>2</td>
|
|
<td ><code>filters</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Filters
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>3</td>
|
|
<td class="danger" title="Mandatory"><code>subject</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Subject
|
|
<p class="text-muted small">
|
|
To add dynamic subject, use jinja tags like
|
|
|
|
<div><pre><code>{{ doc.name }} Delivered</code></pre></div></p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>4</td>
|
|
<td class="danger" title="Mandatory"><code>document_type</code></td>
|
|
<td >
|
|
Link</td>
|
|
<td >
|
|
Document Type
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/core/doctype">DocType</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>5</td>
|
|
<td class="danger" title="Mandatory"><code>event</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Send Alert On
|
|
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
New
|
|
Save
|
|
Submit
|
|
Cancel
|
|
Days After
|
|
Days Before
|
|
Value Change</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>6</td>
|
|
<td ><code>date_changed</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Reference Date
|
|
<p class="text-muted small">
|
|
Send alert if date matches this field's value</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>7</td>
|
|
<td ><code>days_in_advance</code></td>
|
|
<td >
|
|
Int</td>
|
|
<td >
|
|
Days Before or After
|
|
<p class="text-muted small">
|
|
Send days before or after the reference date</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>8</td>
|
|
<td ><code>value_changed</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Value Changed
|
|
<p class="text-muted small">
|
|
Send alert if this field's value changes</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>9</td>
|
|
<td ><code>condition</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Condition
|
|
<p class="text-muted small">
|
|
Optional: The alert will be sent if this expression is true</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>10</td>
|
|
<td ><code>column_break_6</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>11</td>
|
|
<td ><code>html_7</code></td>
|
|
<td >
|
|
HTML</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>12</td>
|
|
<td ><code>column_break_5</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Recipients
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>13</td>
|
|
<td class="danger" title="Mandatory"><code>recipients</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td >
|
|
Recipients
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/email/email_alert_recipient">Email Alert Recipient</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>14</td>
|
|
<td ><code>message_sb</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Message
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>15</td>
|
|
<td class="danger" title="Mandatory"><code>message</code></td>
|
|
<td >
|
|
Text</td>
|
|
<td >
|
|
Message
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>16</td>
|
|
<td ><code>attach_print</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Attach Print
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>17</td>
|
|
<td ><code>message_examples</code></td>
|
|
<td >
|
|
HTML</td>
|
|
<td >
|
|
Message Examples
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>18</td>
|
|
<td ><code>view_properties</code></td>
|
|
<td >
|
|
Button</td>
|
|
<td >
|
|
View Properties (via Customize Form)
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
<h3>Controller</h3>
|
|
<h4>frappe.email.doctype.email_alert.email_alert</h4>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>EmailAlert</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p></p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate" href="#validate" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.email.doctype.email_alert.email_alert.evaluate_alert" href="#frappe.email.doctype.email_alert.email_alert.evaluate_alert" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.email.doctype.email_alert.email_alert.<b>evaluate_alert</b>
|
|
<i class="text-muted">(doc, alert, event)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.email.doctype.email_alert.email_alert.trigger_daily_alerts" href="#frappe.email.doctype.email_alert.email_alert.trigger_daily_alerts" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.email.doctype.email_alert.email_alert.<b>trigger_daily_alerts</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.email.doctype.email_alert.email_alert.trigger_email_alerts" href="#frappe.email.doctype.email_alert.email_alert.trigger_email_alerts" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.email.doctype.email_alert.email_alert.<b>trigger_email_alerts</b>
|
|
<i class="text-muted">(doc, method=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc -->
|
|
<!-- jinja -->
|
|
<!-- static --> |