Shiloh/brotherton-erpnext
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ab7021ce64
brotherton-erpnext/erpnext/docs/current/models/setup/email_digest.md

18 KiB
Raw Blame History

Version 6.x.x 
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/setup/doctype/email_digest"
	target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

<p><b>Table Name:</b> <code>tabEmail Digest</code></p>

Send regular summary reports via Email.

Fields

    <tr class="info">
        <td>1</td>
        <td ><code>settings</code></td>
        <td >
            Section Break</td>
        <td >
            Email Digest Settings
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>2</td>
        <td ><code>column_break0</code></td>
        <td class="info">
            Column Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>3</td>
        <td ><code>enabled</code></td>
        <td >
            Check</td>
        <td >
            Enabled
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>4</td>
        <td class="danger" title="Mandatory"><code>company</code></td>
        <td >
            Link</td>
        <td >
            For Company
            
        </td>
        <td>

Company

        </td>
    </tr>
    
    <tr >
        <td>5</td>
        <td class="danger" title="Mandatory"><code>frequency</code></td>
        <td >
            Select</td>
        <td >
            How frequently?
            
        </td>
        <td>
            <pre>Daily

Weekly Monthly 

    <tr >
        <td>6</td>
        <td ><code>next_send</code></td>
        <td >
            Data</td>
        <td >
            Next email will be sent on:
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>7</td>
        <td ><code>column_break1</code></td>
        <td class="info">
            Column Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>8</td>
        <td class="danger" title="Mandatory"><code>recipient_list</code></td>
        <td >
            Text</td>
        <td >
            Recipients
            <p class="text-muted small">
                Note: Email will not be sent to disabled users</p>
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>9</td>
        <td ><code>addremove_recipients</code></td>
        <td >
            Button</td>
        <td >
            Add/Remove Recipients
            
        </td>
        <td></td>
    </tr>
    
    <tr class="info">
        <td>10</td>
        <td ><code>accounts</code></td>
        <td >
            Section Break</td>
        <td >
            Accounts
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>11</td>
        <td ><code>accounts_module</code></td>
        <td class="info">
            Column Break</td>
        <td class="text-muted" title="Hidden">
            Income / Expense
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>12</td>
        <td ><code>income</code></td>
        <td >
            Check</td>
        <td >
            Income
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>13</td>
        <td ><code>expenses_booked</code></td>
        <td >
            Check</td>
        <td >
            Expense
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>14</td>
        <td ><code>bank_balance</code></td>
        <td >
            Check</td>
        <td >
            Bank Balance
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>15</td>
        <td ><code>income_year_to_date</code></td>
        <td >
            Check</td>
        <td >
            Annual Income
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>16</td>
        <td ><code>expense_year_to_date</code></td>
        <td >
            Check</td>
        <td >
            Annual Expense
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>17</td>
        <td ><code>column_break_16</code></td>
        <td class="info">
            Column Break</td>
        <td >
            Receivables / Payables
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>18</td>
        <td ><code>invoiced_amount</code></td>
        <td >
            Check</td>
        <td >
            Receivables
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>19</td>
        <td ><code>payables</code></td>
        <td >
            Check</td>
        <td >
            Payables
            
        </td>
        <td></td>
    </tr>
    
    <tr class="info">
        <td>20</td>
        <td ><code>other</code></td>
        <td >
            Section Break</td>
        <td >
            Other
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>21</td>
        <td ><code>add_quote</code></td>
        <td >
            Check</td>
        <td >
            Add Quote
            
        </td>
        <td></td>
    </tr>
    
</tbody>
Sr Fieldname Type Label Options 
<hr>
<h3>Controller</h3>
<h4>erpnext.setup.doctype.email_digest.email_digest</h4>






    
<h3 style="font-weight: normal;">Class <b>EmailDigest</b></h3>

<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>

<div class="docs-attr-desc"><p></p>

