Package org.apache.commons.mail

Class EmailAttachment

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ATTACHMENT
      Definition of the part being an attachment.
      static java.lang.String INLINE
      Definition of the part being inline.

    • Constructor Summary

      Constructors 
      Constructor Description
      EmailAttachment()
      Constructs a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Gets the description.
      java.lang.String getDisposition()
      Gets the disposition.
      java.lang.String getName()
      Gets the name.
      java.lang.String getPath()
      Gets the path.
      java.net.URL getURL()
      Gets the URL.
      void setDescription​(java.lang.String desc)
      Sets the description.
      void setDisposition​(java.lang.String aDisposition)
      Sets the disposition.
      void setName​(java.lang.String aName)
      Sets the name.
      void setPath​(java.lang.String aPath)
      Sets the path to the attachment.
      void setURL​(java.net.URL aUrl)
      Sets the URL.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Gets the description.
        Returns:
        A String.
        Since:
        1.0

      • getDisposition

        public java.lang.String getDisposition()
        Gets the disposition.
        Returns:
        A String.
        Since:
        1.0

      • getName

        public java.lang.String getName()
        Gets the name.
        Returns:
        A String.
        Since:
        1.0

      • getPath

        public java.lang.String getPath()
        Gets the path.
        Returns:
        A String.
        Since:
        1.0

      • getURL

        public java.net.URL getURL()
        Gets the URL.
        Returns:
        A URL.
        Since:
        1.0

      • setDescription

        public void setDescription​(java.lang.String desc)
        Sets the description.
        Parameters:
        desc - A String.
        Since:
        1.0

      • setDisposition

        public void setDisposition​(java.lang.String aDisposition)
        Sets the disposition.
        Parameters:
        aDisposition - A String.
        Since:
        1.0

      • setName

        public void setName​(java.lang.String aName)
        Sets the name.
        Parameters:
        aName - A String.
        Since:
        1.0

      • setPath

        public void setPath​(java.lang.String aPath)
        Sets the path to the attachment. The path can be absolute or relative and should include the file name.

        Example: /home/user/images/image.jpg
        Example: images/image.jpg

        Parameters:
        aPath - A String.
        Since:
        1.0

      • setURL

        public void setURL​(java.net.URL aUrl)
        Sets the URL.
        Parameters:
        aUrl - A URL.
        Since:
        1.0