EmailLoadOptions class
Leave feedback
On this page
Provides options for loading Email documents.
The EmailLoadOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes new instance of EmailLoadOptions class. |
| Method | Description |
|---|---|
| clone | Clones current instance. |
| equals | Determines whether two object instances are equal. (inherited from ValueObject) |
| equals_object | (inherited from ValueObject) |
| equals_value_object | (inherited from ValueObject) |
| get_hash_code | Serves as the default hash function. (inherited from ValueObject) |
| Property | Description |
|---|---|
| attachment_icons | The list of attachment icons, which can be customized to provide specific icons for different file types. |
| convert_owned | The property implements IDocumentsContainerLoadOptions.convert_owned. Default is True. |
| convert_owner | The convert_owner property implements IDocumentsContainerLoadOptions.convert_owner. Default is True. |
| custom_css_style | The custom CSS style, implementing ICustomCssStyleOptions.custom_css_style. |
| default_font | The default font for an email document. This font will be used if a required font is missing. |
| depth | The depth of the document container load options. |
| display_attachments | The option to display or hide attachments in the header. Default: True. |
| display_bcc_email_address | The option to display or hide the Bcc email address. Default: False. |
| display_cc_email_address | The option to display or hide the “Cc” email address, defaulting to False. |
| display_email_addresses | The option to control whether email addresses are displayed alongside names. Default is True. |
| display_from_email_address | The option to display or hide the “from” email address. Default: True. |
| display_header | The option to display or hide the email header. Default: True. |
| display_sent | The option to display or hide the sent date/time in the header. Default is True. |
| display_subject | The option to display or hide the subject in the header. Default is True. |
| display_to_email_address | The option to display or hide the “to” email address. Default: True. |
| field_text_map | The mapping between email message EmailField and field text representation. |
| font_substitutes | The list of font substitutes. |
| format | The input document file type. |
| margin_settings | The margin settings. |
| orientation_settings | The orientation settings. |
| page_layout_options | The property implements IPageLayoutOptions.page_layout_options. |
| preserve_original_date | The property determines whether to keep the original date header string in the mail message when saving. The default value is True. |
| resource_loading_timeout | The timeout for loading external resources. |
| size_settings | The page size settings for the email load operation. |
| skip_external_resources | The property that implements IResourceLoadingOptions.skip_external_resources. |
| time_zone_offset | The Coordinated Universal Time (UTC) offset for the message dates. |
| use_default_attachment_icons | The flag indicating whether default attachment icons are used (default is True). |
| whitelisted_resources | The property implements IResourceLoadingOptions.whitelisted_resources. |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.