com.aspose.email

Interfaces

Classes

Enums

Exceptions

com.aspose.email

Class FollowUpManager



  • public class FollowUpManager
    extends Object

    Provides the ability to set and handle follow-up Outlook flags and categories. Supports the features to add and remove a flag in MapiMessage, and mark it as completed as well.

    • Constructor Detail

      • FollowUpManager

        public FollowUpManager()
    • Method Detail

      • setFlag

        public static void setFlag(MapiMessage message,
                   String flagRequest)

        Sets the follow-up flag for a message.

        Parameters:
        message - The MapiMessage in which a flag will be set.
        flagRequest - A string indicating the requested action for an e-mail message.
        Throws:
        com.aspose.ms.System.ArgumentException - If flagRequest is null or empty.
        com.aspose.ms.System.ArgumentNullException - If message is null.
      • setFlag

        public static void setFlag(MapiMessage message,
                   String flagRequest,
                   Date startDate,
                   Date dueDate)

        Sets the follow-up flag for a message.

        Parameters:
        message - The MapiMessage in which a flag will be set.
        flagRequest - A string indicating the requested action for an e-mail message.
        startDate - The start date.
        dueDate - The due date.
        Throws:
        com.aspose.ms.System.ArgumentException - If flagRequest is null or empty.
        com.aspose.ms.System.ArgumentNullException - If message is null.
      • setFlagForRecipients

        public static void setFlagForRecipients(MapiMessage message,
                                String flagRequest)

        Sets the flag for a draft message to remind recipients to follow-up.

        Parameters:
        message - The MapiMessage in which a flag will be set.
        flagRequest - A string indicating the requested action action for recipients of an e-mail message.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
        com.aspose.ms.System.ArgumentException - If flagRequest is null or empty.
        com.aspose.ms.System.InvalidOperationException - If message is not set on a draft mode.
      • setFlagForRecipients

        public static void setFlagForRecipients(MapiMessage message,
                                String flagRequest,
                                Date reminderTime)

        Sets the flag for a draft message to remind recipients to follow-up.

        Parameters:
        message - The MapiMessage in which a flag will be set.
        flagRequest - A string indicating the requested action action for recipients of an e-mail message.
        reminderTime - A date indicating the date and time at which the reminder should occur.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
        com.aspose.ms.System.ArgumentException - If flagRequest is null or empty.
        com.aspose.ms.System.InvalidOperationException - If message is not set on a draft mode.
      • markAsCompleted

        public static void markAsCompleted(MapiMessage message)

        Marks the flagged message as completed.

        Parameters:
        message - The MapiMessage in which a flag is set.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
      • clearFlag

        public static void clearFlag(MapiMessage message)

        Clears the follow-up flag and reminder.

        Parameters:
        message - The MapiMessage in which a flag is set.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
      • addCategory

        public static void addCategory(MapiMessage message,
                       String categoryName)

        Adds the category for a message.

        Parameters:
        message - The MapiMessage in which a category will be added.
        categoryName - Category name.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
        com.aspose.ms.System.ArgumentException - If categoryName is null or empty.
      • removeCategory

        public static void removeCategory(MapiMessage message,
                          String categoryName)

        Removes the category.

        Parameters:
        message - The message.
        categoryName - Name of the category.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
        com.aspose.ms.System.ArgumentException - If categoryName is null or empty.
      • clearCategories

        public static void clearCategories(MapiMessage message)

        Clears the categories.

        Parameters:
        message - The MapiMessage in which the categories will be cleared.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
      • getCategories

        public static com.aspose.ms.System.Collections.IList getCategories(MapiMessage message)

        Get the available message categories.

        Parameters:
        message - The MapiMessage in which the categories are added.
        Returns:
        The list of added categories.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
      • addVotingButton

        public static void addVotingButton(MapiMessage message,
                           String displayName)

        Adds the voting button.

        Parameters:
        message - The MapiMessage in which the voting button is added.
        displayName - The display name of button.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
        com.aspose.ms.System.ArgumentException - If displayName is null or empty.
      • clearVotingButtons

        public static void clearVotingButtons(MapiMessage message)

        Deletes the voting buttons.

        Parameters:
        message - The MapiMessage in which the categories will be cleared.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
      • removeVotingButton

        public static void removeVotingButton(MapiMessage message,
                              String displayName)

        Removes the voting button.

        Parameters:
        message - The MapiMessage in which the voting button is removed.
        displayName - The display name of button.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
        com.aspose.ms.System.ArgumentException - If displayName is null or empty.
      • getVotingButtons

        public static com.aspose.ms.System.Collections.IList getVotingButtons(MapiMessage message)

        Get the available message voting buttons.

        Parameters:
        message - The MapiMessage in which the buttons are added.
        Returns:
        The list of added voting buttons.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
      • setOptions

        public static void setOptions(MapiMessage message,
                      FollowUpOptions options)

        Sets the additional follow-up options for a message.

        Parameters:
        message - The MapiMessage in which a flag will be set.
        options - The FollowUpOptions that represents options for using follow-up flags and reminders.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.
        com.aspose.ms.System.ArgumentNullException - If options is null.
      • getOptions

        public static FollowUpOptions getOptions(MapiMessage message)

        Gets the follow-up options of a message.

        Parameters:
        message - The MapiMessage in which options is set.
        Returns:
        The FollowUpOptions that represents options for using follow-up flags, reminders, category and voting buttons.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If message is null.