com.aspose.email

Class FollowUpManager

java.lang.Object

com.aspose.email.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 Summary

Constructors

Constructor and Description
FollowUpManager()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addCategory(MapiMessageItemBase message, String categoryName) Adds the category for a message.
static void	addVotingButton(MapiMessageItemBase message, String displayName) Adds the voting button.
static void	clearCategories(MapiMessageItemBase message) Clears the categories.
static void	clearFlag(MapiMessageItemBase message) Clears the follow-up flag and reminder.
static void	clearVotingButtons(MapiMessageItemBase message) Deletes the voting buttons.
static IList	getCategories(MapiMessageItemBase message) Get the available message categories.
static FollowUpOptions	getOptions(MapiMessageItemBase message) Gets the follow-up options of a message.
static IList	getVotingButtons(MapiMessageItemBase message) Get the available message voting buttons.
static String[]	getVotingButtonsArray(MapiMessageItemBase message) Get the available message voting buttons.
static void	markAsCompleted(MapiMessageItemBase message) Marks the flagged message as completed.
static void	removeCategory(MapiMessageItemBase message, String categoryName) Removes the category.
static void	removeVotingButton(MapiMessageItemBase message, String displayName) Removes the voting button.
static void	setFlag(MapiMessageItemBase message, String flagRequest) Sets the follow-up flag for a message.
static void	setFlag(MapiMessageItemBase message, String flagRequest, Date startDate, Date dueDate) Sets the follow-up flag for a message.
static void	setFlagForRecipients(MapiMessageItemBase message, String flagRequest) Sets the flag for a draft message to remind recipients to follow-up.
static void	setFlagForRecipients(MapiMessageItemBase message, String flagRequest, Date reminderTime) Sets the flag for a draft message to remind recipients to follow-up.
static void	setOptions(MapiMessageItemBase message, FollowUpOptions options) Sets the additional follow-up options for a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

FollowUpManager

public FollowUpManager()

Method Detail

setFlag

public static void setFlag(MapiMessageItemBase message,
           String flagRequest)

Sets the follow-up flag for a message.

Parameters:

message - The MapiMessageItemBase in which a flag will be set.

flagRequest - A string indicating the requested action for an e-mail message.

Throws:

ArgumentException - If flagRequest is null or empty.

ArgumentNullException - If message is null.

setFlag

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

Sets the follow-up flag for a message.

Parameters:

message - The MapiMessageItemBase 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:

ArgumentException - If flagRequest is null or empty.

ArgumentNullException - If message is null.

setFlagForRecipients

public static void setFlagForRecipients(MapiMessageItemBase message,
                        String flagRequest)

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

Parameters:

message - The MapiMessageItemBase in which a flag will be set.

flagRequest - A string indicating the requested action action for recipients of an e-mail message.

Throws:

ArgumentNullException - If message is null.

ArgumentException - If flagRequest is null or empty.

InvalidOperationException - If message is not set on a draft mode.

setFlagForRecipients

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

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

Parameters:

message - The MapiMessageItemBase 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:

ArgumentNullException - If message is null.

ArgumentException - If flagRequest is null or empty.

InvalidOperationException - If message is not set on a draft mode.

markAsCompleted

public static void markAsCompleted(MapiMessageItemBase message)

Marks the flagged message as completed.

Parameters:

message - The MapiMessageItemBase in which a flag is set.

Throws:

ArgumentNullException - If message is null.

clearFlag

public static void clearFlag(MapiMessageItemBase message)

Clears the follow-up flag and reminder.

Parameters:

message - The MapiMessageItemBase in which a flag is set.

Throws:

ArgumentNullException - If message is null.

addCategory

public static void addCategory(MapiMessageItemBase message,
               String categoryName)

Adds the category for a message.

Parameters:

message - The MapiMessageItemBase in which a category will be added.

categoryName - Category name.

Throws:

ArgumentNullException - If message is null.

ArgumentException - If categoryName is null or empty.

removeCategory

public static void removeCategory(MapiMessageItemBase message,
                  String categoryName)

Removes the category.

Parameters:

message - The message.

categoryName - Name of the category.

Throws:

ArgumentNullException - If message is null.

ArgumentException - If categoryName is null or empty.

clearCategories

public static void clearCategories(MapiMessageItemBase message)

Clears the categories.

Parameters:

message - The MapiMessageItemBase in which the categories will be cleared.

Throws:

ArgumentNullException - If message is null.

getCategories

public static IList getCategories(MapiMessageItemBase message)

Get the available message categories.

Parameters:

message - The MapiMessageItemBase in which the categories are added.

Returns:

The list of added categories.

Throws:

ArgumentNullException - If message is null.

addVotingButton

public static void addVotingButton(MapiMessageItemBase message,
                   String displayName)

Adds the voting button.

Parameters:

message - The MapiMessageItemBase in which the voting button is added.

displayName - The display name of button.

Throws:

ArgumentNullException - If message is null.

ArgumentException - If displayName is null or empty.

clearVotingButtons

public static void clearVotingButtons(MapiMessageItemBase message)

Deletes the voting buttons.

Parameters:

message - The MapiMessageItemBase in which the categories will be cleared.

Throws:

ArgumentNullException - If message is null.

removeVotingButton

public static void removeVotingButton(MapiMessageItemBase message,
                      String displayName)

Removes the voting button.

Parameters:

message - The MapiMessageItemBase in which the voting button is removed.

displayName - The display name of button.

Throws:

ArgumentNullException - If message is null.

ArgumentException - If displayName is null or empty.

getVotingButtons

public static IList getVotingButtons(MapiMessageItemBase message)

Get the available message voting buttons.

Parameters:

message - The MapiMessageItemBase in which the buttons are added.

Returns:

The list of added voting buttons.

Throws:

ArgumentNullException - If message is null.

getVotingButtonsArray

public static String[] getVotingButtonsArray(MapiMessageItemBase message)

Get the available message voting buttons.

Parameters:

message - The MapiMessageItemBase in which the buttons are added.

Returns:

The list of added voting buttons.

Throws:

ArgumentNullException - If message is null.

setOptions

public static void setOptions(MapiMessageItemBase message,
              FollowUpOptions options)

Sets the additional follow-up options for a message.

Parameters:

message - The MapiMessageItemBase in which a flag will be set.

options - The FollowUpOptions that represents options for using follow-up flags and reminders.

Throws:

ArgumentNullException - If message is null.

ArgumentNullException - If options is null.

getOptions

public static FollowUpOptions getOptions(MapiMessageItemBase message)

Gets the follow-up options of a message.

Parameters:

message - The MapiMessageItemBase in which options is set.

Returns:

The FollowUpOptions that represents options for using follow-up flags, reminders, category and voting buttons.

Throws:

ArgumentNullException - If message is null.