Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 700 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Class

EmailImageExportExtensions

OfficeIMO.Email

Edit on GitHub
Namespace
OfficeIMO.Email
Assembly
OfficeIMO.Email.Image
Source revision
0eef6a5756b9 with working tree changes
Source
EmailImageExportExtensions.cs:23
Modifiers
static

Thin email image-export bridge over the HTML renderer.

Inheritance

  • object
  • EmailImageExportExtensions

Methods

SaveAsImage 2 overloads
public static OfficeConversionReport SaveAsImage(EmailDocument document, string path, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #
EmailDocument.ImageConversion.cs:36

Writes the selected page to a file and returns its fidelity report.

Parameters

document OfficeIMO.Email.EmailDocument required
path string required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsImage(EmailDocument document, Stream stream, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #
EmailDocument.ImageConversion.cs:46

Writes the selected page to a caller-owned stream and returns its fidelity report.

Parameters

document OfficeIMO.Email.EmailDocument required
stream System.IO.Stream required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsImageAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsImageAsync(EmailDocument document, string path, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the selected page to a file and returns its fidelity report.

Parameters

document OfficeIMO.Email.EmailDocument required
path string required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsImageAsync(EmailDocument document, Stream stream, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the selected page to a caller-owned stream and returns its fidelity report.

Parameters

document OfficeIMO.Email.EmailDocument required
stream System.IO.Stream required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static OfficeConversionReport SaveAsImages(EmailDocument document, string folderPath, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #
EmailDocument.ImageBatchConversion.cs:24

Saves selected images without retaining payloads and returns aggregate conversion evidence.

Parameters

document OfficeIMO.Email.EmailDocument required
folderPath string required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static async Task<OfficeConversionReport> SaveAsImagesAsync(EmailDocument document, string folderPath, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously saves selected images, retaining paths and evidence rather than encoded payloads.

Parameters

document OfficeIMO.Email.EmailDocument required
folderPath string required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsPdfAsync(EmailDocument document, Stream destination, EmailPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Renders the message with its header block, body and attachment list to a caller-owned PDF stream.

Parameters

document OfficeIMO.Email.EmailDocument required
destination System.IO.Stream required
options OfficeIMO.Email.EmailPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToImage 3 overloads
public static OfficeImageExportResult ToImage(EmailDocument document, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #
EmailDocument.ImageConversion.cs:9

Renders the selected page using the encoding in OfficeImageExportOptions.Format.

Parameters

document OfficeIMO.Email.EmailDocument required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult
public static OfficeImageExportResult ToImage(EmailDocument document, EmailImageExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #
EmailDocument.ImageConversion.cs:14

Renders the selected page and returns its immutable fidelity report.

Parameters

document OfficeIMO.Email.EmailDocument required
options OfficeIMO.Email.EmailImageExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult
public static OfficeImageExportResult ToImage(EmailDocument source, OfficeImageExportFormat format, EmailImageExportOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #
EmailImageExportExtensions.cs:23

Exports one email body surface or selected rendered page.

Parameters

source OfficeIMO.Email.EmailDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
pageIndex int = 0 optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult
ToImageAsync 2 overloads
public static async Task<OfficeImageExportResult> ToImageAsync(EmailDocument document, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #

Renders the selected page with cancellation and returns the encoded image and its diagnostics.

Parameters

document OfficeIMO.Email.EmailDocument required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeImageExportResult>
public static async Task<OfficeImageExportResult> ToImageAsync(EmailDocument source, OfficeImageExportFormat format, EmailImageExportOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #

Asynchronously exports one email surface and resolves inline MIME resources.

Parameters

source OfficeIMO.Email.EmailDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
pageIndex int = 0 optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeImageExportResult>
ToImages 3 overloads
public static IReadOnlyList<OfficeImageExportResult> ToImages(EmailDocument document, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #
EmailDocument.ImageBatchConversion.cs:10

Renders a batch using the encoding and selection in the options.

Parameters

document OfficeIMO.Email.EmailDocument required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<OfficeImageExportResult>
public static IReadOnlyList<OfficeImageExportResult> ToImages(EmailDocument source, OfficeImageExportFormat format, EmailImageExportOptions? options = null) #
EmailImageExportExtensions.cs:60

Exports every rendered email page.

Parameters

source OfficeIMO.Email.EmailDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Email.EmailImageExportOptions? = null optional

Returns

IReadOnlyList<OfficeImageExportResult>
public static void ToImages(EmailDocument source, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #
EmailImageExportExtensions.cs:72

Streams rendered email pages without retaining earlier payloads.

Parameters

source OfficeIMO.Email.EmailDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
consumer OfficeIMO.Drawing.OfficeImageExportConsumer required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
ToImagesAsync 3 overloads
public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(EmailDocument document, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #
EmailDocument.ImageBatchConversion.cs:17

Renders a batch asynchronously using the same options and evidence contract.

Parameters

document OfficeIMO.Email.EmailDocument required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<IReadOnlyList<OfficeImageExportResult>>
public static async Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(EmailDocument source, OfficeImageExportFormat format, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

source OfficeIMO.Email.EmailDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<IReadOnlyList<OfficeImageExportResult>>
public static async Task ToImagesAsync(EmailDocument source, OfficeImageExportFormat format, OfficeImageExportAsyncConsumer consumer, EmailImageExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously streams rendered email pages and resolves inline MIME resources.

Parameters

source OfficeIMO.Email.EmailDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer required
options OfficeIMO.Email.EmailImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task