293 lines
No EOL
8.1 KiB
HTML
293 lines
No EOL
8.1 KiB
HTML
<!-- title: frappe.email.email_body --><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/blob/develop/frappe/email/email_body.py"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>EMail</b></h3>
|
|
|
|
<div class="docs-attr-desc"><p>Wrapper on the email module. Email object represents emails to be sent to the client.
|
|
Also provides a clean way to add binary <code>FileData</code> attachments
|
|
Also sets all messages as multipart/alternative for cleaner reading in text-only clients</p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
|
|
|
|
|
|
<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, sender=, recipients=(), subject=, alternative=0, reply_to=None, cc=())</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="add_attachment" href="#add_attachment" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>add_attachment</b>
|
|
<i class="text-muted">(self, fname, fcontent, content_type=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>add attachment</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="add_pdf_attachment" href="#add_pdf_attachment" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>add_pdf_attachment</b>
|
|
<i class="text-muted">(self, name, html, options=None)</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="as_string" href="#as_string" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>as_string</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>validate, build message and convert to string</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="attach_file" href="#attach_file" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>attach_file</b>
|
|
<i class="text-muted">(self, n)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>attach a file from the <code>FileData</code> table</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_default_sender" href="#get_default_sender" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_default_sender</b>
|
|
<i class="text-muted">(self)</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="make" href="#make" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>make</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>build into msg_root</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="set_html" href="#set_html" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>set_html</b>
|
|
<i class="text-muted">(self, message, text_content=None, footer=None, print_html=None, formatted=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Attach message in the html portion of multipart/alternative</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="set_html_as_text" href="#set_html_as_text" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>set_html_as_text</b>
|
|
<i class="text-muted">(self, html)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>return html2text</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="set_message" href="#set_message" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>set_message</b>
|
|
<i class="text-muted">(self, message, mime_type=text/html, as_attachment=0, filename=attachment.html)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Append the message with MIME content to the root node (as attachment)</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="set_message_id" href="#set_message_id" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>set_message_id</b>
|
|
<i class="text-muted">(self, message_id)</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="set_part_html" href="#set_part_html" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>set_part_html</b>
|
|
<i class="text-muted">(self, message)</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="set_text" href="#set_text" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>set_text</b>
|
|
<i class="text-muted">(self, message)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Attach message in the text portion of multipart/alternative</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<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>validate the email ids</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.email.email_body.get_email" href="#frappe.email.email_body.get_email" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.email.email_body.<b>get_email</b>
|
|
<i class="text-muted">(recipients, sender=, msg=, subject=[No Subject], text_content=None, footer=None, print_html=None, formatted=None, attachments=None, content=None, reply_to=None, cc=())</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>send an html email as multipart with attachments and all</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.email.email_body.get_footer" href="#frappe.email.email_body.get_footer" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.email.email_body.<b>get_footer</b>
|
|
<i class="text-muted">(email_account, footer=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>append a footer (signature)</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.email.email_body.get_formatted_html" href="#frappe.email.email_body.get_formatted_html" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.email.email_body.<b>get_formatted_html</b>
|
|
<i class="text-muted">(subject, message, footer=None, print_html=None)</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.email_body.get_signature" href="#frappe.email.email_body.get_signature" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.email.email_body.<b>get_signature</b>
|
|
<i class="text-muted">(email_account)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc --> |