You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
本文是 Gmail 和 Outlook 的 OAuth 授权步骤,对照代码实际请求的 scope 和回调地址,不是通用模板。
邮箱之间的转发是另一个话题,包括「用转发替代 OAuth」这条路,见 #47。
一、为什么需要 OAuth
Gmail 和 Outlook 对大多数账号都已关闭"密码直接登录 IMAP"。其余服务商(QQ、163、iCloud、Fastmail 等)仍然用授权码或应用专用密码,配置行写成
provider|邮箱|授权码就够了,不需要读这篇。两个共同前提:
http://localhost:8765/,端口由OAUTH_REDIRECT_PORT控制,注册应用时必须一字不差地填这个地址。npm run oauth -- --manual,它只打印链接,你在本地浏览器里批准后,把跳转后地址栏里的完整 URL 粘回终端。二、Gmail
申请凭据
https://mail.google.com/。这是 IMAP 全量访问所需的 scope,属于 Google 的受限 scope。http://localhost回调,不必手填。.env:账号行不需要填密码,授权完成后 refresh token 存在
data/tokens.json。务必把同意屏幕发布
这是最容易踩的坑。同意屏幕停在「测试」状态时,Google 会让 refresh token 每 7 天过期一次,表现为每周固定收到一封"邮箱不可用"告警。把它切到「生产」即可,受限 scope 在只有自己使用时会出现"未经验证的应用"提示,点继续即可。
mailsift 在连续认证失败时也会把这条写进告警正文,所以不用记。
更省事的替代方案
个人 Gmail 开启两步验证后可以生成应用专用密码,用
gmail_pw走密码登录,完全不用 OAuth:Workspace 账号通常被管理员禁用了这个功能,只能走 OAuth。
三、Outlook
注册应用
http://localhost:8765/。IMAP.AccessAsUser.All和offline_access。代码请求的完整 scope 是https://outlook.office.com/IMAP.AccessAsUser.All offline_access。Outlook.com 的 IMAP 默认是关的
授权全部正确却依然登录失败,九成是这个原因。到 Outlook 网页版 → 设置 → 邮件 → 转发和 IMAP → 勾选「允许设备和应用使用 IMAP」。
一个可以忽略的现象
Outlook 的 IMAP 在认证之后、第一条命令之前偶尔会回
NO User is authenticated but not connected。mailsift 把它识别为瞬时故障并自动重试,日志里每次建连出现一行是正常的,不必处理。四、不想注册应用?可以借用公开的客户端 ID
OAuth 里有「公开客户端」这一类:桌面和移动应用无法保管密钥,所以它们的 client ID(有时还有一个名义上的 secret)本来就是公开的,随发行版一起分发。这意味着任何一个申请了你需要的 scope 的开源邮件客户端,它的 client ID 理论上都能拿来给你自己的账号换取 token——授权是你本人完成的,token 也只属于你,那个应用的作者拿不到任何东西。
填进
.env的方式和自建应用完全一样,把GMAIL_CLIENT_ID或OUTLOOK_CLIENT_ID换成借来的值即可。技术上的前提
回调地址必须对得上。 mailsift 用的是
http://localhost:8765/(由OAUTH_REDIRECT_PORT控制)。http://localhost:<任意端口>回调,所以这类 ID 基本可以直接用。OAUTH_REDIRECT_PORT改成那个端口。另外,借来的客户端申请的 scope 可能比你需要的宽。同意屏幕上会如实列出,授权前看一眼。
为什么我仍然建议自己注册
不点名任何具体客户端,是因为这件事的代价不由你承担,而是落在被借用的项目身上:
自己注册一个大约十分钟,上面四条全都不存在。如果只是嫌麻烦,个人 Gmail 还有更省事的两条路:第二节的整箱转发,或者第三节末尾的应用专用密码,两者都完全不碰 OAuth。
五、执行授权
容器部署要注意:宿主机上直接跑
npm run oauth写入的是./data/tokens.json,不是容器用的命名卷。给容器里的账号授权要用:授权完成后验证:
All reactions