Skip to content
DocsTry Aspire
DocsTry

PostaOptions Properties

ClassProperties71 members
Configuration options for the Posta container.
Gets or sets a value indicating whether older binaries can boot against a newer database schema.
public bool AllowDowngrade { get; set; }
ApiUrlSection titled ApiUrlnullablestring?
Gets or sets the public API base URL advertised in the OpenAPI servers list.
public string? ApiUrl { get; set; }
AuthRateLimitEnabledSection titled AuthRateLimitEnabledbool
Gets or sets a value indicating whether auth rate limiting is enabled.
public bool AuthRateLimitEnabled { get; set; }
AutoSuppressOnRejectSection titled AutoSuppressOnRejectbool
Gets or sets a value indicating whether permanently rejected recipients are added to the suppression list.
public bool AutoSuppressOnReject { get; set; }
BlobFileSystemPathSection titled BlobFileSystemPathstring
Gets or sets the filesystem storage path.
public string BlobFileSystemPath { get; set; }
BlobProviderSection titled BlobProvidernullablestring?
Gets or sets the storage backend for attachments, either s3 or filesystem.
public string? BlobProvider { get; set; }
BlobS3AccessKeySection titled BlobS3AccessKeynullableIResourceBuilder<ParameterResource>
Gets or sets the S3 access key.
public IResourceBuilder<ParameterResource>? BlobS3AccessKey { get; set; }
BlobS3BucketSection titled BlobS3Bucketnullablestring?
Gets or sets the S3 bucket name.
public string? BlobS3Bucket { get; set; }
BlobS3EndpointSection titled BlobS3Endpointnullablestring?
Gets or sets the S3-compatible endpoint.
public string? BlobS3Endpoint { get; set; }
Gets or sets a value indicating whether S3 path-style addressing is used.
public bool BlobS3PathStyle { get; set; }
BlobS3RegionSection titled BlobS3Regionstring
Gets or sets the S3 region.
public string BlobS3Region { get; set; }
BlobS3SecretKeySection titled BlobS3SecretKeynullableIResourceBuilder<ParameterResource>
Gets or sets the S3 secret key.
public IResourceBuilder<ParameterResource>? BlobS3SecretKey { get; set; }
Gets or sets a value indicating whether S3 storage uses TLS.
public bool BlobS3UseSsl { get; set; }
Gets or sets the comma-separated allowed CORS origins.
public string CorsOrigins { get; set; }
DatabaseUrlSection titled DatabaseUrlnullableIResourceBuilder<ParameterResource>
Gets or sets a PostgreSQL connection string parameter that overrides individual database settings.
public IResourceBuilder<ParameterResource>? DatabaseUrl { get; set; }
Gets or sets a value indicating whether Posta stores emails without sending them.
public bool DevMode { get; set; }
EmailVerificationRequiredSection titled EmailVerificationRequiredbool
Gets or sets a value indicating whether users must verify their email address before sign-in.
public bool EmailVerificationRequired { get; set; }
EmailVerifyCacheTtlHoursSection titled EmailVerifyCacheTtlHoursint
Gets or sets how long address-level verification results are cached, in hours.
public int EmailVerifyCacheTtlHours { get; set; }
EmailVerifyEnabledSection titled EmailVerifyEnabledbool
Gets or sets a value indicating whether the email verification endpoint is enabled.
public bool EmailVerifyEnabled { get; set; }
EmailVerifyMxCacheTtlHoursSection titled EmailVerifyMxCacheTtlHoursint
Gets or sets how long domain MX lookups are cached, in hours.
public int EmailVerifyMxCacheTtlHours { get; set; }
EmailVerifyRateHourlySection titled EmailVerifyRateHourlyint
Gets or sets the per-user hourly cap on verification requests.
public int EmailVerifyRateHourly { get; set; }
Gets or sets a value indicating whether the worker runs in the server process.
public bool EmbeddedWorker { get; set; }
EncryptionKeySection titled EncryptionKeynullableIResourceBuilder<ParameterResource>
Gets or sets the AES-256-GCM encryption key for stored SMTP passwords.
public IResourceBuilder<ParameterResource>? EncryptionKey { get; set; }
Gets or sets the Posta environment name.
public string Environment { get; set; }
GoogleOAuthClientIdSection titled GoogleOAuthClientIdnullablestring?
Gets or sets the Google OAuth client ID for SSO login.
public string? GoogleOAuthClientId { get; set; }
GoogleOAuthClientSecretSection titled GoogleOAuthClientSecretnullableIResourceBuilder<ParameterResource>
Gets or sets the Google OAuth client secret for SSO login.
public IResourceBuilder<ParameterResource>? GoogleOAuthClientSecret { get; set; }
Gets or sets a value indicating whether inbound email processing is enabled.
public bool InboundEnabled { get; set; }
InboundHostnameSection titled InboundHostnamestring
Gets or sets the hostname announced in EHLO and used as TLS SNI.
public string InboundHostname { get; set; }
Gets or sets the maximum inbound attachment size in bytes.
public int InboundMaxAttachSize { get; set; }
InboundMaxMessageSizeSection titled InboundMaxMessageSizeint
Gets or sets the maximum raw inbound message size in bytes.
public int InboundMaxMessageSize { get; set; }
InboundSmtpHostSection titled InboundSmtpHoststring
Gets or sets the bind address for the built-in SMTP receiver.
public string InboundSmtpHost { get; set; }
Gets or sets the SMTP listener port.
public int InboundSmtpPort { get; set; }
Gets or sets the per-IP SMTP session rate limit.
public int InboundSmtpRateLimit { get; set; }
InboundSmtpRateWindowSection titled InboundSmtpRateWindowint
Gets or sets the SMTP rate-limit window in seconds.
public int InboundSmtpRateWindow { get; set; }
InboundTlsCertFileSection titled InboundTlsCertFilenullablestring?
Gets or sets the PEM certificate path for inbound TLS.
public string? InboundTlsCertFile { get; set; }
InboundTlsKeyFileSection titled InboundTlsKeyFilenullablestring?
Gets or sets the PEM key path for inbound TLS.
public string? InboundTlsKeyFile { get; set; }
InboundTlsModeSection titled InboundTlsModestring
Gets or sets the inbound SMTP TLS mode: none or starttls.
public string InboundTlsMode { get; set; }
InboundWebhookSecretSection titled InboundWebhookSecretnullableIResourceBuilder<ParameterResource>
Gets or sets the shared secret for inbound webhooks.
public IResourceBuilder<ParameterResource>? InboundWebhookSecret { get; set; }
Gets or sets a value indicating whether Prometheus metrics are enabled.
public bool MetricsEnabled { get; set; }
OAuthCallbackUrlSection titled OAuthCallbackUrlnullablestring?
Gets or sets the OAuth callback base URL.
public string? OAuthCallbackUrl { get; set; }
Gets or sets a value indicating whether Swagger UI and ReDoc are enabled.
public bool OpenApiDocs { get; set; }
Gets or sets a value indicating whether hosted plan limits and quotas are enforced.
public bool PlanEnforcement { get; set; }
Gets or sets the maximum emails per day per user.
public int RateLimitDaily { get; set; }
Gets or sets the maximum emails per hour per user.
public int RateLimitHourly { get; set; }
RedisAddressSection titled RedisAddressnullablestring?
Gets or sets an external Redis address in the form host:port.
public string? RedisAddress { get; set; }
Gets or sets the Redis database number.
public int RedisDatabase { get; set; }
RedisPasswordSection titled RedisPasswordnullableIResourceBuilder<ParameterResource>
Gets or sets a Redis password parameter that overrides the referenced Redis resource password.
public IResourceBuilder<ParameterResource>? RedisPassword { get; set; }
RedisUrlSection titled RedisUrlnullableIResourceBuilder<ParameterResource>
Gets or sets a Redis URL that overrides individual Redis settings.
public IResourceBuilder<ParameterResource>? RedisUrl { get; set; }
RedisUsernameSection titled RedisUsernamenullablestring?
Gets or sets the Redis username.
public string? RedisUsername { get; set; }
Gets or sets whether the authenticated SMTP relay is enabled.
public bool SmtpRelayEnabled { get; set; }
SmtpRelayHostSection titled SmtpRelayHoststring
Gets or sets the SMTP relay bind address.
public string SmtpRelayHost { get; set; }
SmtpRelayHostnameSection titled SmtpRelayHostnamestring
Gets or sets the hostname announced by the SMTP relay.
public string SmtpRelayHostname { get; set; }
SmtpRelayMaxMessageSizeSection titled SmtpRelayMaxMessageSizeint
Gets or sets the SMTP relay maximum message size in bytes.
public int SmtpRelayMaxMessageSize { get; set; }
Gets or sets the SMTP relay listener port.
public int SmtpRelayPort { get; set; }
Gets or sets the SMTP relay per-IP session rate limit.
public int SmtpRelayRateLimit { get; set; }
Gets or sets the SMTP relay rate-limit window in seconds.
public int SmtpRelayRateWindow { get; set; }
SystemSmtpEncryptionSection titled SystemSmtpEncryptionstring
Gets or sets the system SMTP encryption mode: none, ssl, or starttls.
public string SystemSmtpEncryption { get; set; }
SystemSmtpFromSection titled SystemSmtpFromnullablestring?
Gets or sets the system SMTP from address.
public string? SystemSmtpFrom { get; set; }
SystemSmtpHostSection titled SystemSmtpHostnullablestring?
Gets or sets the system SMTP server host used for platform notifications.
public string? SystemSmtpHost { get; set; }
SystemSmtpPasswordSection titled SystemSmtpPasswordnullableIResourceBuilder<ParameterResource>
Gets or sets the system SMTP password.
public IResourceBuilder<ParameterResource>? SystemSmtpPassword { get; set; }
Gets or sets the system SMTP server port.
public int SystemSmtpPort { get; set; }
SystemSmtpUsernameSection titled SystemSmtpUsernamenullablestring?
Gets or sets the system SMTP username.
public string? SystemSmtpUsername { get; set; }
Gets or sets whether Posta checks GitHub for new releases.
public bool UpdateCheck { get; set; }
WebDirSection titled WebDirnullablestring?
Gets or sets the Vue dashboard build directory.
public string? WebDir { get; set; }
Gets or sets the maximum webhook delivery retry attempts.
public int WebhookMaxRetries { get; set; }
WebhookProxyUrlSection titled WebhookProxyUrlnullablestring?
Gets or sets the optional HTTP, HTTPS, or SOCKS5 proxy for webhook delivery.
public string? WebhookProxyUrl { get; set; }
WebhookTimeoutSecondsSection titled WebhookTimeoutSecondsint
Gets or sets the webhook HTTP request timeout in seconds.
public int WebhookTimeoutSeconds { get; set; }
WebUrlSection titled WebUrlnullablestring?
Gets or sets the public dashboard URL.
public string? WebUrl { get; set; }
Gets or sets the number of worker goroutines.
public int WorkerConcurrency { get; set; }
Gets or sets the maximum email retry attempts.
public int WorkerMaxRetries { get; set; }
Gets or sets whether users must operate within workspaces.
public bool WorkspaceOnlyMode { get; set; }