Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

PostaResource

Handle
📦 CommunityToolkit.Aspire.Hosting.Posta v13.6.1

Resource for the Posta email delivery platform.

type PostaResource interface {
ExpressionValue
IComputeResource
Resource
ResourceWithArgs
ResourceWithConnectionString
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyAdminPasswordParameterParameterResourceget
Gets the parameter that contains the initial admin password.
AdminPasswordParameter() ParameterResource
propertyConnectionStringExpression*ReferenceExpressionget
Connection string for the Posta HTTP API in the form of Endpoint=http://host:port.
ConnectionStringExpression() *ReferenceExpression
propertyHostEndpointReferenceExpressionget
Gets the host endpoint reference for the HTTP endpoint.
Host() EndpointReferenceExpression
propertyJwtSecretParameterParameterResourceget
Gets the parameter that contains the JWT signing secret.
JwtSecretParameter() ParameterResource
propertyPortEndpointReferenceExpressionget
Gets the port endpoint reference for the HTTP endpoint.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the primary HTTP endpoint for the Posta server.
PrimaryEndpoint() EndpointReference
propertySmtpEndpointEndpointReferenceget
Gets the inbound SMTP endpoint for the Posta server.
SmtpEndpoint() EndpointReference
propertySmtpRelayEndpointEndpointReferenceget
Gets the authenticated SMTP relay endpoint for the Posta server.
SmtpRelayEndpoint() EndpointReference
propertyUriExpression*ReferenceExpressionget
Gets the connection URI expression for the Posta HTTP API.
UriExpression() *ReferenceExpression

Methods

methodWithDataBindMountbuilder
Adds a bind mount for Posta's filesystem-backed attachment data.
WithDataBindMount(
source string,
options ...*WithDataBindMountOptions,
) PostaResource
sourcestringThe source directory on the host to mount into the container.
options...*WithDataBindMountOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataBindMountOptions argument.

IsReadOnly*boolIndicates whether the bind mount should be read-only.
PostaResource

A reference to the IResourceBuilder for further resource configuration.

Returns a handle; failures surface later via Err().

methodWithDataVolumebuilder
Adds a named volume for Posta's filesystem-backed attachment data.
WithDataVolume(options ...*WithDataVolumeOptions) PostaResource
options...*WithDataVolumeOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataVolumeOptions argument.

Name*stringThe name of the volume. Defaults to an auto-generated name based on the application and resource names.
IsReadOnly*boolIndicates whether the volume should be read-only.
PostaResource

A reference to the IResourceBuilder for further resource configuration.

Returns a handle; failures surface later via Err().

Configures the PostgreSQL database used by Posta.
WithPostgresReference(database PostgresDatabaseResource) PostaResource
databasePostgresDatabaseResourceThe PostgreSQL database resource used by Posta.
PostaResource

A reference to the IResourceBuilder for further resource configuration.

Returns a handle; failures surface later via Err().

methodWithRedisReferencebuilder
Configures the Redis server used by Posta.
WithRedisReference(
redis RedisResource,
options ...*WithRedisReferenceOptions,
) PostaResource
redisRedisResourceThe Redis resource used by Posta.
options...*WithRedisReferenceOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithRedisReferenceOptions argument.

RedisPassword*ParameterResourceOptional Redis password parameter that overrides the referenced Redis resource password.
PostaResource

A reference to the IResourceBuilder for further resource configuration.

Returns a handle; failures surface later via Err().