Class AttachmentManagerCallable


  • @VelocityCallable("instance")
    public final class AttachmentManagerCallable
    extends Object
    • Constructor Detail

      • AttachmentManagerCallable

        public AttachmentManagerCallable​(de.uplanet.lucy.server.mail.AttachmentManager p_attachmentManager)
    • Method Detail

      • hasBusinessLogicProcessingContext

        public boolean hasBusinessLogicProcessingContext()
        Returns:
        true if this object has a IBusinessLogicProcessingContext, or false otherwise.
      • addAttachmentFile

        public void addAttachmentFile​(String p_strPath,
                                      String p_strName,
                                      String p_strContentType)
                               throws FileNotFoundException
        Add an attachment file.
        Parameters:
        p_strPath - The path of the file.
        p_strName - The name of the attached file.
        p_strContentType - The content type.
        Throws:
        FileNotFoundException - If the given file does nor exist.
        IllegalArgumentException - If the given path is null or empty.
      • addAttachmentFiles

        public void addAttachmentFiles​(IValueHolder<?> p_vh)
        Add the files from the given value holder as attachments.
        Parameters:
        p_vh - A file value holder.
        Since:
        Intrexx 7.0.
      • addRelatedFile

        public String addRelatedFile​(String p_strPath)
                              throws FileNotFoundException
        Add a related file.

        The given file will only be attached once. Subsequent calls with the same file will return the previously generated Content-Id.

        Parameters:
        p_strPath - The path of the file.
        Returns:
        The Content-Id of the related file.
        Throws:
        FileNotFoundException - If the given file does nor exist.
        IllegalArgumentException - If the given path is null or empty.
      • addRelatedFile

        public String addRelatedFile​(String p_strPath,
                                     String p_strName,
                                     String p_strContentType)
        Add the given regular from external/htmlroot as a related file.

        The existsFileExternal(String) method should be used

        Parameters:
        p_strPath - The path of the file.
        p_strName - The name of the file.
        p_strContentType - The content type of the file .
        Returns:
        The Content-Id of the related file.
        Throws:
        IllegalArgumentException - If the given path is null or empty.
        Since:
        Intrexx 7.0.
      • existsFileExternal

        public boolean existsFileExternal​(String p_strPath)
                                   throws IOException
        Check if the given file exists as a regular file in external/htmlroot.

        Note: This method also returns false if the given path is null or empty.

        Parameters:
        p_strPath - The path of the file relative to external/htmlroot.
        Returns:
        true if the given file exists, or false otherwise.
        Throws:
        IOException - If an I/O error occurred.
        Since:
        Intrexx 7.0.
      • addRelatedFileExternal

        public String addRelatedFileExternal​(String p_strPath)
                                      throws IOException
        Add the given regular from external/htmlroot as a related file.

        The existsFileExternal(String) method should be used

        Parameters:
        p_strPath - The path of the file relative to external/htmlroot.
        Returns:
        The Content-Id of the related file.
        Throws:
        IOException - If an I/O error occurred.
        IllegalArgumentException - If the given path is null or empty.
        Since:
        Intrexx 7.0.
      • attachFileInternal

        @Deprecated
        public void attachFileInternal​(IValueHolder<?> p_vh)
                                throws Exception
        Deprecated.
        This method ignores multiple files and thus will be removed in the future. Please use an appropriate non-deprecated method.
        Throws:
        Exception
      • attachFileImageInternal

        @Deprecated
        public void attachFileImageInternal​(IValueHolder<?> p_vh)
                                     throws Exception
        Deprecated.
        This method ignores multiple files and thus will be removed in the future. Please use an appropriate non-deprecated method.
        Throws:
        Exception
      • attachFileImageInternalWithContentId

        @Deprecated
        public String attachFileImageInternalWithContentId​(IValueHolder<?> p_vh)
        Deprecated.
        This method ignores multiple files and thus will be removed in the future. Please use appropriate non-deprecated methods.
        Add the first file in the value holder as an image or a non-image.

        If the given file is recognized as an image it's being added to the collection of related files and its content ID is returned. Otherwise the file is being added to the collection of attachments and the method return null.

        Parameters:
        p_vh - The value holder.
        Returns:
        The content ID if the file has been added as a related file, or null otherwise.