email_lib Package

email_lib Package

webnotes.utils.email_lib.get_contact_list()

Returns contacts (from autosuggest)

webnotes.utils.email_lib.get_footer()

Returns combination of footer from globals and Control Panel

webnotes.utils.email_lib.make_html_body(content, template=None)

Generate html content from a Page Template object

webnotes.utils.email_lib.send_form()

Emails a print format (form) Called from form UI

webnotes.utils.email_lib.sendmail(recipients, sender='', msg='', subject='[No Subject]', parts=[], cc=[], attach=[], send_now=1, reply_to=None, template=None)

send an html email as multipart with attachments and all

webnotes.utils.email_lib.sendmail_html(sender, recipients, subject, html, text=None, template=None, send_now=1, reply_to=None)

Send an html mail with alternative text and using Page Templates

form_email Module

class webnotes.utils.email_lib.form_email.FormEmail

Represents an email sent from a Form

build_message()

Builds the message object

get_form_link()

Returns publicly accessible form link

make_full_links()

Adds server name the relative links, so that images etc can be seen correctly

send()

Send the form with html attachment

set_attachments()

Set attachments to the email from the form

update_contacts()

Add new email contact to database

html2text Module

html2text: Turn HTML into equivalent Markdown-structured text.

webnotes.utils.email_lib.html2text.charref(name)

webnotes.utils.email_lib.html2text.entityref(c)

webnotes.utils.email_lib.html2text.has_key(x, y)

webnotes.utils.email_lib.html2text.hn(tag)

webnotes.utils.email_lib.html2text.html2text(html, baseurl='')

webnotes.utils.email_lib.html2text.html2text_file(html, out=<function wrapwrite at 0x38ff030>, baseurl='')

webnotes.utils.email_lib.html2text.name2cp(k)

webnotes.utils.email_lib.html2text.onlywhite(line)

Return true if the line does only consist of whitespace characters.

webnotes.utils.email_lib.html2text.optwrap(text)

Wrap all paragraphs in the provided text.

webnotes.utils.email_lib.html2text.replaceEntities(s)

webnotes.utils.email_lib.html2text.unescape(s)

webnotes.utils.email_lib.html2text.wrapwrite(text)

receive Module

This module contains classes for managing incoming emails

class webnotes.utils.email_lib.receive.IncomingMail(content)

Single incoming email object. Extracts, text / html and attachments from the email

get_attachment(part, charset)

Extracts an attachment

get_charset(part)

Guesses character set

get_payload(part, charset)

get utf-8 encoded part content

get_text_content()

Returns the text parts of the email. If None, then HTML parts

get_thread_id()

Extracts thread id of the message between first [] from the subject

parse()

Extracts text, html and attachments from the mail

process_part(part)

Process a single part of an email

class webnotes.utils.email_lib.receive.POP3Mailbox(settings_doc)

A simple pop3 mailbox, abstracts connection and mail extraction To use, subclass it and override method process_message(from, subject, text, thread_id)

check_mails()

To be overridden If mailbox is to be scanned, returns true

connect()

Connects to the mailbox

get_messages()

Loads messages from the mailbox and calls process_message for each message

process_message(mail)

To be overriden

send Module

Sends email via outgoing server specified in “Control Panel” Allows easy adding of Attachments of “File” objects

class webnotes.utils.email_lib.send.EMail(sender='', recipients=[], subject='', from_defs=0, alternative=0, reply_to=None)

Wrapper on the email module. Email object represents emails to be sent to the client. Also provides a clean way to add binary FileData attachments Also sets all messages as multipart/alternative for cleaner reading in text-only clients

add_attachment(fname, fcontent, content_type=None)

add_to_queue()

attach_file(n)

attach a file from the FileData table

make_msg()

send(send_now=0)

send the message

set_html(message)

Attach message in the html portion of multipart/alternative

set_message(message, mime_type='text/html', as_attachment=0, filename='attachment.html')

Append the message with MIME content to the root node (as attachment)

set_text(message)

Attach message in the text portion of multipart/alternative

setup()

setup the SMTP (outgoing) server from Control Panel or defs.py

validate()

validate the email ids

class webnotes.utils.email_lib.send.EmailQueue

close()

flush(qty=100)

get_smtp_session(e)

push(email)