Skip to content
VaultSandbox

Go Client

The official Go SDK for VaultSandbox Gateway. It handles quantum-safe encryption automatically, letting you focus on testing email workflows.

Key Capabilities

Section titled “Key Capabilities”
  • Automatic Encryption: ML-KEM-768 key encapsulation + AES-256-GCM encryption handled transparently
  • Real-Time Delivery: SSE-based email delivery with smart polling fallback
  • Flexible Waiting: Wait for single emails, multiple emails, or watch via channels
  • Email Authentication: Built-in SPF/DKIM/DMARC validation helpers
  • Full Email Access: Decrypted content, headers, links, and attachments
  • Idiomatic Go: Context-based cancellation, functional options, and proper error handling

Requirements

Section titled “Requirements”
  • Go 1.24+
  • VaultSandbox Gateway server
  • Valid API key

Gateway Server

Section titled “Gateway Server”

The SDK connects to a VaultSandbox Gateway - a receive-only SMTP server you self-host. It handles email reception, authentication validation, and encryption. You can run one with Docker in minutes.

See Gateway Overview or jump to Quick Start to deploy one.

Quick Example

Section titled “Quick Example”
package main


import (
  "context"
  "fmt"
  "log"
  "time"


  "github.com/vaultsandbox/client-go"
)


func main() {
  client, err := vaultsandbox.New("your-api-key",
    vaultsandbox.WithBaseURL("https://gateway.example.com"),
  )
  if err != nil {
    log.Fatal(err)
  }
  defer client.Close()


  ctx := context.Background()


  // Create inbox (keypair generated automatically)
  inbox, err := client.CreateInbox(ctx)
  if err != nil {
    log.Fatal(err)
  }


  // Send email to inbox.EmailAddress() from your application...


  // Wait for email
  email, err := inbox.WaitForEmail(ctx,
    vaultsandbox.WithWaitTimeout(30*time.Second),
  )
  if err != nil {
    log.Fatal(err)
  }


  fmt.Println("Subject:", email.Subject)
  fmt.Println("Text:", email.Text)


  // Cleanup
  if err := inbox.Delete(ctx); err != nil {
    log.Fatal(err)
  }
}
Section titled “Links”

Next Steps

Section titled “Next Steps”