PapercutSMTP
PapercutSMTP
Since v0.44.0
Introduction
The Testcontainers module for Papercut SMTP, a lightweight SMTP server with a built-in web UI for capturing and inspecting outbound emails during testing. No messages are relayed to real recipients — all sent mail is held in memory and viewable through the web interface.
Adding this module to your project dependencies
Please run the following command to add the PapercutSMTP module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/papercutsmtpUsage example
Creating a PapercutSMTP container
ctx := context.Background()
papercutsmtpContainer, err := papercutsmtp.Run(ctx, "changemakerstudiosus/papercut-smtp:latest")
defer func() {
if err := testcontainers.TerminateContainer(papercutsmtpContainer); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to start container: %s", err)
return
}Module Reference
Run function
- Since v0.44.0
The PapercutSMTP module exposes one entrypoint function to create the PapercutSMTP container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, 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(), "changemakerstudiosus/papercut-smtp:latest").
Container Options
When starting the PapercutSMTP container, you can pass options in a variadic way to configure it.
The following options are exposed by the testcontainers package.
Basic Options
WithExposedPortsSince v0.37.0WithEnvSince v0.29.0WithWaitStrategySince v0.20.0WithAdditionalWaitStrategySince v0.38.0WithWaitStrategyAndDeadlineSince v0.20.0WithAdditionalWaitStrategyAndDeadlineSince v0.38.0WithEntrypointSince v0.37.0WithEntrypointArgsSince v0.37.0WithCmdSince v0.37.0WithCmdArgsSince v0.37.0WithLabelsSince v0.37.0
Lifecycle Options
WithLifecycleHooksSince v0.38.0WithAdditionalLifecycleHooksSince v0.38.0WithStartupCommandSince v0.25.0WithAfterReadyCommandSince v0.28.0
Files & Mounts Options
WithFilesSince v0.37.0WithMountsSince v0.37.0WithTmpfsSince v0.37.0WithImageMountSince v0.37.0
Build Options
WithDockerfileSince v0.37.0
Logging Options
WithLogConsumersSince v0.28.0WithLogConsumerConfigSince v0.38.0WithLoggerSince v0.29.0
Image Options
WithAlwaysPullSince v0.38.0WithImageSubstitutorsSince v0.26.0WithImagePlatformSince v0.38.0
Networking Options
WithNetworkSince v0.27.0WithNetworkByNameSince v0.38.0WithBridgeNetworkSince v0.38.0WithNewNetworkSince v0.27.0
Advanced Options
WithHostPortAccessSince v0.31.0WithConfigModifierSince v0.20.0 · Chainable since mainWithHostConfigModifierSince v0.20.0 · Chainable since mainWithEndpointSettingsModifierSince v0.20.0 · Chainable since mainCustomizeRequestSince v0.20.0WithNameSince v0.38.0WithNoStartSince v0.38.0WithProviderSince v0.39.0
Experimental Options
WithReuseByNameSince v0.37.0
Container Methods
The PapercutSMTP container exposes the following methods:
SMTPEndpoint
- Since v0.44.0
This method returns the host:port endpoint to connect to the SMTP server on port 2525.
Get SMTP endpoint
smtpEndpoint, err := ctr.SMTPEndpoint(ctx)HTTPURL
- Since v0.44.0
This method returns the URL for the Papercut SMTP web UI on port 8080, where captured emails can be inspected.
Get HTTP URL
httpURL, err := ctr.HTTPURL(ctx)评论
登录后参与评论
KnowForge