Skip to main content

Email

For all email based communication (e.g. for workspace registration or workspace user invitations) meshStack will use the configured SMTP server.

Tip for enterprise meshStacks: you can configure a custom e-mail footer by creating an object in the messages configuration below using mapKey mail.footer. Any valid HTML can be set as a value here. Contact your customer success team to get it set up.

The following configuration options are available at mesh.meshfed.mail:

{-
    The configured smtp mail server is used by meshfed to
    send out notifications.

    enabled:
        If True, meshfed will send out mails.

    username:
        Username meshfed uses to log in at SMTP server.

    password:
        Password meshfed uses to log in at SMTP server.

    host:
        SMTP server address that meshfed connects to.

    port:
        The port that the SMTP server listens on.

    sender:
        address:
            Address that is shown as "sender"
        reply-to:
            Address that is shown as "replyTo"

    smtp:
        ssl:
            If True, enables SSL encryption (must be supported by SMTP server)

        starttls:
            If True, enables STARTTLS encryption (must be supported by SMTP server)

        auth:
            If True, enables authentication (must be supported by SMTP server)

    theme:
        logo:
            href:
                Location of the logo file

            url:
                Url that the image links to

        button-color:
            Color hex code for buttons

        messages:
            List of mappings to configure template messages

-}
  { enabled : Bool
  , username : Text
  , host : Text
  , port : Natural
  , sender : { address : Text, reply-to : Optional Text }
  , smtp :
      { ssl : { enable : Bool }, starttls : { enable : Bool }, auth : Bool }
  , theme : { logo : { href : Text, url : Text }, button-color : Text }
  , messages : List { mapKey : Text, mapValue : Text }
  }

FAQ​

Which mails is meshStack sending out and to whom?​

Application Team receive mails when

  • Workspace created
  • Workspace permissions created, updated or removed
  • Project permissions created, updated or removed
  • Project Payment Method Assignment missing
  • Budget exceeded
  • Executing Building Block succeeded

Platform engineers receive mails when

  • Building Block requires input (Recipients are defined per Building Block definition)

Optionally meshStack sends out mails to fixed set of recipients configured in dhall when

  • Tenant marked for deletion
  • Tenant created
  • Replication failed

Can the style of the mails be influenced? For example via HTML?​

Button color and logo are configurable. The theme.messages templates support HTML elements like <br>.

Can BCC be added​

No. meshStack does not support adding addresses on BCC.