yagmail 邮箱的使用

文章来源：github:

1. 安装

pip3 install yagmail
pip3 install keyring

 

2. 简单例子

import yagmail
yag = yagmail.smtp(user = '[e-mail]', password = 'xxx', host = 'smtp.163.com')
yag.send(to = '[e-mail]', subject = 'this is subject', contents = 'this is content')

 

注意：

• 如果你的邮箱没有开通imap/pop3/smtp服务，就会提示如下错误信息：
  smtplib.smtpauthenticationerror: (550, b'user has no permission')
  以163邮箱为例，解决方案在网页上登录自己邮箱，点击“设置->pop3/smtp/imap”，勾选“pop3/stmp服务”和“imap/stmp服务”，弹窗会提示你设置授权码，点击“确定”，点击“开启”，通过验证后，即可开启。记住自己输入的授权码，在password中输入授权码，即可登录。
• 如果程序运行没出错，而目标邮箱没有收到邮件，请检查垃圾箱。

3. 给多个邮箱发邮件

yag.send(to = ['[e-mail]','[e-mail]','[e-mail]'], 'subject', 'contents')

　　

4. 发送附件

yag.send(to = '[e-mail]', subject = 'subject', 
         contents = ['hello', 'c:\\users\\desktop\\test.txt'])

　　

注意：如果邮件发送之后被退回，那么程序不会显示任何错误信息，但是发件人的邮箱会有退信邮件。

5. 更多细节

yagmail.register('mygmailusername', 'mygmailpassword')

　　

以下是项目介绍：

yagmail -- yet another gmail/smtp client

  

这里的目标是尽可能简单，无痛地发送电子邮件。

最后，您的代码将如下所示：

import yagmail
yag = yagmail.smtp()
contents = ['this is the body, and here is just text http://somedomain/image.png',
            'you can find an audio file attached.', '/local/path/song.mp3']
yag.send('[e-mail]', 'subject', contents)

 

或者简单的单行：

yagmail.smtp('mygmailusername').send('[e-mail]', 'subject', 'this is the body')

　　

请注意，它将从您的密钥环安全地读取密码（如下所示）。如果您不想这样，您也可以使用以下内容进行初始化：

yag = yagmail.smtp('mygmailusername', 'mygmailpassword')

　　

但老实说，你想在你的脚本中写下你的密码吗？

同样，我使用我的用户名.yagmail在我的主文件夹中命名的文件中。

目录

部分	说明
	在此处查找有关如何安装yagmail的说明
	不再需要在脚本中填写用户名和密码
	开始吧
	显示发送的一些使用模式
	如何发送给多个人，给别名或发送给自己
	真的很容易发送文本，html，图像和附件
	如何向我发送反馈
	对
	处理发送电子邮件的人员的常见错误列表

安装

对于python 2.x和python 3.x分别：

pip install yagmail[all]
pip3 install yagmail[all]

　　

如果您在安装密钥环时遇到问题，请尝试不安装，即pip install yagmail。

作为旁注，yagmail现在还可以用于从命令行发送电子邮件。

 

用户名和密码

：

the python keyring lib provides a easy way to access the system keyring service from python. it can be used in any application that needs safe password storage.

你知道你想要它。通过打开python解释器并运行来设置它：

import yagmail
yagmail.register('mygmailusername', 'mygmailpassword')

　　

事实上，它只是一个包装keyring.set_password('yagmail', 'mygmailusername', 'mygmailpassword')。

如果未给出密码且密钥环中未找到用户，getpass.getpass()则用于提示用户输入密码。进入此一次后，它可以存储在钥匙圈中，永远不会再问。

另一个便利是将.yagmail文件保存在您的主文件夹中，只包含电子邮件用户名。然后，您可以省略所有内容，只需使用yagmail.smtp()连接即可。当然，这不适用于更多帐户，但它可能是一个很好的默认值。根据要求，我会考虑在此.yagmail文件中添加更多详细信息（主机，端口和其他设置）。

 

开始连接

yag = yagmail.smtp('mygmailusername')

　　

请注意，此连接是可重用的，可关闭的，当它离开范围时，它将在cpython中自行清理。

正如在指出的那样，smtp不会在pypy中自动关闭。with在这种情况下应该使用上下文管理器。

 

可用性

定义一些变量：

to = '[e-mail]'
to2 = '[e-mail]'
to3 = '[e-mail]'
subject = 'this is obviously the subject'
body = 'this is obviously the body'
html = '<a href="https://pypi.python.org/pypi/sky/">click me!</a>'
img = '/local/file/bunny.png'

　　

所有变量都是可选的，并且知道甚至to不需要（您将向自己发送电子邮件）：

yag.send(to = to, subject = subject, contents = body)
yag.send(to = to, subject = subject, contents = [body, html, img])
yag.send(contents = [body, img])

　　

