Skip to content

Gmail

The gmailutil/v1 package provides utilities for Gmail API operations.

Features

  • Send emails - Simple and advanced message composition
  • Read messages - List, filter, and retrieve emails
  • Batch operations - Delete multiple messages efficiently
  • Mail merge - Send templated emails using Google Sheets data
  • Label management - List and manage Gmail labels

Quick Start

import (
    "context"
    "net/http"
    "github.com/grokify/gogoogle/gmailutil/v1"
)

// Create Gmail service
func getGmailService(ctx context.Context, httpClient *http.Client) (*gmailutil.GmailService, error) {
    return gmailutil.NewGmailService(ctx, httpClient)
}

Sending Emails

The simplest way to send emails:

_, err := service.SendSimple(ctx, "me", gmailutil.SendSimpleOpts{
    To:       "recipient@example.com",
    Subject:  "Hello",
    BodyText: "Plain text body",
    BodyHTML: "<p>HTML body</p>",  // Optional
    ReplyTo:  "replies@example.com", // Optional
})

Send with MessageWriter

For more control over email composition:

import "github.com/grokify/mogo/net/mailutil"

msg := mailutil.MessageWriter{
    To:      mailutil.Addresses{{Address: "recipient@example.com"}},
    Subject: "Hello",
    // ... additional fields
}

_, err := service.Send(ctx, "me", msg)

Reading Messages

List Messages

messages, err := service.MessagesAPI.GetMessagesList(gmailutil.MessagesListOpts{
    UserID:   "me",
    LabelIDs: []string{"INBOX"},
    MaxResults: 100,
})

Filter by Sender

messages, err := service.MessagesAPI.GetMessagesFrom("sender@example.com")

Filter by Category

// Categories: FORUMS, PROMOTIONS, SOCIAL, UPDATES
messages, err := service.MessagesAPI.GetMessagesByCategory("me", "PROMOTIONS", true)

Batch Operations

Delete Messages

messageIDs := []string{"msg1", "msg2", "msg3"}
err := service.MessagesAPI.BatchDeleteMessages("me", messageIDs)

Delete by Sender

senders := []string{"spam@example.com", "unwanted@example.com"}
err := service.MessagesAPI.DeleteMessagesFrom(senders)

OAuth Scopes

Scope Constant Description
Send only GmailSendScope Send emails
Read only GmailReadonlyScope Read emails
Modify GmailModifyScope Read, send, delete
Full access GmailScope All operations 
import "github.com/grokify/gogoogle/gmailutil/v1"

// For sending only
scopes := []string{gmailutil.GmailSendScope}

// For full access
scopes := []string{gmailutil.GmailScope}

Next Steps