PostaOptions

Classsealednet10.0

📦 CommunityToolkit.Aspire.Hosting.Posta v13.5.0

Configuration options for the Posta container.

namespace CommunityToolkit.Aspire.Hosting.Posta;

public sealed class PostaOptions
{
    // ...
}

72 members

Constructors1

PostaOptions

View all constructors

Properties71

AllowDowngradeget; set

bool

Gets or sets a value indicating whether older binaries can boot against a newer database schema.

ApiUrlget; set

string?

Gets or sets the public API base URL advertised in the OpenAPI servers list.

AuthRateLimitEnabledget; set

bool

Gets or sets a value indicating whether auth rate limiting is enabled.

AutoSuppressOnRejectget; set

bool

Gets or sets a value indicating whether permanently rejected recipients are added to the suppression list.

BlobFileSystemPathget; set

string

Gets or sets the filesystem storage path.

BlobProviderget; set

string?

Gets or sets the storage backend for attachments, either s3 or filesystem.

BlobS3AccessKeyget; set

IResourceBuilder<ParameterResource>

Gets or sets the S3 access key.

BlobS3Bucketget; set

string?

Gets or sets the S3 bucket name.

BlobS3Endpointget; set

string?

Gets or sets the S3-compatible endpoint.

BlobS3PathStyleget; set

bool

Gets or sets a value indicating whether S3 path-style addressing is used.

BlobS3Regionget; set

string

Gets or sets the S3 region.

BlobS3SecretKeyget; set

IResourceBuilder<ParameterResource>

Gets or sets the S3 secret key.

BlobS3UseSslget; set

bool

Gets or sets a value indicating whether S3 storage uses TLS.

CorsOriginsget; set

string

Gets or sets the comma-separated allowed CORS origins.

DatabaseUrlget; set

IResourceBuilder<ParameterResource>

Gets or sets a PostgreSQL connection string parameter that overrides individual database settings.

DevModeget; set

bool

Gets or sets a value indicating whether Posta stores emails without sending them.

EmailVerificationRequiredget; set

bool

Gets or sets a value indicating whether users must verify their email address before sign-in.

EmailVerifyCacheTtlHoursget; set

int

Gets or sets how long address-level verification results are cached, in hours.

EmailVerifyEnabledget; set

bool

Gets or sets a value indicating whether the email verification endpoint is enabled.

EmailVerifyMxCacheTtlHoursget; set

int

Gets or sets how long domain MX lookups are cached, in hours.

EmailVerifyRateHourlyget; set

int

Gets or sets the per-user hourly cap on verification requests.

EmbeddedWorkerget; set

bool

Gets or sets a value indicating whether the worker runs in the server process.

EncryptionKeyget; set

IResourceBuilder<ParameterResource>

Gets or sets the AES-256-GCM encryption key for stored SMTP passwords.

Environmentget; set

string

Gets or sets the Posta environment name.

GoogleOAuthClientIdget; set

string?

Gets or sets the Google OAuth client ID for SSO login.

GoogleOAuthClientSecretget; set

IResourceBuilder<ParameterResource>

Gets or sets the Google OAuth client secret for SSO login.

InboundEnabledget; set

bool

Gets or sets a value indicating whether inbound email processing is enabled.

InboundHostnameget; set

string

Gets or sets the hostname announced in EHLO and used as TLS SNI.

InboundMaxAttachSizeget; set

int

Gets or sets the maximum inbound attachment size in bytes.

InboundMaxMessageSizeget; set

int

Gets or sets the maximum raw inbound message size in bytes.

InboundSmtpHostget; set

string

Gets or sets the bind address for the built-in SMTP receiver.

InboundSmtpPortget; set

int

Gets or sets the SMTP listener port.

InboundSmtpRateLimitget; set

int

Gets or sets the per-IP SMTP session rate limit.

InboundSmtpRateWindowget; set

int

Gets or sets the SMTP rate-limit window in seconds.

InboundTlsCertFileget; set

string?

Gets or sets the PEM certificate path for inbound TLS.

InboundTlsKeyFileget; set

string?

Gets or sets the PEM key path for inbound TLS.

InboundTlsModeget; set

string

Gets or sets the inbound SMTP TLS mode: none or starttls.

InboundWebhookSecretget; set

IResourceBuilder<ParameterResource>

Gets or sets the shared secret for inbound webhooks.

MetricsEnabledget; set

bool

Gets or sets a value indicating whether Prometheus metrics are enabled.

OAuthCallbackUrlget; set

string?

Gets or sets the OAuth callback base URL.

OpenApiDocsget; set

bool

Gets or sets a value indicating whether Swagger UI and ReDoc are enabled.

PlanEnforcementget; set

bool

Gets or sets a value indicating whether hosted plan limits and quotas are enforced.

RateLimitDailyget; set

int

Gets or sets the maximum emails per day per user.

RateLimitHourlyget; set

int

Gets or sets the maximum emails per hour per user.

RedisAddressget; set

string?

Gets or sets an external Redis address in the form host:port.

RedisDatabaseget; set

int

Gets or sets the Redis database number.

RedisPasswordget; set

IResourceBuilder<ParameterResource>

Gets or sets a Redis password parameter that overrides the referenced Redis resource password.

RedisUrlget; set

IResourceBuilder<ParameterResource>

Gets or sets a Redis URL that overrides individual Redis settings.

RedisUsernameget; set

string?

Gets or sets the Redis username.

SmtpRelayEnabledget; set

bool

Gets or sets whether the authenticated SMTP relay is enabled.

SmtpRelayHostget; set

string

Gets or sets the SMTP relay bind address.

SmtpRelayHostnameget; set

string

Gets or sets the hostname announced by the SMTP relay.

SmtpRelayMaxMessageSizeget; set

int

Gets or sets the SMTP relay maximum message size in bytes.

SmtpRelayPortget; set

int

Gets or sets the SMTP relay listener port.

SmtpRelayRateLimitget; set

int

Gets or sets the SMTP relay per-IP session rate limit.

SmtpRelayRateWindowget; set

int

Gets or sets the SMTP relay rate-limit window in seconds.

SystemSmtpEncryptionget; set

string

Gets or sets the system SMTP encryption mode: none, ssl, or starttls.

SystemSmtpFromget; set

string?

Gets or sets the system SMTP from address.

SystemSmtpHostget; set

string?

Gets or sets the system SMTP server host used for platform notifications.

SystemSmtpPasswordget; set

IResourceBuilder<ParameterResource>

Gets or sets the system SMTP password.

SystemSmtpPortget; set

int

Gets or sets the system SMTP server port.

SystemSmtpUsernameget; set

string?

Gets or sets the system SMTP username.

UpdateCheckget; set

bool

Gets or sets whether Posta checks GitHub for new releases.

WebDirget; set

string?

Gets or sets the Vue dashboard build directory.

WebhookMaxRetriesget; set

int

Gets or sets the maximum webhook delivery retry attempts.

WebhookProxyUrlget; set

string?

Gets or sets the optional HTTP, HTTPS, or SOCKS5 proxy for webhook delivery.

WebhookTimeoutSecondsget; set

int

Gets or sets the webhook HTTP request timeout in seconds.

WebUrlget; set

string?

Gets or sets the public dashboard URL.

WorkerConcurrencyget; set

int

Gets or sets the number of worker goroutines.

WorkerMaxRetriesget; set

int

Gets or sets the maximum email retry attempts.

WorkspaceOnlyModeget; set

bool

Gets or sets whether users must operate within workspaces.

View all properties