Module com.sun.mail
Package com.sun.mail.imap

Class IMAPBodyPart

  • All Implemented Interfaces:
    ReadableMime, jakarta.mail.internet.MimePart, jakarta.mail.Part
    public class IMAPBodyPart
extends jakarta.mail.internet.MimeBodyPart
implements ReadableMime
    An IMAP body part.

    • Field Summary

      • Fields inherited from class jakarta.mail.internet.MimeBodyPart

        cachedContent, content, contentStream, dh, headers

      • Fields inherited from class jakarta.mail.BodyPart

        parent, streamProvider

      • Fields inherited from interface jakarta.mail.Part

        ATTACHMENT, INLINE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addHeader​(java.lang.String name, java.lang.String value)  
      void addHeaderLine​(java.lang.String line)  
      java.util.Enumeration<java.lang.String> getAllHeaderLines()  
      java.util.Enumeration<jakarta.mail.Header> getAllHeaders()  
      java.lang.String getContentID()  
      java.lang.String getContentMD5()  
      protected java.io.InputStream getContentStream()  
      java.lang.String getContentType()  
      jakarta.activation.DataHandler getDataHandler()  
      java.lang.String getDescription()  
      java.lang.String getDisposition()  
      java.lang.String getEncoding()  
      java.lang.String getFileName()  
      java.lang.String[] getHeader​(java.lang.String name)  
      int getLineCount()  
      java.util.Enumeration<java.lang.String> getMatchingHeaderLines​(java.lang.String[] names)  
      java.util.Enumeration<jakarta.mail.Header> getMatchingHeaders​(java.lang.String[] names)  
      java.io.InputStream getMimeStream()
      Return the MIME format stream corresponding to this message part.
      java.util.Enumeration<java.lang.String> getNonMatchingHeaderLines​(java.lang.String[] names)  
      java.util.Enumeration<jakarta.mail.Header> getNonMatchingHeaders​(java.lang.String[] names)  
      int getSize()  
      void removeHeader​(java.lang.String name)  
      void setContent​(jakarta.mail.Multipart mp)  
      void setContent​(java.lang.Object o, java.lang.String type)  
      void setContentMD5​(java.lang.String md5)  
      void setDataHandler​(jakarta.activation.DataHandler content)  
      void setDescription​(java.lang.String description, java.lang.String charset)  
      void setDisposition​(java.lang.String disposition)  
      void setFileName​(java.lang.String filename)  
      void setHeader​(java.lang.String name, java.lang.String value)  
      protected void updateHeaders()  

      • Methods inherited from class jakarta.mail.internet.MimeBodyPart

        attachFile, attachFile, attachFile, attachFile, getContent, getContentLanguage, getHeader, getInputStream, getRawInputStream, isMimeType, saveFile, saveFile, setContentID, setContentLanguage, setDescription, setText, setText, setText, writeTo

      • Methods inherited from class jakarta.mail.BodyPart

        getParent

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • updateHeaders

        protected void updateHeaders()
        Overrides:
        updateHeaders in class jakarta.mail.internet.MimeBodyPart

      • getSize

        public int getSize()
            throws jakarta.mail.MessagingException
        Specified by:
        getSize in interface jakarta.mail.Part
        Overrides:
        getSize in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getLineCount

        public int getLineCount()
                 throws jakarta.mail.MessagingException
        Specified by:
        getLineCount in interface jakarta.mail.Part
        Overrides:
        getLineCount in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getContentType

        public java.lang.String getContentType()
                                throws jakarta.mail.MessagingException
        Specified by:
        getContentType in interface jakarta.mail.Part
        Overrides:
        getContentType in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getDisposition

        public java.lang.String getDisposition()
                                throws jakarta.mail.MessagingException
        Specified by:
        getDisposition in interface jakarta.mail.Part
        Overrides:
        getDisposition in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • setDisposition

        public void setDisposition​(java.lang.String disposition)
                    throws jakarta.mail.MessagingException
        Specified by:
        setDisposition in interface jakarta.mail.Part
        Overrides:
        setDisposition in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getEncoding

        public java.lang.String getEncoding()
                             throws jakarta.mail.MessagingException
        Specified by:
        getEncoding in interface jakarta.mail.internet.MimePart
        Overrides:
        getEncoding in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getContentID

        public java.lang.String getContentID()
                              throws jakarta.mail.MessagingException
        Specified by:
        getContentID in interface jakarta.mail.internet.MimePart
        Overrides:
        getContentID in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getContentMD5

        public java.lang.String getContentMD5()
                               throws jakarta.mail.MessagingException
        Specified by:
        getContentMD5 in interface jakarta.mail.internet.MimePart
        Overrides:
        getContentMD5 in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • setContentMD5

        public void setContentMD5​(java.lang.String md5)
                   throws jakarta.mail.MessagingException
        Specified by:
        setContentMD5 in interface jakarta.mail.internet.MimePart
        Overrides:
        setContentMD5 in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getDescription

        public java.lang.String getDescription()
                                throws jakarta.mail.MessagingException
        Specified by:
        getDescription in interface jakarta.mail.Part
        Overrides:
        getDescription in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • setDescription

        public void setDescription​(java.lang.String description,
                           java.lang.String charset)
                    throws jakarta.mail.MessagingException
        Overrides:
        setDescription in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getFileName

        public java.lang.String getFileName()
                             throws jakarta.mail.MessagingException
        Specified by:
        getFileName in interface jakarta.mail.Part
        Overrides:
        getFileName in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • setFileName

        public void setFileName​(java.lang.String filename)
                 throws jakarta.mail.MessagingException
        Specified by:
        setFileName in interface jakarta.mail.Part
        Overrides:
        setFileName in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getContentStream

        protected java.io.InputStream getContentStream()
                                        throws jakarta.mail.MessagingException
        Overrides:
        getContentStream in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getMimeStream

        public java.io.InputStream getMimeStream()
                                  throws jakarta.mail.MessagingException
        Return the MIME format stream corresponding to this message part.
        Specified by:
        getMimeStream in interface ReadableMime
        Returns:
        the MIME format stream
        Throws:
        jakarta.mail.MessagingException - for failures
        Since:
        JavaMail 1.4.5

      • getDataHandler

        public jakarta.activation.DataHandler getDataHandler()
                                              throws jakarta.mail.MessagingException
        Specified by:
        getDataHandler in interface jakarta.mail.Part
        Overrides:
        getDataHandler in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • setDataHandler

        public void setDataHandler​(jakarta.activation.DataHandler content)
                    throws jakarta.mail.MessagingException
        Specified by:
        setDataHandler in interface jakarta.mail.Part
        Overrides:
        setDataHandler in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • setContent

        public void setContent​(java.lang.Object o,
                       java.lang.String type)
                throws jakarta.mail.MessagingException
        Specified by:
        setContent in interface jakarta.mail.Part
        Overrides:
        setContent in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • setContent

        public void setContent​(jakarta.mail.Multipart mp)
                throws jakarta.mail.MessagingException
        Specified by:
        setContent in interface jakarta.mail.Part
        Overrides:
        setContent in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getHeader

        public java.lang.String[] getHeader​(java.lang.String name)
                             throws jakarta.mail.MessagingException
        Specified by:
        getHeader in interface jakarta.mail.Part
        Overrides:
        getHeader in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • setHeader

        public void setHeader​(java.lang.String name,
                      java.lang.String value)
               throws jakarta.mail.MessagingException
        Specified by:
        setHeader in interface jakarta.mail.Part
        Overrides:
        setHeader in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • addHeader

        public void addHeader​(java.lang.String name,
                      java.lang.String value)
               throws jakarta.mail.MessagingException
        Specified by:
        addHeader in interface jakarta.mail.Part
        Overrides:
        addHeader in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • removeHeader

        public void removeHeader​(java.lang.String name)
                  throws jakarta.mail.MessagingException
        Specified by:
        removeHeader in interface jakarta.mail.Part
        Overrides:
        removeHeader in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getAllHeaders

        public java.util.Enumeration<jakarta.mail.Header> getAllHeaders()
                                                         throws jakarta.mail.MessagingException
        Specified by:
        getAllHeaders in interface jakarta.mail.Part
        Overrides:
        getAllHeaders in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getMatchingHeaders

        public java.util.Enumeration<jakarta.mail.Header> getMatchingHeaders​(java.lang.String[] names)
                                                              throws jakarta.mail.MessagingException
        Specified by:
        getMatchingHeaders in interface jakarta.mail.Part
        Overrides:
        getMatchingHeaders in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getNonMatchingHeaders

        public java.util.Enumeration<jakarta.mail.Header> getNonMatchingHeaders​(java.lang.String[] names)
                                                                 throws jakarta.mail.MessagingException
        Specified by:
        getNonMatchingHeaders in interface jakarta.mail.Part
        Overrides:
        getNonMatchingHeaders in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • addHeaderLine

        public void addHeaderLine​(java.lang.String line)
                   throws jakarta.mail.MessagingException
        Specified by:
        addHeaderLine in interface jakarta.mail.internet.MimePart
        Overrides:
        addHeaderLine in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getAllHeaderLines

        public java.util.Enumeration<java.lang.String> getAllHeaderLines()
                                                          throws jakarta.mail.MessagingException
        Specified by:
        getAllHeaderLines in interface jakarta.mail.internet.MimePart
        Overrides:
        getAllHeaderLines in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getMatchingHeaderLines

        public java.util.Enumeration<java.lang.String> getMatchingHeaderLines​(java.lang.String[] names)
                                                               throws jakarta.mail.MessagingException
        Specified by:
        getMatchingHeaderLines in interface jakarta.mail.internet.MimePart
        Overrides:
        getMatchingHeaderLines in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException

      • getNonMatchingHeaderLines

        public java.util.Enumeration<java.lang.String> getNonMatchingHeaderLines​(java.lang.String[] names)
                                                                  throws jakarta.mail.MessagingException
        Specified by:
        getNonMatchingHeaderLines in interface jakarta.mail.internet.MimePart
        Overrides:
        getNonMatchingHeaderLines in class jakarta.mail.internet.MimeBodyPart
        Throws:
        jakarta.mail.MessagingException