Get Started

API Reference

Class

EmailImageExportExtensions

Edit on GitHub
Namespace OfficeIMO.Html
Assembly OfficeIMO.Html
Source OfficeIMO.Html/Email/EmailImageExportExtensions.cs:20
Modifiers static

Thin email image-export bridge over the HTML renderer.

Inheritance

  • Object
  • EmailImageExportExtensions

Methods

public static OfficeImageExportResult ExportImage(EmailDocument source, OfficeImageExportFormat format, EmailImageExportOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Email/EmailImageExportExtensions.cs:20
Returns: OfficeImageExportResult

Exports one email body surface or selected rendered page.

Parameters

source OfficeIMO.Email.EmailDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Html.EmailImageExportOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
public static async Task<OfficeImageExportResult> ExportImageAsync(EmailDocument source, OfficeImageExportFormat format, EmailImageExportOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
Returns: Task<OfficeImageExportResult>

Asynchronously exports one email surface and resolves inline MIME resources.

Parameters

source OfficeIMO.Email.EmailDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Html.EmailImageExportOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
ExportImages 2 overloads
public static IReadOnlyList<OfficeImageExportResult> ExportImages(EmailDocument source, OfficeImageExportFormat format, EmailImageExportOptions options = null) #
OfficeIMO.Html/Email/EmailImageExportExtensions.cs:55
Returns: IReadOnlyList<OfficeImageExportResult>

Exports every rendered email page.

Parameters

source OfficeIMO.Email.EmailDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Html.EmailImageExportOptions = null optionalposition: 2
public static Void ExportImages(EmailDocument source, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, EmailImageExportOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Email/EmailImageExportExtensions.cs:67
Returns: Void

Streams rendered email pages without retaining earlier payloads.

Parameters

source OfficeIMO.Email.EmailDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
consumer OfficeIMO.Drawing.OfficeImageExportConsumer requiredposition: 2
options OfficeIMO.Html.EmailImageExportOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
ExportImagesAsync 2 overloads
public static async Task<IReadOnlyList<OfficeImageExportResult>> ExportImagesAsync(EmailDocument source, OfficeImageExportFormat format, EmailImageExportOptions options = null, CancellationToken cancellationToken = null) #
Returns: Task<IReadOnlyList<OfficeImageExportResult>>

Asynchronously exports every rendered email page and resolves inline MIME resources.

Parameters

source OfficeIMO.Email.EmailDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Html.EmailImageExportOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static async Task ExportImagesAsync(EmailDocument source, OfficeImageExportFormat format, OfficeImageExportAsyncConsumer consumer, EmailImageExportOptions options = null, CancellationToken cancellationToken = null) #
Returns: Task

Asynchronously streams rendered email pages and resolves inline MIME resources.

Parameters

source OfficeIMO.Email.EmailDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer requiredposition: 2
options OfficeIMO.Html.EmailImageExportOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4