API Reference
The Email Object
An email object that in a serializable, previewable format, optimized for emails with content generated by data scientists.
| IntermediateEmail | A serializable, previewable, sendable email object for data science workflows. |
| IntermediateEmail.write_preview_email | Write a preview HTML file with inline attachments embedded. |
| IntermediateEmail.write_email_message | Convert the IntermediateEmail to a Python EmailMessage. |
| IntermediateEmail.preview_send_email | Send a preview of the email to a test recipient. |
Uploading emails
Converting emails to IntermediateEmails, at which point they can be previewed, tested, and sent.
| quarto_json_to_intermediate_email | Convert a Quarto output metadata JSON file to an IntermediateEmail |
| mjml_to_intermediate_email | Convert MJML markup to an IntermediateEmail |
| redmail_to_intermediate_email | Convert a Redmail EmailMessage object to an IntermediateEmail |
| yagmail_to_intermediate_email | Convert a Yagmail email object to an IntermediateEmail |
Sending
Functions to sending emails with different providers. And a special handy one to bypass the intermediate object if you are sending a quarto email.
| send_intermediate_email_with_gmail | Send an Intermediate Email object via Gmail. |
| send_intermediate_email_with_smtp | Send an Intermediate Email object via SMTP. |
| send_intermediate_email_with_redmail | Send an Intermediate Email object via Redmail. |
| send_intermediate_email_with_yagmail | Send an Intermediate Email object via Yagmail. |
| send_intermediate_email_with_mailgun | Send an Intermediate Email object via Mailgun. |
| send_quarto_email_with_gmail | Send an email using Gmail with content from a Quarto metadata JSON file. |
Utilities
Previews and more
| write_email_message_to_file | Writes the HTML content of an email message to a file, inlining any images referenced by Content-ID (cid). |