<p class="docs-attr-name">
    <a name="__init__" href="#__init__" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>__init__</b>
    <i class="text-muted">(self, arg1, arg2=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="fmt_money" href="#fmt_money" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>fmt_money</b>
    <i class="text-muted">(self, value)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="get_bank_balance" href="#get_bank_balance" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_bank_balance</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="get_calendar_events" href="#get_calendar_events" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_calendar_events</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Get calendar events for given user</p>


<p class="docs-attr-name">
    <a name="get_expense_year_to_date" href="#get_expense_year_to_date" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_expense_year_to_date</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Get income to date</p>


<p class="docs-attr-name">
    <a name="get_expenses_booked" href="#get_expenses_booked" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_expenses_booked</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="get_from_to_date" href="#get_from_to_date" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_from_to_date</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="get_income" href="#get_income" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_income</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Get income for given period</p>


<p class="docs-attr-name">
    <a name="get_income_year_to_date" href="#get_income_year_to_date" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_income_year_to_date</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Get income to date</p>


<p class="docs-attr-name">
    <a name="get_invoiced_amount" href="#get_invoiced_amount" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_invoiced_amount</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="get_msg_html" href="#get_msg_html" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_msg_html</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Build email digest content</p>


<p class="docs-attr-name">
    <a name="get_next_sending" href="#get_next_sending" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_next_sending</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="get_notifications" href="#get_notifications" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_notifications</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Get notifications for user</p>


<p class="docs-attr-name">
    <a name="get_payables" href="#get_payables" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_payables</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="get_period_amounts" href="#get_period_amounts" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_period_amounts</b>
    <i class="text-muted">(self, accounts)</i>
</p>
<div class="docs-attr-desc"><p>Get amounts for current and past periods</p>


<p class="docs-attr-name">
    <a name="get_root_type_accounts" href="#get_root_type_accounts" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_root_type_accounts</b>
    <i class="text-muted">(self, root_type)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="get_todo_list" href="#get_todo_list" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_todo_list</b>
    <i class="text-muted">(self, user_id=None)</i>
</p>
<div class="docs-attr-desc"><p>Get to-do list</p>


<p class="docs-attr-name">
    <a name="get_type_balance" href="#get_type_balance" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_type_balance</b>
    <i class="text-muted">(self, fieldname, account_type)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="get_users" href="#get_users" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_users</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>get list of users</p>


<p class="docs-attr-name">
    <a name="get_year_to_date_balance" href="#get_year_to_date_balance" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_year_to_date_balance</b>
    <i class="text-muted">(self, root_type)</i>
</p>
<div class="docs-attr-desc"><p>Get income to date</p>


<p class="docs-attr-name">
    <a name="onload" href="#onload" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>onload</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="send" href="#send" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>send</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="set_accounting_cards" href="#set_accounting_cards" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>set_accounting_cards</b>
    <i class="text-muted">(self, context)</i>
</p>
<div class="docs-attr-desc"><p>Create accounting cards if checked</p>


<p class="docs-attr-name">
    <a name="set_dates" href="#set_dates" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>set_dates</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="set_style" href="#set_style" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>set_style</b>
    <i class="text-muted">(self, context)</i>
</p>
<div class="docs-attr-desc"><p>Set standard digest style</p>


<p class="docs-attr-name">
    <a name="set_title" href="#set_title" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>set_title</b>
    <i class="text-muted">(self, context)</i>
</p>
<div class="docs-attr-desc"><p>Set digest title</p>


</div>
<hr>




    

<p><span class="label label-info">Public API</span>
    <br><code>/api/method/erpnext.setup.doctype.email_digest.email_digest.get_digest_msg</code>
</p>
<p class="docs-attr-name">
    <a name="erpnext.setup.doctype.email_digest.email_digest.get_digest_msg" href="#erpnext.setup.doctype.email_digest.email_digest.get_digest_msg" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	erpnext.setup.doctype.email_digest.email_digest.<b>get_digest_msg</b>
    <i class="text-muted">(name)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>


<p class="docs-attr-name">
    <a name="erpnext.setup.doctype.email_digest.email_digest.send" href="#erpnext.setup.doctype.email_digest.email_digest.send" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	erpnext.setup.doctype.email_digest.email_digest.<b>send</b>
    <i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>