File: test_gmail_oauth.py

package info (click to toggle)
aiosmtplib 5.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 604 kB
  • sloc: python: 5,823; makefile: 20; sh: 6
file content (207 lines) | stat: -rw-r--r-- 5,808 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
#!/usr/bin/env python3
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "aiosmtplib",
#     "google-auth",
#     "google-auth-oauthlib",
# ]
#
# [tool.uv.sources]
# aiosmtplib = { path = ".." }
# ///
"""
Test script for Gmail XOAUTH2 authentication with aiosmtplib.

Usage:
    # Step 1: Get a refresh token (one-time setup)
    python test_gmail_oauth.py authorize \
        --client-id YOUR_CLIENT_ID \
        --client-secret YOUR_CLIENT_SECRET

    # Step 2: Send a test email
    python test_gmail_oauth.py send \
        --client-id YOUR_CLIENT_ID \
        --client-secret YOUR_CLIENT_SECRET \
        --refresh-token YOUR_REFRESH_TOKEN \
        --username YOUR_EMAIL@gmail.com \
        --to RECIPIENT@example.com

This script will send a test email using Gmail's SMTP server with OAuth2
authentication.

Run with: uv run test_gmail_oauth.py <command> [options]
"""

import argparse
import asyncio
from email.message import EmailMessage

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow

import aiosmtplib

# Gmail SMTP scope
GMAIL_SCOPES = ["https://mail.google.com/"]

# Google OAuth2 token endpoint
TOKEN_URI = "https://oauth2.googleapis.com/token"


def authorize(client_id: str, client_secret: str) -> None:
    """Run the OAuth2 authorization flow to get a refresh token."""
    # Build client config for InstalledAppFlow
    client_config = {
        "installed": {
            "client_id": client_id,
            "client_secret": client_secret,
            "auth_uri": "https://accounts.google.com/o/oauth2/auth",
            "token_uri": TOKEN_URI,
            "redirect_uris": ["http://localhost"],
        }
    }

    flow = InstalledAppFlow.from_client_config(client_config, scopes=GMAIL_SCOPES)

    print("=" * 60)
    print("Gmail OAuth2 Authorization")
    print("=" * 60)
    print()
    print("Opening browser for authorization...")

    credentials = flow.run_local_server(port=8089)

    print()
    print("=" * 60)
    print("Authorization successful!")
    print("=" * 60)
    print()
    print(f"Access Token:  {credentials.token[:50]}...")
    print(f"Refresh Token: {credentials.refresh_token}")
    print(f"Expiry:        {credentials.expiry}")
    print()
    print("Save the refresh token above and use it with the 'send' command.")


async def send_test_email(
    client_id: str,
    client_secret: str,
    refresh_token: str,
    username: str,
    to: str,
) -> None:
    """Send a test email using Gmail XOAUTH2."""
    # Create credentials object using google-auth
    credentials = Credentials(
        token=None,  # Will be refreshed
        refresh_token=refresh_token,
        token_uri=TOKEN_URI,
        client_id=client_id,
        client_secret=client_secret,
    )

    async def get_gmail_token() -> str:
        """Return a valid access token, refreshing if needed."""
        if not credentials.valid:
            print("Refreshing access token...")
            await asyncio.to_thread(credentials.refresh, Request())
            print(f"Got access token: {credentials.token[:20]}...")
        return credentials.token

    # Build the email message
    message = EmailMessage()
    message["From"] = username
    message["To"] = to
    message["Subject"] = "Test email from aiosmtplib XOAUTH2"
    message.set_content(
        "This is a test email sent using aiosmtplib with Gmail XOAUTH2 authentication.\n\n"
        "If you received this, the OAuth2 implementation is working correctly!"
    )

    print(f"Sending email from {username} to {to}...")

    # Send via Gmail SMTP with OAuth2
    response = await aiosmtplib.send(
        message,
        hostname="smtp.gmail.com",
        port=465,
        use_tls=True,
        username=username,
        oauth_token_generator=get_gmail_token,
    )

    print("Email sent successfully!")
    print(f"Server response: {response}")


def main() -> None:
    parser = argparse.ArgumentParser(description="Test Gmail XOAUTH2 with aiosmtplib")
    subparsers = parser.add_subparsers(dest="command", required=True)

    # Authorize subcommand
    auth_parser = subparsers.add_parser(
        "authorize",
        help="Get a refresh token via OAuth2 authorization flow",
    )
    auth_parser.add_argument(
        "--client-id",
        required=True,
        help="Google OAuth2 client ID",
    )
    auth_parser.add_argument(
        "--client-secret",
        required=True,
        help="Google OAuth2 client secret",
    )

    # Send subcommand
    send_parser = subparsers.add_parser(
        "send",
        help="Send a test email using OAuth2",
    )
    send_parser.add_argument(
        "--client-id",
        required=True,
        help="Google OAuth2 client ID",
    )
    send_parser.add_argument(
        "--client-secret",
        required=True,
        help="Google OAuth2 client secret",
    )
    send_parser.add_argument(
        "--refresh-token",
        required=True,
        help="Google OAuth2 refresh token",
    )
    send_parser.add_argument(
        "--username",
        required=True,
        help="Sender email address (your Gmail address)",
    )
    send_parser.add_argument(
        "--to",
        required=True,
        help="Recipient email address",
    )

    args = parser.parse_args()

    if args.command == "authorize":
        authorize(args.client_id, args.client_secret)
    elif args.command == "send":
        asyncio.run(
            send_test_email(
                client_id=args.client_id,
                client_secret=args.client_secret,
                refresh_token=args.refresh_token,
                username=args.username,
                to=args.to,
            )
        )


if __name__ == "__main__":
    main()