IssueTracker

Before opening a new issue, please search for other related issues, click the ★ to subscribe to updates, and click +1 to vote.

Description

The users.messages.modify API endpoint is returning inconsitent responses.

If the message already has a label and you try to add it with addLabelIds it returns back a minimal formatted response. If the message does not have the label, it returns a message that is missing fields.

The same issue occurs when using removeLabelIds, if the label is not on the message, it returns the minimal formatted message, otherwise fields are missing.

Examples

Add "UNREAD" label to a message that doesn't have the "UNREAD" label

Request

POST https://gmail.googleapis.com/gmail/v1/users/me/messages/19010d2fa66785b3/modify
{
  "addLabelIds": [
    "UNREAD"
  ]
}

Response

{
   "id": "19010d2fa66785b3",
   "labelIds": [
      "UNREAD",
      "CATEGORY_UPDATES",
      "INBOX"
   ],
   "threadId": "19010d2fa66785b3"
}

Add "UNREAD" label to a message that already has the "UNREAD" label

Request

POST https://gmail.googleapis.com/gmail/v1/users/me/messages/19010d2fa66785b3/modify
{
  "addLabelIds": [
    "UNREAD"
  ]
}

Response

{
   "historyId": "1323337",
   "id": "19010d2fa66785b3",
   "internalDate": "1718269180000",
   "labelIds": [
      "UNREAD",
      "CATEGORY_UPDATES",
      "INBOX"
   ],
   "sizeEstimate": 31201,
   "snippet": "...",
   "threadId": "19010d2fa66785b3"
}

Code

Minimalistic code to reproduce the issue in Go:

package main

import (
	"context"
	"encoding/json"
	"log"

	"golang.org/x/oauth2"
	google_oauth "golang.org/x/oauth2/google"
	"google.golang.org/api/gmail/v1"
	"google.golang.org/api/option"
)

const (
	userId        = "me"
	unreadLabelId = "UNREAD"
)

func main() {
	ctx := context.TODO()

	//TODO: fill in the config and token value below
	config := &oauth2.Config{
		ClientID:     "",
		ClientSecret: "",
		RedirectURL:  "",
		Scopes:       []string{gmail.GmailModifyScope},
		Endpoint:     google_oauth.Endpoint,
	}

	token := &oauth2.Token{
		AccessToken: "",
	}

	gmailService, err := gmail.NewService(ctx, option.WithHTTPClient(config.Client(ctx, token)))
	if err != nil {
		log.Fatal("error creating gmail service", err)
	}

	//Get a message that doesn't have the "UNREAD" label
	listResponse, err := gmailService.Users.Messages.List(userId).MaxResults(1).Q("is:read").Do()
	if err != nil {
		log.Fatal("error listing read messages", err)
	}

	if len(listResponse.Messages) == 0 {
		log.Fatal("no read messages available")
	}

	message := listResponse.Messages[0]

	log.Println("Adding labels to message")
	// Add "UNREAD" label to the message
	firstAddLabelResponse := addLabelToMessage(gmailService, message.Id, unreadLabelId)
	prettyPrintMessage("first users.messages.modify response for addLabelIds", firstAddLabelResponse)

	// Call again to add "UNREAD" label to the message, which is already on the message
	secondAddLabelResponse := addLabelToMessage(gmailService, message.Id, unreadLabelId)
	prettyPrintMessage("second users.messages.modify response for addLabelIds", secondAddLabelResponse)

	log.Println("Removing labels from message")

	// Remove "UNREAD" label to the message
	firstRemoveLabelResponse := removeLabelFromMessage(gmailService, message.Id, unreadLabelId)
	prettyPrintMessage("first users.messages.modify response for removeLabelIds", firstRemoveLabelResponse)

	// Call again to remove "UNREAD" label to the message, which does not exist  on the message
	secondRemoveLabelResponse := removeLabelFromMessage(gmailService, message.Id, unreadLabelId)
	prettyPrintMessage("second users.messages.modify response for removeLabelIds", secondRemoveLabelResponse)
}

func addLabelToMessage(gmailService *gmail.Service, messageId string, labelId string) *gmail.Message {
	message, err := gmailService.Users.Messages.Modify(userId, messageId, &gmail.ModifyMessageRequest{
		AddLabelIds: []string{labelId},
	}).Do()
	if err != nil {
		log.Fatal("error updating message", err)
	}

	return message
}
func removeLabelFromMessage(gmailService *gmail.Service, messageId string, labelId string) *gmail.Message {
	message, err := gmailService.Users.Messages.Modify(userId, messageId, &gmail.ModifyMessageRequest{
		RemoveLabelIds: []string{labelId},
	}).Do()
	if err != nil {
		log.Fatal("error updating message", err)
	}

	return message
}

func prettyPrintMessage(logMessage string, message *gmail.Message) {
	messageJson, err := json.MarshalIndent(message, "", "   ")
	if err != nil {
		log.Fatal("unable to marshal message", err)
	}

	log.Printf("%s:\n%s\n", logMessage, messageJson)
}

Output

2024/06/13 12:08:29 Adding labels to messages
2024/06/13 12:08:29 first users.messages.modify response for addLabelIds:
{
   "id": "19010d2fa66785b3",
   "labelIds": [
      "UNREAD",
      "CATEGORY_UPDATES",
      "INBOX"
   ],
   "threadId": "19010d2fa66785b3"
}
2024/06/13 12:08:29 second users.messages.modify response for addLabelIds:
{
   "historyId": "1323449",
   "id": "19010d2fa66785b3",
   "internalDate": "1718269180000",
   "labelIds": [
      "UNREAD",
      "CATEGORY_UPDATES",
      "INBOX"
   ],
   "sizeEstimate": 31201,
   "snippet": "...",
   "threadId": "19010d2fa66785b3"
}
2024/06/13 12:08:29 Removing labels from messages
2024/06/13 12:08:30 first users.messages.modify response for removeLabelIds:
{
   "id": "19010d2fa66785b3",
   "labelIds": [
      "CATEGORY_UPDATES",
      "INBOX"
   ],
   "threadId": "19010d2fa66785b3"
}
2024/06/13 12:08:30 second users.messages.modify response for removeLabelIds:
{
   "historyId": "1323477",
   "id": "19010d2fa66785b3",
   "internalDate": "1718269180000",
   "labelIds": [
      "CATEGORY_UPDATES",
      "INBOX"
   ],
   "sizeEstimate": 31201,
   "snippet": "...",
   "threadId": "19010d2fa66785b3"
}

Steps

• Call to users.messages.modify for a message and add a label that doesn't exist on the message.

Expected behaviour

The response from the API call should be consistent and always return a minimal formatted message