3.6 KiB
3.6 KiB
Gmail Routing Reference
App name: google-mail
Base URL proxied: gmail.googleapis.com
API Path Pattern
/google-mail/gmail/v1/users/me/{endpoint}
Common Endpoints
List Messages
GET /google-mail/gmail/v1/users/me/messages?maxResults=10
With query filter:
GET /google-mail/gmail/v1/users/me/messages?q=is:unread&maxResults=10
Get Message
GET /google-mail/gmail/v1/users/me/messages/{messageId}
With metadata only:
GET /google-mail/gmail/v1/users/me/messages/{messageId}?format=metadata&metadataHeaders=From&metadataHeaders=Subject&metadataHeaders=Date
Send Message
POST /google-mail/gmail/v1/users/me/messages/send
Content-Type: application/json
{
"raw": "BASE64_ENCODED_EMAIL"
}
List Labels
GET /google-mail/gmail/v1/users/me/labels
List Threads
GET /google-mail/gmail/v1/users/me/threads?maxResults=10
Get Thread
GET /google-mail/gmail/v1/users/me/threads/{threadId}
Modify Message Labels
POST /google-mail/gmail/v1/users/me/messages/{messageId}/modify
Content-Type: application/json
{
"addLabelIds": ["STARRED"],
"removeLabelIds": ["UNREAD"]
}
Trash Message
POST /google-mail/gmail/v1/users/me/messages/{messageId}/trash
Create Draft
POST /google-mail/gmail/v1/users/me/drafts
Content-Type: application/json
{
"message": {
"raw": "BASE64URL_ENCODED_EMAIL"
}
}
Update Draft
PUT /google-mail/gmail/v1/users/me/drafts/{draftId}
Content-Type: application/json
{
"message": {
"raw": "BASE64URL_ENCODED_EMAIL"
}
}
Send Draft
POST /google-mail/gmail/v1/users/me/drafts/send
Content-Type: application/json
{
"id": "{draftId}"
}
Get Profile
GET /google-mail/gmail/v1/users/me/profile
Query Operators
Use in the q parameter:
is:unread- Unread messagesis:starred- Starred messagesfrom:email@example.com- From specific senderto:email@example.com- To specific recipientsubject:keyword- Subject contains keywordafter:2024/01/01- After datebefore:2024/12/31- Before datehas:attachment- Has attachments
Notes
- Authentication is automatic - the router injects the OAuth token
- Use
meas userId for the authenticated user - Message body is base64url encoded in the
rawfield