Package net.webpdf.wsclient.schema.operation

Class ConverterMailType

  • public class ConverterMailType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">These settings are only used for e-mail documents. The "MIME" (eml; RFC-822) and Outlook (msg) e-mail formats are supported.</p>

    Java class for ConverterMailType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="ConverterMailType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="downloadImages" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="adjustFonts" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="attachmentMode" type="{http://schema.webpdf.de/1.0/operation}AttachmentModeType" default="embed" />
       <attribute name="ignoreMissingBodyChunk" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="useBackground" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="resizeImages" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="resizeTables" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="reduceImageSize" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • downloadImages

        protected Boolean downloadImages
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true", then externally referenced images in the HTML content of the e-mail are downloaded and inserted into the document. If false, the images are not downloaded and the external references to the image are removed, leaving already embedded images intact. This option can slow down the conversion if many images are included or if, for example, e-mail documents are converted in which the images can no longer be retrieved.</p>

      • adjustFonts

        protected Boolean adjustFonts
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • attachmentMode

        protected AttachmentModeType attachmentMode
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the manner in which attachments are to be processed in e-mails.
                         <ul><li>embed = Embed in original format</li><li>remove = Remove attachments</li><li>convert = Converts the attachments to PDF format and embeds them as an attachment</li><li>convertMerge = Converts the attachments to PDF format and appends them as additional page(s) at the end</li></ul></p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If conversion to PDF format is not possible when using "convert" or "convertMerge", the attachment will be embedded in its original format.
                     </p>

      • ignoreMissingBodyChunk

        protected Boolean ignoreMissingBodyChunk
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • useBackground

        protected Boolean useBackground
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • resizeImages

        protected Boolean resizeImages
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.
 
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If the "resizeImages" option is enabled, you must expect that the original appearance of the e-mail document will no longer be preserved.
                     </p>

      • resizeTables

        protected Boolean resizeTables
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.
 
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         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.
                     </p>

      • reduceImageSize

        protected Boolean reduceImageSize
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true", then all images are reduced in their pixel size so that they fit into the maximum page width.
                         This only applies to images that have been resized using the <code>resizeImages</code> option.
                         These images are reduced to the maximum number of pixels required to fit the page width.
                         Images that are not affected by the <code>resizeImages</code> option are not resized.
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If you activate the <code>reduceImageSize</code> option, you must also activate <code>resizeImages</code> and only resized images will be affected by this option.
                         This option also leads to a significant reduction in the number of pixels in images, which can lead to an improved document size.</p>

    • Constructor Detail

      • ConverterMailType

        public ConverterMailType()

    • Method Detail

      • isDownloadImages

        public boolean isDownloadImages()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true", then externally referenced images in the HTML content of the e-mail are downloaded and inserted into the document. If false, the images are not downloaded and the external references to the image are removed, leaving already embedded images intact. This option can slow down the conversion if many images are included or if, for example, e-mail documents are converted in which the images can no longer be retrieved.</p>
        Returns:
        possible object is Boolean

      • setDownloadImages

        public void setDownloadImages​(boolean value)
        Sets the value of the downloadImages property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isDownloadImages()

      • isSetDownloadImages

        public boolean isSetDownloadImages()

      • unsetDownloadImages

        public void unsetDownloadImages()

      • isAdjustFonts

        public boolean isAdjustFonts()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is Boolean

      • setAdjustFonts

        public void setAdjustFonts​(boolean value)
        Sets the value of the adjustFonts property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isAdjustFonts()

      • isSetAdjustFonts

        public boolean isSetAdjustFonts()

      • unsetAdjustFonts

        public void unsetAdjustFonts()

      • getAttachmentMode

        public AttachmentModeType getAttachmentMode()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the manner in which attachments are to be processed in e-mails.
                         <ul><li>embed = Embed in original format</li><li>remove = Remove attachments</li><li>convert = Converts the attachments to PDF format and embeds them as an attachment</li><li>convertMerge = Converts the attachments to PDF format and appends them as additional page(s) at the end</li></ul></p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If conversion to PDF format is not possible when using "convert" or "convertMerge", the attachment will be embedded in its original format.
                     </p>
        Returns:
        possible object is AttachmentModeType

      • isSetAttachmentMode

        public boolean isSetAttachmentMode()

      • isIgnoreMissingBodyChunk

        public boolean isIgnoreMissingBodyChunk()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is Boolean

      • setIgnoreMissingBodyChunk

        public void setIgnoreMissingBodyChunk​(boolean value)
        Sets the value of the ignoreMissingBodyChunk property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isIgnoreMissingBodyChunk()

      • isSetIgnoreMissingBodyChunk

        public boolean isSetIgnoreMissingBodyChunk()

      • unsetIgnoreMissingBodyChunk

        public void unsetIgnoreMissingBodyChunk()

      • isUseBackground

        public boolean isUseBackground()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is Boolean

      • setUseBackground

        public void setUseBackground​(boolean value)
        Sets the value of the useBackground property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isUseBackground()

      • isSetUseBackground

        public boolean isSetUseBackground()

      • unsetUseBackground

        public void unsetUseBackground()

      • isResizeImages

        public boolean isResizeImages()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.
 
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If the "resizeImages" option is enabled, you must expect that the original appearance of the e-mail document will no longer be preserved.
                     </p>
        Returns:
        possible object is Boolean

      • setResizeImages

        public void setResizeImages​(boolean value)
        Sets the value of the resizeImages property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isResizeImages()

      • isSetResizeImages

        public boolean isSetResizeImages()

      • unsetResizeImages

        public void unsetResizeImages()

      • isResizeTables

        public boolean isResizeTables()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.
 
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         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.
                     </p>
        Returns:
        possible object is Boolean

      • setResizeTables

        public void setResizeTables​(boolean value)
        Sets the value of the resizeTables property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isResizeTables()

      • isSetResizeTables

        public boolean isSetResizeTables()

      • unsetResizeTables

        public void unsetResizeTables()

      • isReduceImageSize

        public boolean isReduceImageSize()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true", then all images are reduced in their pixel size so that they fit into the maximum page width.
                         This only applies to images that have been resized using the <code>resizeImages</code> option.
                         These images are reduced to the maximum number of pixels required to fit the page width.
                         Images that are not affected by the <code>resizeImages</code> option are not resized.
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If you activate the <code>reduceImageSize</code> option, you must also activate <code>resizeImages</code> and only resized images will be affected by this option.
                         This option also leads to a significant reduction in the number of pixels in images, which can lead to an improved document size.</p>
        Returns:
        possible object is Boolean

      • setReduceImageSize

        public void setReduceImageSize​(boolean value)
        Sets the value of the reduceImageSize property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isReduceImageSize()

      • isSetReduceImageSize

        public boolean isSetReduceImageSize()

      • unsetReduceImageSize

        public void unsetReduceImageSize()