Module jakarta.mail
Package org.eclipse.angus.mail.util

Class MailStreamProvider

  • All Implemented Interfaces:
    StreamProvider
    public class MailStreamProvider
extends java.lang.Object
implements StreamProvider
    Contains the required encoders/decoders and streams required by the API.

    • Constructor Summary

      Constructors 
      Constructor Description
      MailStreamProvider()
      Public constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.io.InputStream inputBase64​(java.io.InputStream in)
      Creates a 'base64' decoder from the InputStream.
      java.io.InputStream inputBinary​(java.io.InputStream in)
      Creates a 'binary', '7bit' and '8bit' decoder from the InputStream.
      LineInputStream inputLineStream​(java.io.InputStream in, boolean allowutf8)
      Creates a new LineInputStream that supports reading CRLF terminated lines containing only US-ASCII characters from an input stream
      java.io.InputStream inputQ​(java.io.InputStream in)
      Creates a 'q' decoder from the InputStream.
      java.io.InputStream inputQP​(java.io.InputStream in)
      Creates a 'quoted-printable' decoder from the InputStream.
      java.io.InputStream inputSharedByteArray​(byte[] bytes)
      Creates a new InputStream from the underlying byte array to be shared between multiple readers.
      java.io.InputStream inputUU​(java.io.InputStream in)
      Creates a 'uuencode', 'x-uuencode' and 'x-uue' decoder from the InputStream.
      java.io.OutputStream outputB​(java.io.OutputStream out)
      Creates a 'b' encoder from the OutputStream.
      java.io.OutputStream outputBase64​(java.io.OutputStream out)
      Creates a 'base64' encoder from the OutputStream.
      java.io.OutputStream outputBinary​(java.io.OutputStream out)
      Creates a 'binary', '7bit' and '8bit' encoder from the OutputStream.
      LineOutputStream outputLineStream​(java.io.OutputStream out, boolean allowutf8)
      Creates a new LineOutputStream that supports writing out Strings as a sequence of bytes terminated by a CRLF sequence.
      java.io.OutputStream outputQ​(java.io.OutputStream out, boolean encodingWord)
      Creates a 'q' encoder.
      java.io.OutputStream outputQP​(java.io.OutputStream out)
      Creates a 'quoted-printable' encoder from the OutputStream.
      java.io.OutputStream outputUU​(java.io.OutputStream out, java.lang.String filename)
      Creates a 'uuencode', 'x-uuencode' and 'x-uue' encoder from the OutputStream.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MailStreamProvider

        public MailStreamProvider()
        Public constructor.

    • Method Detail

      • inputBase64

        public java.io.InputStream inputBase64​(java.io.InputStream in)
        Description copied from interface: StreamProvider
        Creates a 'base64' decoder from the InputStream.
        Specified by:
        inputBase64 in interface StreamProvider
        Parameters:
        in - the InputStream
        Returns:
        the decoder

      • outputBase64

        public java.io.OutputStream outputBase64​(java.io.OutputStream out)
        Description copied from interface: StreamProvider
        Creates a 'base64' encoder from the OutputStream.
        Specified by:
        outputBase64 in interface StreamProvider
        Parameters:
        out - the OutputStream
        Returns:
        the encoder

      • inputBinary

        public java.io.InputStream inputBinary​(java.io.InputStream in)
        Description copied from interface: StreamProvider
        Creates a 'binary', '7bit' and '8bit' decoder from the InputStream.
        Specified by:
        inputBinary in interface StreamProvider
        Parameters:
        in - the InputStream
        Returns:
        the decoder

      • outputBinary

        public java.io.OutputStream outputBinary​(java.io.OutputStream out)
        Description copied from interface: StreamProvider
        Creates a 'binary', '7bit' and '8bit' encoder from the OutputStream.
        Specified by:
        outputBinary in interface StreamProvider
        Parameters:
        out - the OutputStream
        Returns:
        the encoder

      • outputB

        public java.io.OutputStream outputB​(java.io.OutputStream out)
        Description copied from interface: StreamProvider
        Creates a 'b' encoder from the OutputStream.
        Specified by:
        outputB in interface StreamProvider
        Parameters:
        out - the OutputStream
        Returns:
        the encoder

      • inputQ

        public java.io.InputStream inputQ​(java.io.InputStream in)
        Description copied from interface: StreamProvider
        Creates a 'q' decoder from the InputStream.
        Specified by:
        inputQ in interface StreamProvider
        Parameters:
        in - the InputStream
        Returns:
        the decoder

      • outputQ

        public java.io.OutputStream outputQ​(java.io.OutputStream out,
                                    boolean encodingWord)
        Description copied from interface: StreamProvider
        Creates a 'q' encoder.
        Specified by:
        outputQ in interface StreamProvider
        Parameters:
        out - the OutputStream
        encodingWord - true if we are Q-encoding a word within a phrase.
        Returns:
        the encoder

      • inputLineStream

        public LineInputStream inputLineStream​(java.io.InputStream in,
                                       boolean allowutf8)
        Description copied from interface: StreamProvider
        Creates a new LineInputStream that supports reading CRLF terminated lines containing only US-ASCII characters from an input stream
        Specified by:
        inputLineStream in interface StreamProvider
        Parameters:
        in - the InputStream
        allowutf8 - allow UTF-8 characters?
        Returns:
        the LineInputStream

      • outputLineStream

        public LineOutputStream outputLineStream​(java.io.OutputStream out,
                                         boolean allowutf8)
        Description copied from interface: StreamProvider
        Creates a new LineOutputStream that supports writing out Strings as a sequence of bytes terminated by a CRLF sequence. The String must contain only US-ASCII characters.
        Specified by:
        outputLineStream in interface StreamProvider
        Parameters:
        out - the OutputStream
        allowutf8 - allow UTF-8 characters?
        Returns:
        the LineOutputStream

      • inputQP

        public java.io.InputStream inputQP​(java.io.InputStream in)
        Description copied from interface: StreamProvider
        Creates a 'quoted-printable' decoder from the InputStream.
        Specified by:
        inputQP in interface StreamProvider
        Parameters:
        in - the InputStream
        Returns:
        the decoder

      • outputQP

        public java.io.OutputStream outputQP​(java.io.OutputStream out)
        Description copied from interface: StreamProvider
        Creates a 'quoted-printable' encoder from the OutputStream.
        Specified by:
        outputQP in interface StreamProvider
        Parameters:
        out - the OutputStream
        Returns:
        the encoder

      • inputSharedByteArray

        public java.io.InputStream inputSharedByteArray​(byte[] bytes)
        Description copied from interface: StreamProvider
        Creates a new InputStream from the underlying byte array to be shared between multiple readers.
        Specified by:
        inputSharedByteArray in interface StreamProvider
        Parameters:
        bytes - the byte array
        Returns:
        the InputStream

      • inputUU

        public java.io.InputStream inputUU​(java.io.InputStream in)
        Description copied from interface: StreamProvider
        Creates a 'uuencode', 'x-uuencode' and 'x-uue' decoder from the InputStream.
        Specified by:
        inputUU in interface StreamProvider
        Parameters:
        in - the InputStream
        Returns:
        the decoder

      • outputUU

        public java.io.OutputStream outputUU​(java.io.OutputStream out,
                                     java.lang.String filename)
        Description copied from interface: StreamProvider
        Creates a 'uuencode', 'x-uuencode' and 'x-uue' encoder from the OutputStream.
        Specified by:
        outputUU in interface StreamProvider
        Parameters:
        out - the OutputStream
        filename - Specifies a name for the encoded buffer. It can be null.
        Returns:
        the encoder