Package com.sendmail.jilter

Interface JilterEOMActions

  • All Known Implementing Classes:
    JilterEOMActionsImpl
    public interface JilterEOMActions
    Contains the actions available during eom processing.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addheader​(java.lang.String headerf, java.lang.String headerv)
      Add a header to the current message.
      void addrcpt​(java.lang.String rcpt)
      Add a recipient for the current message.
      void chgheader​(java.lang.String headerf, int hdridx, java.lang.String headerv)
      Change or delete a message header.
      void delrcpt​(java.lang.String rcpt)
      Removes the named recipient from the current message's envelope.
      void finish​(JilterStatus status)
      Set the resulting EOM status.
      void progress()
      Notify the MTA that an operation is still in progress.
      void replacebody​(java.nio.ByteBuffer bodyp)
      Replaces the body of the current message.

    • Method Detail

      • addheader

        void addheader​(java.lang.String headerf,
               java.lang.String headerv)
        throws java.io.IOException
        Add a header to the current message.
        Parameters:
        headerf - the header name.
        headerv - the header value.
        Throws:
        java.io.IOException

      • chgheader

        void chgheader​(java.lang.String headerf,
               int hdridx,
               java.lang.String headerv)
        throws java.io.IOException
        Change or delete a message header.
        Parameters:
        headerf - the header name.
        hdridx - header index value (1-based). A hdridx value of 1 will modify the first occurrence of a header named headerf. If hdridx is greater than the number of times headerf appears, a new copy of headerf will be added.
        headerv - the new value of the given header. headerv == null indicates that the header should be deleted.
        Throws:
        java.io.IOException

      • addrcpt

        void addrcpt​(java.lang.String rcpt)
      throws java.io.IOException
        Add a recipient for the current message.
        Parameters:
        rcpt - the new recipient's address.
        Throws:
        java.io.IOException

      • delrcpt

        void delrcpt​(java.lang.String rcpt)
      throws java.io.IOException
        Removes the named recipient from the current message's envelope.
        Parameters:
        rcpt - the recipient address to be removed.
        Throws:
        java.io.IOException

      • replacebody

        void replacebody​(java.nio.ByteBuffer bodyp)
          throws java.io.IOException
        Replaces the body of the current message. If called more than once, subsequent calls result in data being appended to the new body.
        Parameters:
        bodyp - a buffer containing the new body data. Body data should be in CR/LF form.
        Throws:
        java.io.IOException

      • progress

        void progress()
       throws java.io.IOException
        Notify the MTA that an operation is still in progress.
        Throws:
        java.io.IOException

      • finish

        void finish​(JilterStatus status)
     throws java.io.IOException
        Set the resulting EOM status. Note: Calling the method essentially invalidates this object. The result of any subsequent calls to methods on this object is undefined.
        Parameters:
        status - the resulting status of EOM processing.
        Throws:
        java.io.IOException