Version 6.x.x Source

Class BulkLimitCrossedError

Inherits from frappe.exceptions.ValidationError


frappe.email.bulk.add (email, sender, subject, formatted, text_content=None, reference_doctype=None, reference_name=None, attachments=None, reply_to=None, cc=(), message_id=None, send_after=None, bulk_priority=1)

add to bulk mail queue


frappe.email.bulk.check_bulk_limit (recipients)

No docs


frappe.email.bulk.clear_outbox ()

Remove mails older than 31 days in Outbox. Called daily via scheduler.


frappe.email.bulk.flush (from_test=False)

flush email queue, every time: called from scheduler


frappe.email.bulk.get_unsubcribed_url (reference_doctype, reference_name, email, unsubscribe_method, unsubscribe_params)

No docs


frappe.email.bulk.get_unsubscribe_link (reference_doctype, reference_name, email, recipients, expose_recipients, show_as_cc, unsubscribe_method, unsubscribe_params, unsubscribe_message)

No docs


frappe.email.bulk.return_unsubscribed_page (email, doctype, name)

No docs


frappe.email.bulk.send (recipients=None, sender=None, subject=None, message=None, reference_doctype=None, reference_name=None, unsubscribe_method=None, unsubscribe_params=None, unsubscribe_message=None, attachments=None, reply_to=None, cc=(), show_as_cc=(), message_id=None, send_after=None, expose_recipients=False, bulk_priority=1)

Add email to sending queue (Bulk Email)

Parameters:


Public API
/api/method/frappe.email.bulk.unsubscribe

frappe.email.bulk.unsubscribe (doctype, name, email)

No docs