Package net.webpdf.wsclient.openapi
Class OperationConverterMail
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationConverterMail
-
public class OperationConverterMail extends Object
These settings are only used for e-mail documents. The \"MIME\" (eml; RFC-822) and Outlook (msg) e-mail formats are supported.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationConverterMail.AttachmentModeEnumSpecifies the manner in which attachments are to be processed in e-mails
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ADJUST_FONTSstatic StringJSON_PROPERTY_ATTACHMENT_MODEstatic StringJSON_PROPERTY_DOWNLOAD_IMAGESstatic StringJSON_PROPERTY_IGNORE_MISSING_BODY_CHUNKstatic StringJSON_PROPERTY_RESIZE_IMAGESstatic StringJSON_PROPERTY_RESIZE_TABLESstatic StringJSON_PROPERTY_USE_BACKGROUND
-
Constructor Summary
Constructors Constructor Description OperationConverterMail()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationConverterMailadjustFonts(Boolean adjustFonts)OperationConverterMailattachmentMode(OperationConverterMail.AttachmentModeEnum attachmentMode)OperationConverterMaildownloadImages(Boolean downloadImages)booleanequals(Object o)@Nullable BooleangetAdjustFonts()If \"true\", then the font specifications \"Arial\", \"Helvetica\" and \"Sans-Serif\" in HTML documents and e-mails (which are based on HTML) are automatically replaced by the \"Arial Unicode MS\" font.@Nullable OperationConverterMail.AttachmentModeEnumgetAttachmentMode()Specifies the manner in which attachments are to be processed in e-mails@Nullable BooleangetDownloadImages()If \"true\", then the images of an e-mail or an HTML document are downloaded automatically.@Nullable BooleangetIgnoreMissingBodyChunk()If this option is enabled, an error will not be triggered (the conversion will not be aborted) for e-mails if there is no body element in the file structure.@Nullable BooleangetResizeImages()If true, then an attempt is made to fit all images that are not in a table to the maximum page width in the PDF document.@Nullable BooleangetResizeTables()If true, then an attempt is made to fit all tables to the maximum page width in the PDF document.@Nullable BooleangetUseBackground()If \"true\", then a background defined in the e-mail (in the HTML content) is also output in the PDF document.inthashCode()OperationConverterMailignoreMissingBodyChunk(Boolean ignoreMissingBodyChunk)OperationConverterMailresizeImages(Boolean resizeImages)OperationConverterMailresizeTables(Boolean resizeTables)voidsetAdjustFonts(Boolean adjustFonts)voidsetAttachmentMode(OperationConverterMail.AttachmentModeEnum attachmentMode)voidsetDownloadImages(Boolean downloadImages)voidsetIgnoreMissingBodyChunk(Boolean ignoreMissingBodyChunk)voidsetResizeImages(Boolean resizeImages)voidsetResizeTables(Boolean resizeTables)voidsetUseBackground(Boolean useBackground)StringtoString()OperationConverterMailuseBackground(Boolean useBackground)
-
-
-
Field Detail
-
JSON_PROPERTY_ADJUST_FONTS
public static final String JSON_PROPERTY_ADJUST_FONTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ATTACHMENT_MODE
public static final String JSON_PROPERTY_ATTACHMENT_MODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DOWNLOAD_IMAGES
public static final String JSON_PROPERTY_DOWNLOAD_IMAGES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_IGNORE_MISSING_BODY_CHUNK
public static final String JSON_PROPERTY_IGNORE_MISSING_BODY_CHUNK
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RESIZE_IMAGES
public static final String JSON_PROPERTY_RESIZE_IMAGES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RESIZE_TABLES
public static final String JSON_PROPERTY_RESIZE_TABLES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_USE_BACKGROUND
public static final String JSON_PROPERTY_USE_BACKGROUND
- See Also:
- Constant Field Values
-
-
Method Detail
-
adjustFonts
public OperationConverterMail adjustFonts(Boolean adjustFonts)
-
getAdjustFonts
@Nullable public @Nullable Boolean getAdjustFonts()
If \"true\", then the font specifications \"Arial\", \"Helvetica\" and \"Sans-Serif\" in HTML documents and e-mails (which are based on HTML) are automatically replaced by the \"Arial Unicode MS\" font. The improves the appearance of the typeface in the PDF result.- Returns:
- adjustFonts
-
setAdjustFonts
public void setAdjustFonts(Boolean adjustFonts)
-
attachmentMode
public OperationConverterMail attachmentMode(OperationConverterMail.AttachmentModeEnum attachmentMode)
-
getAttachmentMode
@Nullable public @Nullable OperationConverterMail.AttachmentModeEnum getAttachmentMode()
Specifies the manner in which attachments are to be processed in e-mails. * embed = Embed in original format * remove = Remove attachments * convert = Converts the attachments to PDF format and embeds them as an attachment * convertMerge = Converts the attachments to PDF format and appends them as additional page(s) at the end **Important:** If conversion to PDF format is not possible when using \"convert\" or \"convertMerge\", the attachment will be embedded in its original format.- Returns:
- attachmentMode
-
setAttachmentMode
public void setAttachmentMode(OperationConverterMail.AttachmentModeEnum attachmentMode)
-
downloadImages
public OperationConverterMail downloadImages(Boolean downloadImages)
-
getDownloadImages
@Nullable public @Nullable Boolean getDownloadImages()
If \"true\", then the images of an e-mail or an HTML document are downloaded automatically. This option could slow down the conversion considerably if there are many images contained or if, for example, e-mail documents are converted in which the images can no longer be invoked.- Returns:
- downloadImages
-
setDownloadImages
public void setDownloadImages(Boolean downloadImages)
-
ignoreMissingBodyChunk
public OperationConverterMail ignoreMissingBodyChunk(Boolean ignoreMissingBodyChunk)
-
getIgnoreMissingBodyChunk
@Nullable public @Nullable Boolean getIgnoreMissingBodyChunk()
If this option is enabled, an error will not be triggered (the conversion will not be aborted) for e-mails if there is no body element in the file structure. However, this should not be confused with an e-mail not having any content.- Returns:
- ignoreMissingBodyChunk
-
setIgnoreMissingBodyChunk
public void setIgnoreMissingBodyChunk(Boolean ignoreMissingBodyChunk)
-
resizeImages
public OperationConverterMail resizeImages(Boolean resizeImages)
-
getResizeImages
@Nullable public @Nullable Boolean getResizeImages()
If true, then an attempt is made to fit all images that are not in a table to the maximum page width in the PDF document. The graphics will be scaled (while maintaining the aspect ratio) to fit the width of the page and not be cut off. Please note that this may cause the original formatting of the email to be lost or to deviate from the original due to the scaling. **Important:** If the \"resizeImages\" option is enabled, you must expect that the original appearance of the e-mail document will no longer be preserved.- Returns:
- resizeImages
-
setResizeImages
public void setResizeImages(Boolean resizeImages)
-
resizeTables
public OperationConverterMail resizeTables(Boolean resizeTables)
-
getResizeTables
@Nullable public @Nullable Boolean getResizeTables()
If true, then an attempt is made to fit all tables to the maximum page width in the PDF document. An attempt is made to reduce the individual columns of a table so that the table fits completely within the page width. This works only for simple tables originally defined with dynamic sizes and not for nested tables (table-in-table). Please note that this may cause the original formatting of the email to be lost or to deviate from the original due to scaling. **Important:** If the option \"resizeTables\" is activated, you must expect that the original appearance of the e-mail document is no longer preserved. The recalculation of the table columns may also result in very narrow columns in the output.- Returns:
- resizeTables
-
setResizeTables
public void setResizeTables(Boolean resizeTables)
-
useBackground
public OperationConverterMail useBackground(Boolean useBackground)
-
getUseBackground
@Nullable public @Nullable Boolean getUseBackground()
If \"true\", then a background defined in the e-mail (in the HTML content) is also output in the PDF document. If \"false\", the background will be hidden.- Returns:
- useBackground
-
setUseBackground
public void setUseBackground(Boolean useBackground)
-
-