API引用?

此頁顯示的是 yagmail 的API。

認證?

yagmail.register(username, password)[源代碼]?

使用這個可以在你的操作系統的keyring中添加一個新的gmail帳戶,這樣它就可以在yagmail中使用了

另一種身份驗證方法是通過傳遞 oauth2_fileyagmail.SMTP ,這是最安全的身份驗證方法之一。請看 OAuth2 sectionREADME 更多詳情。

也可以簡單地將密碼傳遞給 yagmail.SMTP . 如果沒有給出密碼,yagmail將提示用戶輸入密碼,然后將結果存儲在keyring中。

SMTP客戶端?

class yagmail.SMTP(user=None, password=None, host='smtp.gmail.com', port=None, smtp_starttls=None, smtp_ssl=True, smtp_set_debuglevel=0, smtp_skip_login=False, encoding='utf-8', oauth2_file=None, soft_email_validation=True, dkim=None, **kwargs)[源代碼]?

yagmail.SMTP 是一個神奇的包裝 smtplib 的SMTP連接,并允許發送郵件。

close()[源代碼]?

關閉與SMTP服務器的連接

feedback(message='Awesome features! You made my day! How can I contribute?')[源代碼]?

最重要的功能。請給我反饋:-)

send(to=None, subject=None, contents=None, attachments=None, cc=None, bcc=None, preview_only=False, headers=None, prettify_html=True, message_id=None, group_messages=True)[源代碼]?

使用此選項可使用gmail發送電子郵件

send_unsent()[源代碼]?

無法發送的電子郵件將存儲在 self.unsent . 使用此函數可嘗試再次發送這些

set_logging(log_level=40, file_path_name=None)[源代碼]?

此函數允許更改日志記錄后端,無論是作為后端的輸出還是文件,它還允許設置日志記錄級別(是否只顯示critical/error/info/debug。例如::

yag = yagmail.SMTP()
yag.set_logging(yagmail.logging.DEBUG)  # to see everything

和:

yagmail.set_logging(yagmail.logging.DEBUG, 'somelocalfile.log')

最后,日志級別 None 將確保沒有I/O。

電子郵件內容?

class yagmail.raw[源代碼]?

確保字符串被視為文本,不會收到“magic”。

class yagmail.inline[源代碼]?

僅當希望內聯圖像而不是附加圖像時才需要

例外情況?

包含例外情況

exception yagmail.error.YagAddressError[源代碼]?

這意味著地址的格式無效。注意From可以是字符串,也可以是字典,其中鍵是電子郵件,值是別名{'sample@gmail.com'山姆'}。在“to”的情況下,它可以是字符串(email)、電子郵件列表(沒有別名的電子郵件地址)或字典,其中鍵是電子郵件地址,值表示別名。此外,它不驗證電子郵件是否存在。

exception yagmail.error.YagConnectionClosed[源代碼]?

連接對象已被用戶關閉。此對象可用于在登錄后再次發送電子郵件,使用self.login登錄().

exception yagmail.error.YagInvalidEmailAddress[源代碼]?

注意,這只會過濾掉emailaddresses中的語法錯誤。如果一個人認為這可能是一封有效的電子郵件,它很可能會通過。但是,實際的emailaddress可能還沒有被任何人聲明(所以這個函數不能貶值)。

公用事業?

yagmail.validate.validate_email_with_regex(email_address)[源代碼]?

注意,這只會過濾掉emailaddresses中的語法錯誤。如果一個人認為這可能是一封有效的電子郵件,它很可能會通過。但是,實際的emailaddress可能還沒有被任何人聲明(所以這個函數不能貶值)。