package
1.23.1
Repository: https://github.com/axllent/mailpit.git
Documentation: pkg.go.dev

# Functions

DBTenantID converts a tenant ID to a DB-friendly value if set.
VerifyConfig wil do some basic checking.

# Variables

AllowUntrustedTLS allows untrusted HTTPS connections link checking & screenshot generation.
BlockRemoteCSSAndFonts used to disable remote CSS & fonts.
ChaosTriggers are parsed and set in the chaos module.
CLITagsArg is used to map the CLI args.
Compression is the compression level used to store raw messages in the database: 0 = off, 1 = fastest (default), 2 = standard, 3 = best compression.
ContentSecurityPolicy for HTTP server - set via VerifyConfig().
Database for mail (optional).
DemoMode disables SMTP relay, link checking & HTTP send functionality.
DisableHTMLCheck DEPRECATED 2024/04/13 - kept here to display console warning only.
DisableHTTPCompression will explicitly disable HTTP compression in the web UI and API.
DisableWAL will disable Write-Ahead Logging in SQLite @see https://sqlite.org/wal.html.
EnableSpamAssassin must be either <host>:<port> or "postmark".
HTTPListen to listen on <interface>:<port>.
IgnoreDuplicateIDs will skip messages with the same ID.
Label to identify this Mailpit instance (optional).
MaxAge is the maximum age of messages (auto-pruned every hour).
MaxAgeInHours is the maximum age of messages in hours, set with parseMaxAge() using MaxAge value.
MaxMessages is the maximum number of messages a mailbox can have (auto-pruned every minute).
POP3AuthFile for POP3 authentication.
POP3Listen address - if set then Mailpit will start the POP3 server and listen on this address.
POP3TLSCert TLS certificate.
POP3TLSKey TLS certificate key.
ReleaseEnabled is whether message releases are enabled, requires a valid SMTPRelayConfigFile.
Repo on Github for updater.
RepoBinaryName on Github for updater.
SMTPAllowedRecipients if set, will only accept recipients matching this regular expression.
SMTPAllowedRecipientsRegexp is the compiled version of SMTPAllowedRecipients.
SMTPAuthAcceptAny accepts any username/password including none.
SMTPAuthAllowInsecure allows PLAIN & LOGIN unencrypted authentication.
SMTPAuthFile for SMTP authentication.
SMTPForwardConfig to parse a yaml file and store config of the forwarding SMTP server.
SMTPForwardConfigFile to parse a yaml file and store config of the forwarding SMTP server.
SMTPListen to listen on <interface>:<port>.
SMTPMaxRecipients is the maximum number of recipients a message may have.
SMTPRelayAll is whether to relay all incoming messages via pre-configured SMTP server.
SMTPRelayConfig to parse a yaml file and store config of the the relay SMTP server.
SMTPRelayConfigFile to parse a yaml file and store config of the relay SMTP server.
SMTPRelayMatching if set, will auto-release to recipients matching this regular expression.
SMTPRelayMatchingRegexp is the compiled version of SMTPRelayMatching.
SMTPRequireSTARTTLS to enforce the use of STARTTLS The only allowed commands are NOOP, EHLO, STARTTLS and QUIT (as specified in RFC 3207) until the connection is upgraded to TLS i.e.
SMTPRequireTLS to allow only SSL/TLS connections for all connections .
SMTPStrictRFCHeaders will return an error if the email headers contain <CR><CR><LF> (\r\r\n) @see https://github.com/axllent/mailpit/issues/87 & https://github.com/axllent/mailpit/issues/153.
SMTPTLSCert file.
SMTPTLSKey file.
TagFilters are used to apply tags to new mail.
TagsConfig is a yaml file to pre-load tags.
TagsDisable accepts a comma-separated list of tag types to disable including x-tags & plus-addresses.
TagsDisablePlus disables message tagging using plus-addresses ([email protected]) - set via verifyConfig().
TagsDisableXTags disables message tagging via the X-Tags header - set via verifyConfig().
TenantID is an optional prefix to be applied to all database tables, allowing multiple isolated instances of Mailpit to share a database.
UIAuthFile for UI & API authentication.
UITLSCert file.
UITLSKey file.
UseMessageDates sets the Created date using the message date, not the delivered date.
ValidTagRegexp represents a valid tag.
Version is the default application version, updated on release.
WebhookURL for calling.
Webroot to define the base path for the UI and API.

# Structs

SMTPForwardConfigStruct struct for parsing yaml & storing variables.
SMTPRelayConfigStruct struct for parsing yaml & storing variables.