此外，如果您不想明确，可以执行以下操作：

yag.send(to, subject, [body, img])

　　

 

收件人

也可以通过提供电子邮件字符串列表而不是单个字符串来发送给一组人：

yag.send(to = to)
yag.send(to = [to, to2]) # list or tuples for emailadresses *without* aliases
yag.send(to = {to : 'alias1'}) # dictionary for emailaddress *with* aliases
yag.send(to = {to : 'alias1', to2 : 'alias2'}

　　

不做任何to争论将向您自己发送电子邮件。从这个意义上讲，yagmail.smtp().send()已经可以发送电子邮件了。请注意，如果未使用显式，则将to = ...使用第一个参数发送到。可以避免像：

yag.send(subject = 'to self', contents = 'hi!')

　　

请注意，默认情况下，所有电子邮件地址都使用soft_email_validation==true（默认）进行保守验证。

的oauth2

使用oauth2进行身份验证甚至更安全，因为您可以撤消令牌的权限。

是oauth2代码严重依赖的最佳来源之一。

代码：

yag = smtp("[e-mail]", oauth2_file="~/oauth2_creds.json")
yag.send(subject="great!")

　　

当无法找到文件时，它会提示a google_client_id和a google_client_secret。可以获得这些变量。

提供后，终端中将显示一个链接，您应该遵循该链接以获取google_refresh_token。再次粘贴，你就安装好了！

请注意，获取该文件的人可以发送电子邮件，但没有其他内容。一旦发现，您可以直接禁用令牌。

神奇 contents

这个contents论点将被巧妙地猜到。它可以传递一个字符串（将变成一个列表）; 或者一份清单。对于列表中的每个对象：

• 如果它是字典，它将假设键是内容，值是别名（仅适用于当前的图像！），例如{'/ path / to / image.png'：'mypicture'}
• 它将尝试查看内容（字符串）是否可以在本地读取，例如'/path/to/image.png'
• 如果不可能，它将检查字符串是否有效html例如 <h1>this is a big title</h1>
• 如果没有，那一定是文字。例如'hi dorika！'

请注意，本地文件可以是html（内联）; 其他一切都会附上。

本地文件需要具有推断其内容类型的扩展名。

截至0.4.94版本，raw并且inline已被添加。

• raw 确保字符串不会收到任何“魔法”（内联，html，附加）
• inline 将使图像出现在文本中。

反馈

我将尽力在24小时内回应github .....

请给我一些反馈意见smtp().feedback('great job!'):-)

路线图（和优先事项）

• 增加了image的可能性
• 可选的smtp参数应该使用** kwargs到我的smtp
• cc / bcc（高）
• 自定义名称（高）
• 允许发送返回预览而不是实际发送
• 只需在“内容”中使用附件，智能猜测（高，复杂）
• 列表中的附件（内容），以便它们实际定义订单（中）
• 使用lxml查看它是否可以解析html（低）
• 增加测试（高）
• 允许缓存内容（低）
• 其他类型（低） （例如，mp3也可以，如果有什么不起作用，请告诉我）
• 可能是内容类型/默认类型的命名问题
• 选择内联或不以某种方式（高）
• 使lxml模块可选魔术（高）
• 为复杂内容提供自动回退（中） （应该管用）
• yagmail 安装时作为cli上的命令
• feedback在smtp上添加功能可以直接向我发送反馈:-)
• 添加了验证emailaddresses的选项...
• 但是，我对错误电子邮件的错误处理/登录不满意
• 记录计数和邮件功能（非常低）
• 向异常类添加文档（低）
• 添加raw和'内联```
• 的oauth2
• ~~ travis ci整合~~
• ~~为所有功能添加文档（高，中途）~~
• 准备官方1.0
• 再次浏览文档（中）
• 允许.yagmail文件包含更多参数（中）
• 添加缩小图像的选项（低）

错误

• 确保您有密钥环条目（请参阅“ ），或使用getpass进行注册。我不鼓励在脚本中使用用户名/密码。

• smtplib.smtpexception: smtp auth extension not supported by server

• smtpauthenticationerror: application-specific password required

• yagaddresserror：这意味着地址以无效格式给出。请注意，from可以是字符串，也可以是键为a的字典，email值为alias{'  '：'sam'}。在'to'的情况下，它可以是字符串（email），电子邮件列表（没有别名的电子邮件地址）或字典，其中键是电子邮件地址，值表示别名。

• yaginvalidemailaddress：请注意，这只会过滤掉emailaddresses中的语法错误。如果一个人认为它可能是有效的电子邮件，它很可能会通过。但是，它仍然很可能是任何人都没有声称实际的电子邮件地址（因此这个功能无法取消验证）。

• 点击以启用外部使用的电子邮件

• 确保您有可用的互联网连接

• 如果您importerror尝试安装sudo，请参阅问题＃13