Inbucket¶

Introduction¶

The Testcontainers module for Inbucket.

Adding this module to your project dependencies¶

Please run the following command to add the Inbucket module to your Go dependencies:

go get github.com/testcontainers/testcontainers-go/modules/inbucket

Usage example¶

Creating an Inbucket container

ctx := context.Background()

inbucketContainer, err := inbucket.Run(ctx, "inbucket/inbucket:sha-2d409bb")
defer func() {
    if err := testcontainers.TerminateContainer(inbucketContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

Send and list messages with the Inbucket client¶

Install the client used by this example:

go get github.com/inbucket/[email protected]+incompatible

The example lists an empty mailbox, delivers a message over SMTP, and lists the mailbox again.

Send and list messages

ctx := context.Background()
ctr, err := inbucket.Run(ctx, "inbucket/inbucket:sha-2d409bb")
defer func() {
    if err := testcontainers.TerminateContainer(ctr); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

smtpURL, err := ctr.SmtpConnection(ctx)
if err != nil {
    log.Printf("failed to get SMTP connection: %s", err)
    return
}
webURL, err := ctr.WebInterface(ctx)
if err != nil {
    log.Printf("failed to get web interface: %s", err)
    return
}
restClient, err := client.New(webURL)
if err != nil {
    log.Printf("failed to create Inbucket client: %s", err)
    return
}

headers, err := restClient.ListMailbox("[email protected]")
if err != nil {
    log.Printf("failed to list empty mailbox: %s", err)
    return
}
fmt.Printf("Messages before delivery: %d\n", len(headers))

msg := []byte("To: [email protected]\r\n" +
    "Subject: Testcontainers test!\r\n" +
    "\r\n" +
    "This is a Testcontainers test.\r\n")
if err := smtp.SendMail(smtpURL, nil, "[email protected]", []string{"[email protected]"}, msg); err != nil {
    log.Printf("failed to send message: %s", err)
    return
}
headers, err = restClient.ListMailbox("[email protected]")
if err != nil {
    log.Printf("failed to list mailbox after delivery: %s", err)
    return
}
fmt.Printf("Messages after delivery: %d\n", len(headers))

Module Reference¶

Run function¶

Since v0.32.0

Info

The RunContainer(ctx, opts...) function is deprecated and will be removed in the next major release of Testcontainers for Go.

The Inbucket module exposes one entrypoint function to create the Inbucket container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*InbucketContainer, error)

context.Context, the Go context.
string, the Docker image to use.
testcontainers.ContainerCustomizer, a variadic argument for passing options.

Image¶

Use the second argument in the Run function to set a valid Docker image. In example: Run(context.Background(), "inbucket/inbucket:sha-2d409bb").

Container Options¶

When starting the Inbucket container, you can pass options in a variadic way to configure it.

The following options are exposed by the testcontainers package.

Basic Options¶

WithExposedPorts Since v0.37.0
WithEnv Since v0.29.0
WithWaitStrategy Since v0.20.0
WithAdditionalWaitStrategy Since v0.38.0
WithWaitStrategyAndDeadline Since v0.20.0
WithAdditionalWaitStrategyAndDeadline Since v0.38.0
WithEntrypoint Since v0.37.0
WithEntrypointArgs Since v0.37.0
WithCmd Since v0.37.0
WithCmdArgs Since v0.37.0
WithLabels Since v0.37.0

Lifecycle Options¶

WithLifecycleHooks Since v0.38.0
WithAdditionalLifecycleHooks Since v0.38.0
WithStartupCommand Since v0.25.0
WithAfterReadyCommand Since v0.28.0

Files & Mounts Options¶

Build Options¶

WithDockerfile Since v0.37.0

Logging Options¶

Image Options¶

Networking Options¶

Advanced Options¶

WithHostPortAccess Since v0.31.0
WithConfigModifier Since v0.20.0 · Chainable since main
WithHostConfigModifier Since v0.20.0 · Chainable since main
WithEndpointSettingsModifier Since v0.20.0 · Chainable since main
CustomizeRequest Since v0.20.0
WithName Since v0.38.0
WithNoStart Since v0.38.0
WithProvider Since v0.39.0

Experimental Options¶

WithReuseByName Since v0.37.0

Container Methods¶

The Inbucket container exposes the following methods:

SmtpConnection¶

Since v0.28.0

This method returns the connection string to connect to the Inbucket container SMTP service, using the 2500 port.

Get smtp connection string

smtpURL, err := ctr.SmtpConnection(ctx)

WebInterface¶

Since v0.28.0

This method returns the connection string to connect to the Inbucket container web interface, using the 9000 port.

Get web interface connection string

webInterfaceURL, err := ctr.WebInterface(ctx)