Package de.uplanet.lucy.server.mailservice.workflow.eventsource

Class IMAPFinishActionCfg

java.lang.Object
de.uplanet.lucy.server.mailservice.workflow.eventsource.IMAPFinishActionCfg
public final class IMAPFinishActionCfg extends Object

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMoveDestinationFolder()
    Get the destination folder for move operations (see move).
    boolean
    isDelete()
    This flag determines if processed messages should be deleted.
    boolean
    isDeleteAndExpunge()
    This flag determines if processed messages should be deleted and expunged.
    boolean
    isMarkSeen()
    This flag determines if processed messages should be marked as seen.
    boolean
    isMove()
    This flag determines if processed messages should be moved to the folder specified by moveDestinationFolder.
    boolean
    isNone()
    This flag prevents processed messages to be modified by the event source.
    void
    setDelete(boolean p_bDelete)
    This flag determines if processed messages should be deleted.
    void
    setDeleteAndExpunge(boolean p_bDeleteAndExpunge)
    This flag determines if processed messages should be deleted and expunged.
    void
    setMarkSeen(boolean p_bMarkSeen)
    This flag determines if processed messages should be marked as seen.
    void
    setMove(boolean p_bMove)
    This flag determines if processed messages should be moved to the folder specified by moveDestinationFolder.
    void
    setMoveDestinationFolder(String p_moveDestinationFolder)
    Set the destination folder for move operations (see move).
    void
    setNone(boolean p_bNone)
    This flag prevents processed messages to be modified by the event source.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • isDelete

      public boolean isDelete()
      This flag determines if processed messages should be deleted.

      This flag is exclusive.

      Returns:
      true if processed messages should be deleted, or false otherwise.

    • setDelete

      public void setDelete(boolean p_bDelete)
      This flag determines if processed messages should be deleted.

      This flag is exclusive.

      Parameters:
      p_bDelete - true if processed messages should be deleted, or false otherwise.

    • isDeleteAndExpunge

      public boolean isDeleteAndExpunge()
      This flag determines if processed messages should be deleted and expunged.

      This flag is exclusive.

      Note that expunged messages could not be restored.

      This feature requires the Oracle JavaMail IMAP provider.

      This feature depends on the IMAP UIDPLUS extension defined in RFC 2359.

      Returns:
      true if processed messages should be deleted, or false otherwise.

    • setDeleteAndExpunge

      public void setDeleteAndExpunge(boolean p_bDeleteAndExpunge)
      This flag determines if processed messages should be deleted and expunged.

      This flag is exclusive.

      Note that expunged messages could not be restored.

      This feature requires the Oracle JavaMail IMAP provider.

      This feature depends on the IMAP UIDPLUS extension defined in RFC 2359.

      Parameters:
      p_bDeleteAndExpunge - true if processed messages should be deleted, or false otherwise.

    • isMove

      public boolean isMove()
      This flag determines if processed messages should be moved to the folder specified by moveDestinationFolder.
      Returns:
      true if processed messages should be moved, or false otherwise.

    • setMove

      public void setMove(boolean p_bMove)
      This flag determines if processed messages should be moved to the folder specified by moveDestinationFolder.
      Parameters:
      p_bMove - true if processed messages should be moved, or false otherwise.

    • getMoveDestinationFolder

      public String getMoveDestinationFolder()
      Get the destination folder for move operations (see move).
      Returns:
      The Destination folder for move operations.

    • setMoveDestinationFolder

      public void setMoveDestinationFolder(String p_moveDestinationFolder)
      Set the destination folder for move operations (see move).
      Parameters:
      p_moveDestinationFolder - The Destination folder for move operations.

    • isMarkSeen

      public boolean isMarkSeen()
      This flag determines if processed messages should be marked as seen.
      Returns:
      true if processed messages should be marked as seen, or false otherwise.

    • setMarkSeen

      public void setMarkSeen(boolean p_bMarkSeen)
      This flag determines if processed messages should be marked as seen.
      Parameters:
      p_bMarkSeen - true if processed messages should be marked as seen, or false otherwise.

    • isNone

      public boolean isNone()
      This flag prevents processed messages to be modified by the event source. This is useful if the user wishes to control message flags etc. by himself.

      This flag is exclusive.

      Returns:
      true if the message should not be modified by the event source, or false otherwise.

    • setNone

      public void setNone(boolean p_bNone)
      This flag prevents processed messages to be modified by the event source. This is useful if the user wishes to control message flags etc. by himself.

      This flag is exclusive.

      Parameters:
      p_bNone - true if the message should not be modified by the event source, or false otherwise.