API Reference
EmailImage
Represents an image element for email layouts with email-safe styling and attributes. Provides image display with customizable dimensions and optional embedding.
Inheritance
- Element
- EmailImage
Constructors
public EmailImage() #Initializes a new instance of the EmailImage class
public EmailImage(String source) #Initializes a new instance of the EmailImage class with a source
Parameters
- source System.String
- The image source URL or path
public EmailImage(String source, String width, String height = "") #Initializes a new instance of the EmailImage class with source and dimensions
Parameters
- source System.String
- The image source URL or path
- width System.String
- The image width
- height System.String = ""
- The image height (optional)
public EmailImage(String source, String width, String height, Boolean autoEmbed) #Initializes a new instance of the EmailImage class with source, dimensions, and embedding option
Parameters
- source System.String
- The image source URL or path
- width System.String
- The image width
- height System.String
- The image height
- autoEmbed System.Boolean
- Whether to automatically embed the image
Methods
EmbedDarkModeImage(System.String source, System.Int32 timeoutSeconds, System.Boolean smartDetection) #Embeds a dark mode image
Parameters
- source System.String
- The dark mode image source
- timeoutSeconds System.Int32
- Timeout in seconds for URL downloads
- smartDetection System.Boolean
- Whether to use smart detection
Returns
The EmailImage instance for method chaining
public EmailImage EmbedFromBase64(String base64Data, String mimeType = "image/jpeg") #EmailImageEmbeds an image from a base64 string
Parameters
- base64Data System.String
- The base64 encoded image data
- mimeType System.String = "image/jpeg"
- The MIME type of the image
Returns
The EmailImage instance for method chaining
public EmailImage EmbedFromBytes(Byte[] imageData, String mimeType = "image/jpeg") #EmailImageEmbeds an image from a byte array as base64
Parameters
- imageData System.Byte[]
- The image data as a byte array
- mimeType System.String = "image/jpeg"
- The MIME type of the image
Returns
The EmailImage instance for method chaining
public EmailImage EmbedFromFile(String filePath) #EmailImageEmbeds an image from a file path as base64
Parameters
- filePath System.String
- The path to the image file
Returns
The EmailImage instance for method chaining
public EmailImage EmbedFromStream(Stream stream, String mimeType = "image/jpeg") #EmailImageEmbeds an image from a stream as base64
Parameters
- stream System.IO.Stream
- The stream containing the image data
- mimeType System.String = "image/jpeg"
- The MIME type of the image
Returns
The EmailImage instance for method chaining
public EmailImage EmbedFromUrl(String url, Int32 timeoutSeconds = 30) #EmailImageObsolete("Use EmbedFromUrlAsync instead.")Embeds an image from a URL as base64.
Parameters
- url System.String
- The URL of the image
- timeoutSeconds System.Int32 = 30
- Timeout in seconds for downloading
Returns
The EmailImage instance for method chaining
public async Task<EmailImage> EmbedFromUrlAsync(String url, Int32 timeoutSeconds = 30) #Task<EmailImage>Embeds an image from a URL as base64 (asynchronous)
Parameters
- url System.String
- The URL of the image
- timeoutSeconds System.Int32 = 30
- Timeout in seconds for downloading
Returns
A task that represents the asynchronous operation
public EmailImage EmbedSmart(String source, Int32 timeoutSeconds = 30) #EmailImageEmbeds an image smartly by detecting if it's a file path or URL
Parameters
- source System.String
- The image source (file path or URL)
- timeoutSeconds System.Int32 = 30
- Timeout in seconds for URL downloads
Returns
The EmailImage instance for method chaining
public override Void EvaluateLayout(LayoutContext context) #VoidApplies default border radius using layout configuration.
Parameters
- context HtmlForgeX.Email.LayoutContext
- Layout evaluation context.
OnAddedToDocument() #Called when the image is added to a document
public override String ToString() #StringRenders the email image to HTML string
Returns
HTML representation of the email image
public EmailImage WithAlignment(Alignment alignment) #EmailImageSets the image alignment
Parameters
- alignment HtmlForgeX.Email.Alignment
- The alignment option
Returns
The EmailImage instance for method chaining
public EmailImage WithAlternativeText(String altText) #EmailImageSets the alternative text for accessibility
Parameters
- altText System.String
- The alternative text
Returns
The EmailImage instance for method chaining
public EmailImage WithAutoEmbedding() #EmailImageEnables automatic image embedding
Returns
The EmailImage instance for method chaining
public EmailImage WithBorder(String border) #EmailImageSets the image border
Parameters
- border System.String
- The border CSS value
Returns
The EmailImage instance for method chaining
public EmailImage WithBorderRadius(String borderRadius) #EmailImageSets the image border radius
Parameters
- borderRadius System.String
- The border radius value
Returns
The EmailImage instance for method chaining
public EmailImage WithDarkModeSource(String darkSource, String darkAltText = "") #EmailImageSets an alternative image source for dark mode
Parameters
- darkSource System.String
- The dark mode image source
- darkAltText System.String = ""
- Alternative text for dark mode image
Returns
The EmailImage instance for method chaining
public EmailImage WithDarkModeSwapping() #EmailImageEnables dark mode image swapping
Returns
The EmailImage instance for method chaining
public EmailImage WithHeight(String height) #EmailImageSets the image height
Parameters
- height System.String
- The height value (e.g., "200px", "auto")
Returns
The EmailImage instance for method chaining
public EmailImage WithImagePair(String lightSource, String darkSource, String altText = "") #EmailImageSets both light and dark mode image sources
Parameters
- lightSource System.String
- The light mode image source
- darkSource System.String
- The dark mode image source
- altText System.String = ""
- Alternative text for both images
Returns
The EmailImage instance for method chaining
public EmailImage WithLink(String url, Boolean openInNewWindow = false) #EmailImageWraps the image in a hyperlink
Parameters
- url System.String
- The URL to link to
- openInNewWindow System.Boolean = false
- Whether to open the link in a new window
Returns
The EmailImage instance for method chaining
WithMargin(HtmlForgeX.Email.EmailSpacing spacing) #Sets uniform margin using EmailSpacing
Parameters
- spacing HtmlForgeX.Email.EmailSpacing
- The spacing value
Returns
The EmailImage instance for method chaining
public EmailImage WithMargin(EmailSpacing vertical, EmailSpacing horizontal) #EmailImageSets vertical and horizontal margins using EmailSpacing
Parameters
- vertical HtmlForgeX.Email.EmailSpacing
- The vertical spacing
- horizontal HtmlForgeX.Email.EmailSpacing
- The horizontal spacing
Returns
The EmailImage instance for method chaining
public EmailImage WithMargin(EmailSpacing top, EmailSpacing right, EmailSpacing bottom, EmailSpacing left) #EmailImageSets individual margins for all four sides using EmailSpacing
Parameters
- top HtmlForgeX.Email.EmailSpacing
- The top margin
- right HtmlForgeX.Email.EmailSpacing
- The right margin
- bottom HtmlForgeX.Email.EmailSpacing
- The bottom margin
- left HtmlForgeX.Email.EmailSpacing
- The left margin
Returns
The EmailImage instance for method chaining
public EmailImage WithOptimization(Int32 maxWidth = 0, Int32 maxHeight = 0, Int32 quality = 85) #EmailImageEnables image optimization with specified parameters
Parameters
- maxWidth System.Int32 = 0
- Maximum width (0 for no limit)
- maxHeight System.Int32 = 0
- Maximum height (0 for no limit)
- quality System.Int32 = 85
- Image quality (0-100)
Returns
The EmailImage instance for method chaining
public EmailImage WithoutAutoEmbedding() #EmailImageDisables automatic image embedding
Returns
The EmailImage instance for method chaining
public EmailImage WithoutDarkModeSwapping() #EmailImageDisables dark mode image swapping
Returns
The EmailImage instance for method chaining
public EmailImage WithoutOptimization() #EmailImageDisables image optimization
Returns
The EmailImage instance for method chaining
public virtual EmailImage WithRoundingMode(RoundingMode mode) #EmailImageSets the rounding mode for this image.
Parameters
- mode HtmlForgeX.Email.RoundingMode
- Rounding mode.
Returns
The EmailImage instance for chaining.
public EmailImage WithSeparateAltTexts(String lightAltText, String darkAltText) #EmailImageSets different alternative texts for light and dark mode images
Parameters
- lightAltText System.String
- Alternative text for light mode image
- darkAltText System.String
- Alternative text for dark mode image
Returns
The EmailImage instance for method chaining
public EmailImage WithSource(String source, Nullable<Boolean> autoEmbed = null) #EmailImageSets the image source with optional auto-embedding control
Parameters
- source System.String
- The image source URL or path
- autoEmbed System.Nullable{System.Boolean} = null
- Whether to automatically embed the image (null uses default settings)
Returns
The EmailImage instance for method chaining
public EmailImage WithSource(String source) #EmailImageSets the image source
Parameters
- source System.String
- The image source URL or path
Returns
The EmailImage instance for method chaining
public EmailImage WithWidth(String width) #EmailImageSets the image width
Parameters
- width System.String
- The width value (e.g., "300px", "100%")
Returns
The EmailImage instance for method chaining
Inherited Methods
public override Element Add(Element element) #ElementParameters
- element Element
public override Element AddCssClass(String cssClass) #ElementParameters
- cssClass String
public EmailActivityList EmailActivityList() #EmailActivityListParameters
- config Action<EmailActivityList>
public EmailAddressBlock EmailAddressBlock() #EmailAddressBlockParameters
- config Action<EmailAddressBlock>
public EmailAddressCard EmailAddressCard() #EmailAddressCardParameters
- config Action<EmailAddressCard>
public EmailAlert EmailAlert(EmailAlertType type, String title, String message = "") #EmailAlertParameters
- config Action<EmailAlert>
public EmailArticleCard EmailArticleCard() #EmailArticleCardParameters
- config Action<EmailArticleCard>
public EmailArticleList EmailArticleList() #EmailArticleListParameters
- config Action<EmailArticleList>
public EmailAttachmentList EmailAttachmentList() #EmailAttachmentListParameters
- config Action<EmailAttachmentList>
public EmailAvatar EmailAvatar(String initials, String size = "40px") #EmailAvatarParameters
- config Action<EmailAvatar>
public EmailAvatarStack EmailAvatarStack() #EmailAvatarStackParameters
- config Action<EmailAvatarStack>
public EmailBackgroundImageBox EmailBackgroundImageBox() #EmailBackgroundImageBoxParameters
- config Action<EmailBackgroundImageBox>
public EmailBadge EmailBadge(String text, String backgroundColor = "#64748B", String color = "#FFFFFF") #EmailBadgeParameters
- config Action<EmailBadge>
public EmailBadgeList EmailBadgeList() #EmailBadgeListParameters
- config Action<EmailBadgeList>
public EmailBarChart EmailBarChart() #EmailBarChartParameters
- config Action<EmailBarChart>
public EmailBarcode EmailBarcode(String value) #EmailBarcodeParameters
- config Action<EmailBarcode>
public Element EmailBlockquote(Action<EmailBlockquote> config) #ElementParameters
- content String = ""
public Element EmailBox(Action<EmailBox> config) #ElementParameters
- config Action<EmailBox>
public Element EmailBoxWithBuilder(Action<EmailBoxBuilder> config) #ElementParameters
- config Action<EmailBoxBuilder>
public EmailBrandStrip EmailBrandStrip() #EmailBrandStripParameters
- config Action<EmailBrandStrip>
public Element EmailButton(Action<EmailButton> config) #ElementParameters
- config Action<EmailButton>
public EmailButtonGroup EmailButtonGroup() #EmailButtonGroupParameters
- config Action<EmailButtonGroup>
public EmailCalendar EmailCalendar() #EmailCalendarParameters
- config Action<EmailCalendar>
public EmailCalloutCard EmailCalloutCard() #EmailCalloutCardParameters
- config Action<EmailCalloutCard>
public EmailChangelog EmailChangelog() #EmailChangelogParameters
- config Action<EmailChangelog>
public Element EmailColumn(Action<EmailColumn> config) #ElementParameters
- config Action<EmailColumn>
public EmailCommentList EmailCommentList() #EmailCommentListParameters
- config Action<EmailCommentList>
public EmailComparisonTable EmailComparisonTable() #EmailComparisonTableParameters
- config Action<EmailComparisonTable>
public Element EmailContent(Action<EmailContent> config) #ElementParameters
- config Action<EmailContent>
public EmailCredentialCard EmailCredentialCard() #EmailCredentialCardParameters
- config Action<EmailCredentialCard>
public EmailDateStrip EmailDateStrip() #EmailDateStripParameters
- config Action<EmailDateStrip>
public Element EmailDivider(Action<EmailDivider> config) #ElementParameters
- config Action<EmailDivider>
public EmailDnsRecordsTable EmailDnsRecordsTable() #EmailDnsRecordsTableParameters
- config Action<EmailDnsRecordsTable>
public EmailDonutChart EmailDonutChart() #EmailDonutChartParameters
- config Action<EmailDonutChart>
public EmailDownloadCard EmailDownloadCard() #EmailDownloadCardParameters
- config Action<EmailDownloadCard>
public EmailEmojiRating EmailEmojiRating() #EmailEmojiRatingParameters
- config Action<EmailEmojiRating>
public EmailEmptyStateCard EmailEmptyStateCard() #EmailEmptyStateCardParameters
- config Action<EmailEmptyStateCard>
public EmailEventCard EmailEventCard() #EmailEventCardParameters
- config Action<EmailEventCard>
public EmailFaqList EmailFaqList() #EmailFaqListParameters
- config Action<EmailFaqList>
public EmailFeatureList EmailFeatureList() #EmailFeatureListParameters
- config Action<EmailFeatureList>
public Element EmailHeading(Action<EmailHeading> config) #ElementParameters
- content String = ""
- level Int32 = 2
public EmailHeatmap EmailHeatmap() #EmailHeatmapParameters
- config Action<EmailHeatmap>
public EmailHero EmailHero() #EmailHeroParameters
- config Action<EmailHero>
public EmailIconCircle EmailIconCircle() #EmailIconCircleParameters
- config Action<EmailIconCircle>
public EmailImage EmailImage(String source, String width) #EmailImageParameters
- config Action<EmailImage>
public EmailIncidentSummaryCard EmailIncidentSummaryCard() #EmailIncidentSummaryCardParameters
- config Action<EmailIncidentSummaryCard>
public EmailInlineStack EmailInlineStack() #EmailInlineStackParameters
- config Action<EmailInlineStack>
public EmailInvoiceLineItemsTable EmailInvoiceLineItemsTable() #EmailInvoiceLineItemsTableParameters
- config Action<EmailInvoiceLineItemsTable>
public EmailInvoiceTotals EmailInvoiceTotals() #EmailInvoiceTotalsParameters
- config Action<EmailInvoiceTotals>
public EmailKeyValueTable EmailKeyValueTable() #EmailKeyValueTableParameters
- config Action<EmailKeyValueTable>
public EmailKpiDelta EmailKpiDelta() #EmailKpiDeltaParameters
- config Action<EmailKpiDelta>
public EmailLineBreak EmailLineBreak(String height) #EmailLineBreakParameters
- height String
public EmailLineItemsTable EmailLineItemsTable() #EmailLineItemsTableParameters
- config Action<EmailLineItemsTable>
public Element EmailLink(Action<EmailLink> config) #ElementParameters
- content String
- href String
public Element EmailList(Action<EmailList> config) #ElementParameters
- config Action<EmailList>
public EmailMapCard EmailMapCard() #EmailMapCardParameters
- config Action<EmailMapCard>
public EmailMediaObject EmailMediaObject() #EmailMediaObjectParameters
- config Action<EmailMediaObject>
public EmailMessageThread EmailMessageThread() #EmailMessageThreadParameters
- config Action<EmailMessageThread>
public EmailMetricTile EmailMetricTile(String value, String label, String icon = "") #EmailMetricTileParameters
- config Action<EmailMetricTile>
public EmailNpsRating EmailNpsRating() #EmailNpsRatingParameters
- config Action<EmailNpsRating>
public EmailOfferCard EmailOfferCard() #EmailOfferCardParameters
- config Action<EmailOfferCard>
public EmailOtpCode EmailOtpCode(String code) #EmailOtpCodeParameters
- config Action<EmailOtpCode>
public EmailPhotoCard EmailPhotoCard() #EmailPhotoCardParameters
- config Action<EmailPhotoCard>
public EmailPhotoGrid EmailPhotoGrid() #EmailPhotoGridParameters
- config Action<EmailPhotoGrid>
public EmailPricingTable EmailPricingTable() #EmailPricingTableParameters
- config Action<EmailPricingTable>
public EmailProductCard EmailProductCard() #EmailProductCardParameters
- config Action<EmailProductCard>
public EmailProductGrid EmailProductGrid() #EmailProductGridParameters
- config Action<EmailProductGrid>
public EmailProfileCard EmailProfileCard() #EmailProfileCardParameters
- config Action<EmailProfileCard>
public EmailProgressBar EmailProgressBar(Int32 value) #EmailProgressBarParameters
- config Action<EmailProgressBar>
public EmailProjectList EmailProjectList() #EmailProjectListParameters
- config Action<EmailProjectList>
public EmailPromoCodeCard EmailPromoCodeCard() #EmailPromoCodeCardParameters
- config Action<EmailPromoCodeCard>
public EmailQrCode EmailQrCode(String value) #EmailQrCodeParameters
- config Action<EmailQrCode>
public EmailReceiptCard EmailReceiptCard() #EmailReceiptCardParameters
- config Action<EmailReceiptCard>
public EmailRepoStatsCard EmailRepoStatsCard() #EmailRepoStatsCardParameters
- config Action<EmailRepoStatsCard>
public EmailReviewStars EmailReviewStars() #EmailReviewStarsParameters
- config Action<EmailReviewStars>
public EmailReviewSummary EmailReviewSummary() #EmailReviewSummaryParameters
- config Action<EmailReviewSummary>
public Element EmailRow(Action<EmailRow> config) #ElementParameters
- config Action<EmailRow>
public EmailScheduleCard EmailScheduleCard() #EmailScheduleCardParameters
- config Action<EmailScheduleCard>
public EmailScheduleList EmailScheduleList() #EmailScheduleListParameters
- config Action<EmailScheduleList>
public EmailShippingProgress EmailShippingProgress() #EmailShippingProgressParameters
- config Action<EmailShippingProgress>
public EmailSocialLinks EmailSocialLinks() #EmailSocialLinksParameters
- config Action<EmailSocialLinks>
public Element EmailSpacer(Action<EmailSpacer> config) #ElementParameters
- height String
public EmailSparklineBars EmailSparklineBars(params Int32[] values) #EmailSparklineBarsParameters
- config Action<EmailSparklineBars>
public EmailStatCard EmailStatCard(String title, String value, String subtitle = "", String delta = "", EmailTrendDirection trend = Neutral) #EmailStatCardParameters
- config Action<EmailStatCard>
public EmailStatusTimeline EmailStatusTimeline() #EmailStatusTimelineParameters
- config Action<EmailStatusTimeline>
public EmailStepsIndicator EmailStepsIndicator() #EmailStepsIndicatorParameters
- config Action<EmailStepsIndicator>
public EmailStoreBadges EmailStoreBadges() #EmailStoreBadgesParameters
- config Action<EmailStoreBadges>
public EmailSubscriptionSummaryCard EmailSubscriptionSummaryCard() #EmailSubscriptionSummaryCardParameters
- config Action<EmailSubscriptionSummaryCard>
public EmailSurveyOptions EmailSurveyOptions() #EmailSurveyOptionsParameters
- config Action<EmailSurveyOptions>
public Element EmailTable<T>(IEnumerable<T> data, Action<EmailDynamicTable<T>> config) #ElementType Parameters
- T
Parameters
- config Action<EmailTable>
public Element EmailText(Action<EmailText> config) #ElementParameters
- content String = ""
public EmailTextBlock EmailTextBlock() #EmailTextBlockParameters
- config Action<EmailTextBlock>
public EmailTodoList EmailTodoList() #EmailTodoListParameters
- config Action<EmailTodoList>
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
public override Element WithCssClass(String cssClass) #ElementSets a custom CSS class for the image
Parameters
- cssClass System.String
- The CSS class name
Returns
The EmailImage instance for method chaining
public override Element WithMargin(String margin) #ElementSets the image margin
Parameters
- margin System.String
- The margin value (e.g., "10px", "10px 20px")
Returns
The EmailImage instance for method chaining
Properties
public String Source { get; set; } #Gets or sets the image source URL.
public String Width { get; set; } #Gets or sets the image width.
public String Height { get; set; } #Gets or sets the image height.
public String AlternativeText { get; set; } #Gets or sets the alternative text for accessibility.
public String Alignment { get; set; } #Gets or sets the image alignment.
public String Border { get; set; } #Gets or sets the border for the image.
public String BorderRadius { get; set; } #Gets or sets the border radius for the image.
public virtual RoundingMode RoundingMode { get; set; } #Controls how rounding is applied when no explicit radius is set.
public String LinkUrl { get; set; } #Gets or sets whether the image should be a link.
public Boolean OpenInNewWindow { get; set; } #Gets or sets whether the image should open in a new window.
public Boolean EmbedAsBase64 { get; set; } #Gets or sets whether the image should be embedded as base64.
public String Base64Data { get; set; } #Gets or sets the base64 encoded image data.
public String MimeType { get; set; } #Gets or sets the image MIME type for embedded images.
public Int32 MaxWidth { get; set; } #Gets or sets the maximum width for image optimization (in pixels).
public Int32 MaxHeight { get; set; } #Gets or sets the maximum height for image optimization (in pixels).
public Int32 Quality { get; set; } #Gets or sets the quality for JPEG compression (0-100).
public Boolean OptimizeImage { get; set; } #Gets or sets whether to enable automatic image optimization.
public Boolean SkipAutoEmbedding { get; set; } #Gets or sets whether to skip automatic embedding for this specific image.
public Boolean ForceEmbedding { get; set; } #Gets or sets whether to force embedding for this specific image.
public String DarkModeSource { get; set; } #Gets or sets the dark mode image source URL.
public String DarkModeAlternativeText { get; set; } #Gets or sets the dark mode alternative text.
public Boolean DarkModeEmbedAsBase64 { get; set; } #Gets or sets whether dark mode image should be embedded as base64.
public String DarkModeBase64Data { get; set; } #Gets or sets the dark mode base64 encoded image data.
public String DarkModeMimeType { get; set; } #Gets or sets the dark mode image MIME type.
public Boolean EnableDarkModeSwapping { get; set; } #Gets or sets whether to enable automatic dark mode image swapping.