API Reference
Class Email
Represents an email document with XHTML 1.0 Strict compliance for email clients. This partial class contains configuration-related methods.
Inheritance
- Element
Constructors
Email 3 overloads
public Email(DocumentConfiguration configuration) #Initializes a new instance of the Email class with a configuration delegate.
Parameters
- configure System.Action{HtmlForgeX.Email.DocumentConfiguration}
- Delegate to configure the DocumentConfiguration.
Methods
public Void AddLibrary(EmailLibraries library) #Returns:
VoidAdds a predefined email library.
Parameters
- library HtmlForgeX.Email.EmailLibraries
- Library identifier.
public Email ConfigureImageOptimization(Int32 maxWidth = 800, Int32 maxHeight = 600, Int32 quality = 85) #Returns:
EmailConfigures image optimization settings for this email.
Parameters
- maxWidth System.Int32 = 800
- Maximum width in pixels (default: 800).
- maxHeight System.Int32 = 600
- Maximum height in pixels (default: 600).
- quality System.Int32 = 85
- JPEG quality 0-100 (default: 85).
Returns
The Email object, allowing for method chaining.
ConfigureLayout 3 overloads
public Email ConfigureLayout(String containerPadding = "12px", String contentPadding = "8px", String maxWidth = "600px", String containerPaddingMobile = null) #Returns:
EmailConfigures layout settings for this email using string values.
Parameters
- containerPadding System.String = "12px"
- Container padding (default: "12px").
- contentPadding System.String = "8px"
- Content padding (default: "8px").
- maxWidth System.String = "600px"
- Maximum content width (default: "600px").
- containerPaddingMobile System.String = null
- Mobile container padding (default: value from ContainerPaddingMobile).
Returns
The Email object, allowing for method chaining.
public Email ConfigureLayout(String customMaxWidth, EmailPaddingSize containerPadding = Medium, EmailPaddingSize contentPadding = Small) #Returns:
EmailConfigures layout settings for this email using predefined enum values. Provides easy-to-use presets while maintaining full control.
Parameters
- layoutSize HtmlForgeX.Email.EmailLayoutSize = Standard
- Predefined layout size (default: Standard).
- containerPadding HtmlForgeX.Email.EmailPaddingSize = Medium
- Container padding size (default: Medium).
- contentPadding HtmlForgeX.Email.EmailPaddingSize = Small
- Content padding size (default: Small).
Returns
The Email object, allowing for method chaining.
ConfigureLayout(System.String customMaxWidth, HtmlForgeX.Email.EmailPaddingSize containerPadding, HtmlForgeX.Email.EmailPaddingSize contentPadding) #Configures layout settings with custom width but predefined padding. Perfect for when you know the exact width you want but prefer enum padding.
Parameters
- customMaxWidth System.String
- Custom maximum width (e.g., "750px", "90%").
- containerPadding HtmlForgeX.Email.EmailPaddingSize
- Container padding size (default: Medium).
- contentPadding HtmlForgeX.Email.EmailPaddingSize
- Content padding size (default: Small).
Returns
The Email object, allowing for method chaining.
public Email ConfigureTheme(Action<Theme> configure) #Returns:
EmailConfigures the per-email Theme (surface/text/accent) without writing CSS.
Parameters
- configure System.Action{HtmlForgeX.Email.Theme}
public Email DisableImageEmbedding() #Returns:
EmailDisables automatic image embedding for this email.
Returns
The Email object, allowing for method chaining.
public Email EnableImageEmbedding(Int32 timeout = 30, Boolean optimize = false) #Returns:
EmailEnables automatic image embedding for all images in this email.
Parameters
- timeout System.Int32 = 30
- Timeout in seconds for URL downloads (default: 30).
- optimize System.Boolean = false
- Whether to enable image optimization (default: false).
Returns
The Email object, allowing for method chaining.
public Email EnableInlineImageAttachments(Int32 timeout = 30) #Returns:
EmailEnables automatic image embedding as inline attachments (CID). Use RenderAsync to obtain the HTML + inline resources for your mail library (MimeKit/MailKit, etc.).
Parameters
- timeout System.Int32 = 30
- Timeout in seconds for URL downloads (default: 30).
Returns
The Email object, allowing for method chaining.
EvaluateAllLayouts() #Evaluates layout information for all child elements.
RegisterAllLibraries() #Recursively registers libraries from all elements in the email.
RegisterLibrariesFromElement(HtmlForgeX.Email.Element element) #Recursively registers libraries from an element and all its children.
Parameters
- element HtmlForgeX.Email.Element
- The element to process.
public EmailRenderResult Render() #Returns:
EmailRenderResultRenders the email and returns the HTML plus any inline resources (CID attachments) needed.
public Task<EmailRenderResult> RenderAsync() #Returns:
Task<EmailRenderResult>Renders the email and returns the HTML plus any inline resources (CID attachments) needed.
public Void Save(String path, Boolean openInBrowser = false) #Returns:
VoidSaves the email to disk.
Parameters
- path System.String
- File path.
- openInBrowser System.Boolean = false
- Whether to open the file after saving.
public async Task SaveAsync(String path, Boolean openInBrowser = false, CancellationToken cancellationToken = null) #Returns:
TaskSaves the email to disk asynchronously.
Parameters
- path System.String
- File path.
- openInBrowser System.Boolean = false
- Whether to open the file after saving.
- cancellationToken System.Threading.CancellationToken = null
- Token used to cancel the operation.
public Email SetDarkModeSupport(Boolean enabled = true) #Returns:
EmailEnables dark mode support for this email.
Parameters
- enabled System.Boolean = true
- Whether to enable dark mode support (default: true).
Returns
The Email object, allowing for method chaining.
public Email SetEmbeddingWarnings(Boolean enabled = true) #Returns:
EmailEnables or disables logging of embedding warnings.
Parameters
- enabled System.Boolean = true
- Whether to log warnings (default: true).
Returns
The Email object, allowing for method chaining.
public Email SetMaxEmbedFileSize(Int64 maxSizeBytes) #Returns:
EmailSets the maximum file size for automatic image embedding.
Parameters
- maxSizeBytes System.Int64
- Maximum file size in bytes (default: 2MB).
Returns
The Email object, allowing for method chaining.
public Email SetSmartImageDetection(Boolean enabled = true) #Returns:
EmailEnables or disables smart image detection (file vs URL detection).
Parameters
- enabled System.Boolean = true
- Whether to enable smart detection (default: true).
Returns
The Email object, allowing for method chaining.
public override String ToString() #Returns:
StringConverts the Email to its XHTML string representation.
Returns
Complete XHTML email document as string.
public async Task<String> ToStringAsync() #Returns:
Task<String>Asynchronously converts the Email to its XHTML string representation.
Returns
A task containing the complete XHTML email document as string.
public Email WithAccentColor(String lightColor, String darkColor = null) #Returns:
EmailSets the accent color used by components that rely on semantic colors (buttons, links, charts, etc.).
Parameters
- lightColor System.String
- darkColor System.String = null
public Email WithSurfaceColor(String lightColor, String darkColor = null) #Returns:
EmailSets the surface color used by semantic components (containers, cards) when they use theme defaults.
Parameters
- lightColor System.String
- darkColor System.String = null
public Email WithTextColor(String lightColor, String darkColor = null) #Returns:
EmailSets the primary text color used by semantic components when they use theme defaults.
Parameters
- lightColor System.String
- darkColor System.String = null
public Email WithThemeMode(EmailThemeMode mode) #Returns:
EmailSets the theme mode for this email.
Parameters
- mode HtmlForgeX.Email.EmailThemeMode
- The theme mode (Light, Dark, or Auto).
Returns
The Email object, allowing for method chaining.
Inherited Methods
public override Element Add(Element element) #Returns:
ElementInherited from Element
Parameters
- element Element
public override Element AddCssClass(String cssClass) #Returns:
ElementInherited from Element
Parameters
- cssClass String
public EmailActivityList EmailActivityList() #Returns:
EmailActivityListInherited from Element
Parameters
- config Action<EmailActivityList>
public EmailAddressBlock EmailAddressBlock() #Returns:
EmailAddressBlockInherited from Element
Parameters
- config Action<EmailAddressBlock>
public EmailAddressCard EmailAddressCard() #Returns:
EmailAddressCardInherited from Element
Parameters
- config Action<EmailAddressCard>
public EmailAlert EmailAlert(EmailAlertType type, String title, String message = "") #Returns:
EmailAlertInherited from Element
Parameters
- config Action<EmailAlert>
public EmailArticleCard EmailArticleCard() #Returns:
EmailArticleCardInherited from Element
Parameters
- config Action<EmailArticleCard>
public EmailArticleList EmailArticleList() #Returns:
EmailArticleListInherited from Element
Parameters
- config Action<EmailArticleList>
public EmailAttachmentList EmailAttachmentList() #Returns:
EmailAttachmentListInherited from Element
Parameters
- config Action<EmailAttachmentList>
public EmailAvatar EmailAvatar(String initials, String size = "40px") #Returns:
EmailAvatarInherited from Element
Parameters
- config Action<EmailAvatar>
public EmailAvatarStack EmailAvatarStack() #Returns:
EmailAvatarStackInherited from Element
Parameters
- config Action<EmailAvatarStack>
public EmailBackgroundImageBox EmailBackgroundImageBox() #Returns:
EmailBackgroundImageBoxInherited from Element
Parameters
- config Action<EmailBackgroundImageBox>
public EmailBadge EmailBadge(String text, String backgroundColor = "#64748B", String color = "#FFFFFF") #Returns:
EmailBadgeInherited from Element
Parameters
- config Action<EmailBadge>
public EmailBadgeList EmailBadgeList() #Returns:
EmailBadgeListInherited from Element
Parameters
- config Action<EmailBadgeList>
public EmailBarChart EmailBarChart() #Returns:
EmailBarChartInherited from Element
Parameters
- config Action<EmailBarChart>
public EmailBarcode EmailBarcode(String value) #Returns:
EmailBarcodeInherited from Element
Parameters
- config Action<EmailBarcode>
public Element EmailBlockquote(Action<EmailBlockquote> config) #Returns:
ElementInherited from Element
Parameters
- content String = ""
public Element EmailBox(Action<EmailBox> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailBox>
public Element EmailBoxWithBuilder(Action<EmailBoxBuilder> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailBoxBuilder>
public EmailBrandStrip EmailBrandStrip() #Returns:
EmailBrandStripInherited from Element
Parameters
- config Action<EmailBrandStrip>
public Element EmailButton(Action<EmailButton> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailButton>
public EmailButtonGroup EmailButtonGroup() #Returns:
EmailButtonGroupInherited from Element
Parameters
- config Action<EmailButtonGroup>
public EmailCalendar EmailCalendar() #Returns:
EmailCalendarInherited from Element
Parameters
- config Action<EmailCalendar>
public EmailCalloutCard EmailCalloutCard() #Returns:
EmailCalloutCardInherited from Element
Parameters
- config Action<EmailCalloutCard>
public EmailChangelog EmailChangelog() #Returns:
EmailChangelogInherited from Element
Parameters
- config Action<EmailChangelog>
public Element EmailColumn(Action<EmailColumn> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailColumn>
public EmailCommentList EmailCommentList() #Returns:
EmailCommentListInherited from Element
Parameters
- config Action<EmailCommentList>
public EmailComparisonTable EmailComparisonTable() #Returns:
EmailComparisonTableInherited from Element
Parameters
- config Action<EmailComparisonTable>
public Element EmailContent(Action<EmailContent> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailContent>
public EmailCredentialCard EmailCredentialCard() #Returns:
EmailCredentialCardInherited from Element
Parameters
- config Action<EmailCredentialCard>
public EmailDateStrip EmailDateStrip() #Returns:
EmailDateStripInherited from Element
Parameters
- config Action<EmailDateStrip>
public Element EmailDivider(Action<EmailDivider> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailDivider>
public EmailDnsRecordsTable EmailDnsRecordsTable() #Returns:
EmailDnsRecordsTableInherited from Element
Parameters
- config Action<EmailDnsRecordsTable>
public EmailDonutChart EmailDonutChart() #Returns:
EmailDonutChartInherited from Element
Parameters
- config Action<EmailDonutChart>
public EmailDownloadCard EmailDownloadCard() #Returns:
EmailDownloadCardInherited from Element
Parameters
- config Action<EmailDownloadCard>
public EmailEmojiRating EmailEmojiRating() #Returns:
EmailEmojiRatingInherited from Element
Parameters
- config Action<EmailEmojiRating>
public EmailEmptyStateCard EmailEmptyStateCard() #Returns:
EmailEmptyStateCardInherited from Element
Parameters
- config Action<EmailEmptyStateCard>
public EmailEventCard EmailEventCard() #Returns:
EmailEventCardInherited from Element
Parameters
- config Action<EmailEventCard>
public EmailFaqList EmailFaqList() #Returns:
EmailFaqListInherited from Element
Parameters
- config Action<EmailFaqList>
public EmailFeatureList EmailFeatureList() #Returns:
EmailFeatureListInherited from Element
Parameters
- config Action<EmailFeatureList>
public Element EmailHeading(Action<EmailHeading> config) #Returns:
ElementInherited from Element
Parameters
- content String = ""
- level Int32 = 2
public EmailHeatmap EmailHeatmap() #Returns:
EmailHeatmapInherited from Element
Parameters
- config Action<EmailHeatmap>
public EmailHero EmailHero() #Returns:
EmailHeroInherited from Element
Parameters
- config Action<EmailHero>
public EmailIconCircle EmailIconCircle() #Returns:
EmailIconCircleInherited from Element
Parameters
- config Action<EmailIconCircle>
public EmailImage EmailImage(String source, String width) #Returns:
EmailImageInherited from Element
Parameters
- config Action<EmailImage>
public EmailIncidentSummaryCard EmailIncidentSummaryCard() #Returns:
EmailIncidentSummaryCardInherited from Element
Parameters
- config Action<EmailIncidentSummaryCard>
public EmailInlineStack EmailInlineStack() #Returns:
EmailInlineStackInherited from Element
Parameters
- config Action<EmailInlineStack>
public EmailInvoiceLineItemsTable EmailInvoiceLineItemsTable() #Returns:
EmailInvoiceLineItemsTableInherited from Element
Parameters
- config Action<EmailInvoiceLineItemsTable>
public EmailInvoiceTotals EmailInvoiceTotals() #Returns:
EmailInvoiceTotalsInherited from Element
Parameters
- config Action<EmailInvoiceTotals>
public EmailKeyValueTable EmailKeyValueTable() #Returns:
EmailKeyValueTableInherited from Element
Parameters
- config Action<EmailKeyValueTable>
public EmailKpiDelta EmailKpiDelta() #Returns:
EmailKpiDeltaInherited from Element
Parameters
- config Action<EmailKpiDelta>
public EmailLineBreak EmailLineBreak(String height) #Returns:
EmailLineBreakInherited from Element
Parameters
- height String
public EmailLineItemsTable EmailLineItemsTable() #Returns:
EmailLineItemsTableInherited from Element
Parameters
- config Action<EmailLineItemsTable>
public Element EmailLink(Action<EmailLink> config) #Returns:
ElementInherited from Element
Parameters
- content String
- href String
public Element EmailList(Action<EmailList> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailList>
public EmailMapCard EmailMapCard() #Returns:
EmailMapCardInherited from Element
Parameters
- config Action<EmailMapCard>
public EmailMediaObject EmailMediaObject() #Returns:
EmailMediaObjectInherited from Element
Parameters
- config Action<EmailMediaObject>
public EmailMessageThread EmailMessageThread() #Returns:
EmailMessageThreadInherited from Element
Parameters
- config Action<EmailMessageThread>
public EmailMetricTile EmailMetricTile(String value, String label, String icon = "") #Returns:
EmailMetricTileInherited from Element
Parameters
- config Action<EmailMetricTile>
public EmailNpsRating EmailNpsRating() #Returns:
EmailNpsRatingInherited from Element
Parameters
- config Action<EmailNpsRating>
public EmailOfferCard EmailOfferCard() #Returns:
EmailOfferCardInherited from Element
Parameters
- config Action<EmailOfferCard>
public EmailOtpCode EmailOtpCode(String code) #Returns:
EmailOtpCodeInherited from Element
Parameters
- config Action<EmailOtpCode>
public EmailPhotoCard EmailPhotoCard() #Returns:
EmailPhotoCardInherited from Element
Parameters
- config Action<EmailPhotoCard>
public EmailPhotoGrid EmailPhotoGrid() #Returns:
EmailPhotoGridInherited from Element
Parameters
- config Action<EmailPhotoGrid>
public EmailPricingTable EmailPricingTable() #Returns:
EmailPricingTableInherited from Element
Parameters
- config Action<EmailPricingTable>
public EmailProductCard EmailProductCard() #Returns:
EmailProductCardInherited from Element
Parameters
- config Action<EmailProductCard>
public EmailProductGrid EmailProductGrid() #Returns:
EmailProductGridInherited from Element
Parameters
- config Action<EmailProductGrid>
public EmailProfileCard EmailProfileCard() #Returns:
EmailProfileCardInherited from Element
Parameters
- config Action<EmailProfileCard>
public EmailProgressBar EmailProgressBar(Int32 value) #Returns:
EmailProgressBarInherited from Element
Parameters
- config Action<EmailProgressBar>
public EmailProjectList EmailProjectList() #Returns:
EmailProjectListInherited from Element
Parameters
- config Action<EmailProjectList>
public EmailPromoCodeCard EmailPromoCodeCard() #Returns:
EmailPromoCodeCardInherited from Element
Parameters
- config Action<EmailPromoCodeCard>
public EmailQrCode EmailQrCode(String value) #Returns:
EmailQrCodeInherited from Element
Parameters
- config Action<EmailQrCode>
public EmailReceiptCard EmailReceiptCard() #Returns:
EmailReceiptCardInherited from Element
Parameters
- config Action<EmailReceiptCard>
public EmailRepoStatsCard EmailRepoStatsCard() #Returns:
EmailRepoStatsCardInherited from Element
Parameters
- config Action<EmailRepoStatsCard>
public EmailReviewStars EmailReviewStars() #Returns:
EmailReviewStarsInherited from Element
Parameters
- config Action<EmailReviewStars>
public EmailReviewSummary EmailReviewSummary() #Returns:
EmailReviewSummaryInherited from Element
Parameters
- config Action<EmailReviewSummary>
public Element EmailRow(Action<EmailRow> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailRow>
public EmailScheduleCard EmailScheduleCard() #Returns:
EmailScheduleCardInherited from Element
Parameters
- config Action<EmailScheduleCard>
public EmailScheduleList EmailScheduleList() #Returns:
EmailScheduleListInherited from Element
Parameters
- config Action<EmailScheduleList>
public EmailShippingProgress EmailShippingProgress() #Returns:
EmailShippingProgressInherited from Element
Parameters
- config Action<EmailShippingProgress>
public EmailSocialLinks EmailSocialLinks() #Returns:
EmailSocialLinksInherited from Element
Parameters
- config Action<EmailSocialLinks>
public Element EmailSpacer(Action<EmailSpacer> config) #Returns:
ElementInherited from Element
Parameters
- height String
public EmailSparklineBars EmailSparklineBars(params Int32[] values) #Returns:
EmailSparklineBarsInherited from Element
Parameters
- config Action<EmailSparklineBars>
public EmailStatCard EmailStatCard(String title, String value, String subtitle = "", String delta = "", EmailTrendDirection trend = Neutral) #Returns:
EmailStatCardInherited from Element
Parameters
- config Action<EmailStatCard>
public EmailStatusTimeline EmailStatusTimeline() #Returns:
EmailStatusTimelineInherited from Element
Parameters
- config Action<EmailStatusTimeline>
public EmailStepsIndicator EmailStepsIndicator() #Returns:
EmailStepsIndicatorInherited from Element
Parameters
- config Action<EmailStepsIndicator>
public EmailStoreBadges EmailStoreBadges() #Returns:
EmailStoreBadgesInherited from Element
Parameters
- config Action<EmailStoreBadges>
public EmailSubscriptionSummaryCard EmailSubscriptionSummaryCard() #Returns:
EmailSubscriptionSummaryCardInherited from Element
Parameters
- config Action<EmailSubscriptionSummaryCard>
public EmailSurveyOptions EmailSurveyOptions() #Returns:
EmailSurveyOptionsInherited from Element
Parameters
- config Action<EmailSurveyOptions>
public Element EmailTable<T>(IEnumerable<T> data, Action<EmailDynamicTable<T>> config) #Returns:
ElementInherited from Element
Type Parameters
- T
Parameters
- config Action<EmailTable>
public Element EmailText(Action<EmailText> config) #Returns:
ElementInherited from Element
Parameters
- content String = ""
public EmailTextBlock EmailTextBlock() #Returns:
EmailTextBlockInherited from Element
Parameters
- config Action<EmailTextBlock>
public EmailTodoList EmailTodoList() #Returns:
EmailTodoListInherited from Element
Parameters
- config Action<EmailTodoList>
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public override Void EvaluateLayout(LayoutContext context) #Returns:
VoidInherited from Element
Parameters
- context LayoutContext
public override Element WithCssClass(String cssClass) #Returns:
ElementInherited from Element
Parameters
- cssClass String
public override Element WithMargin(String margin) #Returns:
ElementInherited from Element
Parameters
- margin String
Properties
public Int32 EmbeddingWarningCount { get; } #Gets the number of embedding warnings collected during generation.
public Theme Theme { get; } #Per-email theme palette (surface/text/accent). Configure this to match your brand without writing CSS.
public DocumentConfiguration Configuration { get; } #Configuration and state for this email document instance.
public EmailHeader Header { get; } #Gets the header area rendered at the top of the email.
public EmailLibraryMode LibraryMode { get; set; } #Gets or sets the library mode for the email. Unsupported modes are ignored.
public String Path { get; set; } #Gets or sets the file system path where the email will be saved.