prefect_email.message
¶
Tasks for interacting with email message services
email_send_message
async
¶
Sends an email message from an authenticated email service over SMTP. Sending messages containing HTML code is supported - the default MIME type is set to the text/html.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
subject |
str
|
The subject line of the email. |
required |
msg |
str
|
The contents of the email, added as html; can be used in combination with msg_plain. |
required |
msg_plain |
Optional[str]
|
The contents of the email as plain text, can be used in combination with msg. |
None
|
email_to |
Optional[Union[str, List[str]]]
|
The email addresses to send the message to, separated by commas. If a list is provided, will join the items, separated by commas. |
None
|
email_to_cc |
Optional[Union[str, List[str]]]
|
Additional email addresses to send the message to as cc, separated by commas. If a list is provided, will join the items, separated by commas. |
None
|
email_to_bcc |
Optional[Union[str, List[str]]]
|
Additional email addresses to send the message to as bcc, separated by commas. If a list is provided, will join the items, separated by commas. |
None
|
attachments |
Optional[List[str]]
|
Names of files that should be sent as attachment. |
None
|
Returns:
Name | Type | Description |
---|---|---|
MimeText |
The MIME Multipart message of the email. |
Example
Sends a notification email to someone@gmail.com.
from prefect import flow
from prefect_email import EmailServerCredentials, email_send_message
@flow
def example_email_send_message_flow():
email_server_credentials = EmailServerCredentials(
username="username@email.com",
password="password",
)
subject = email_send_message(
email_server_credentials=email_server_credentials,
subject="Example Flow Notification",
msg="This proves email_send_message works!",
email_to="someone@email.com",
)
return subject
example_email_send_message_flow()
Source code in prefect_email/message.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
|