imapclient: add AUTHENTICATE example

emersion · Aug 28, 2023 · 38838c5 · 38838c5
1 parent f750572
commit 38838c5
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/imapclient/client_test.go b/imapclient/client_test.go
@@ -5,6 +5,8 @@ import (
 	"log"
 	"time"
 
+	"github.com/emersion/go-sasl"
+
 	"github.com/emersion/go-imap/v2"
 	"github.com/emersion/go-imap/v2/imapclient"
 )
@@ -257,3 +259,23 @@ func ExampleClient_Idle() {
 		log.Fatalf("failed to stop idling: %v", err)
 	}
 }
+
+func ExampleClient_Authenticate_oauth() {
+	var (
+		c        *imapclient.Client
+		username string
+		token    string
+	)
+
+	if !c.Caps().Has(imap.AuthCap(sasl.OAuthBearer)) {
+		log.Fatal("OAUTHBEARER not supported by the server")
+	}
+
+	saslClient := sasl.NewOAuthBearerClient(&sasl.OAuthBearerOptions{
+		Username: username,
+		Token:    token,
+	})
+	if err := c.Authenticate(saslClient); err != nil {
+		log.Fatalf("authentication failed: %v", err)
+	}
+}