Skip to main content

Interface: MailConfig

Email notification configuration for customer communications.

MailConfig defines the visual styling, content, and behavior for email notifications sent from the system on behalf of the customer. These settings enable branded, customized email communications that maintain the customer's visual identity and messaging voice.

Well-designed email notifications extend the customer's brand experience beyond the configurator, creating a cohesive journey from configuration to purchase confirmation and follow-up communications.

Properties​

contactUrl?​

optional contactUrl: string

URL to the customer's contact page or form.

When specified, this URL is included in emails to provide recipients with a direct way to ask questions or request support regarding their order or configuration.

content​

content: object

Content templates for different sections of notification emails.

These templates define the text and formatting for various parts of email notifications, enabling consistent messaging while allowing customization of the specific wording and tone to match the customer's communication style.

body?​

optional body: string

Main email body text template.

This template defines the primary content section of the email. The body typically contains detailed information about the submission along with any necessary instructions or next steps.

button?​

optional button: string

Call-to-action button text template.

This template defines the text that appears on the primary action button in the email (such as "View Order" or "Review Quote"). Clear action verbs improve click-through rates.

exitText?​

optional exitText: string

Text for the exit or closing section.

This template defines text that appears near the end of the email, typically containing follow-up information, contact details, or other concluding messaging.

optional footer: string

Email footer text template.

This template defines the text that appears at the bottom of the email. Footers typically contain legal information, unsubscribe options, and company contact details as required by email regulations.

optional header: string

Email header text template.

This template defines the introductory text that appears at the top of the email body. The header typically introduces the purpose of the email and sets expectations for what follows.

subject?​

optional subject: string

Email subject line template.

This template defines the subject line format for notification emails. A clear, specific subject line improves open rates and helps recipients quickly understand the email's purpose.

logoS3Path​

logoS3Path: string

Relative path to the customer's logo image for email headers.

This path points to the image that appears in the header of email notifications, establishing visual brand recognition. For best results, this should be a high-resolution version of the customer's logo optimized for email display.

submissionDisplayName​

submissionDisplayName: Translatable<string>

Display name for submissions in different languages.

This multilingual label identifies what type of submission the email is confirming, such as "Quote Request" or "Order Submission." Using translated labels ensures clear communication in the recipient's preferred language.

viewOnlineUrl?​

optional viewOnlineUrl: string

URL for viewing the submission details online.

When specified, this URL directs recipients to a web page where they can view the full details of their submission. This is particularly useful for complex configurations that benefit from interactive visualization.

websiteUrl?​

optional websiteUrl: string

URL to the customer's main website.

When specified, this URL is included in emails to direct recipients to the customer's website for more information. This creates continuity between email notifications and the customer's web presence.