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:
recipients
- List of recipients.sender
- Email sender.subject
- Email subject.message
- Email message.reference_doctype
- Reference DocType of caller document.reference_name
- Reference name of caller document.bulk_priority
- Priority for bulk email, default 1.unsubscribe_method
- URL method for unsubscribe. Default is /api/method/frappe.email.bulk.unsubscribe
.unsubscribe_params
- additional params for unsubscribed links. default are name, doctype, emailattachments
- Attachments to be sent.reply_to
- Reply to be captured here (default inbox)message_id
- Used for threading. If a reply is received to this email, Message-Id is sent back as In-Reply-To in received email.send_after
- Send this email after the given datetime. If value is in integer, then send_after
will be the automatically set to no of days from current date.Public API
/api/method/frappe.email.bulk.unsubscribe
frappe.email.bulk.unsubscribe (doctype, name, email)
No docs