Aspose::Email::Mapi::FollowUpManager Class Reference

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. More...

Inherits Object.

Public Member Functions

 FollowUpManager ()=delete
 

Static Public Member Functions

static void SetFlag (System::SharedPtr< MapiMessage > message, System::String flagRequest)
 Sets the follow-up flag for a message. More...
 
static void SetFlag (System::SharedPtr< MapiMessage > message, System::String flagRequest, System::DateTime startDate, System::DateTime dueDate)
 Sets the follow-up flag for a message. More...
 
static void SetFlagForRecipients (System::SharedPtr< MapiMessage > message, System::String flagRequest)
 Sets the flag for a draft message to remind recipients to follow-up. More...
 
static void SetFlagForRecipients (System::SharedPtr< MapiMessage > message, System::String flagRequest, System::DateTime reminderTime)
 Sets the flag for a draft message to remind recipients to follow-up. More...
 
static void MarkAsCompleted (System::SharedPtr< MapiMessage > message)
 Marks the flagged message as completed. More...
 
static void ClearFlag (System::SharedPtr< MapiMessage > message)
 Clears the follow-up flag and reminder. More...
 
static void AddCategory (System::SharedPtr< MapiMessage > message, System::String categoryName)
 Adds the category for a message. More...
 
static void SetCategory (System::SharedPtr< MapiMessageItemBase > message, System::String categoryName)
 
static void RemoveCategory (System::SharedPtr< MapiMessage > message, System::String categoryName)
 Removes the category. More...
 
static void ClearCategories (System::SharedPtr< MapiMessage > message)
 Clears the categories. More...
 
static System::SharedPtr< System::Collections::Generic::IList< System::String > > GetCategories (System::SharedPtr< MapiMessage > message)
 Get the available message categories. More...
 
static void AddVotingButton (System::SharedPtr< MapiMessage > message, System::String displayName)
 Adds the voting button. More...
 
static void ClearVotingButtons (System::SharedPtr< MapiMessage > message)
 Deletes the voting buttons. More...
 
static void RemoveVotingButton (System::SharedPtr< MapiMessage > message, System::String displayName)
 Removes the voting button. More...
 
static System::ArrayPtr< System::String > GetVotingButtons (System::SharedPtr< MapiMessage > message)
 Get the available message voting buttons. More...
 
static void SetOptions (System::SharedPtr< MapiMessage > message, System::SharedPtr< FollowUpOptions > options)
 Sets the additional follow-up options for a message. More...
 
static System::SharedPtr< FollowUpOptionsGetOptions (System::SharedPtr< MapiMessage > message)
 Gets the follow-up options of a message. More...
 

Friends

class Aspose::Email::Clients::Graph::V1::Commands::UpdateMessageCommand
 
class Aspose::Email::Mapi::MapiMessageItemBase
 

Detailed Description

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 & Destructor Documentation

◆ FollowUpManager()

Aspose::Email::Mapi::FollowUpManager::FollowUpManager ( )
delete

Member Function Documentation

◆ AddCategory()

static void Aspose::Email::Mapi::FollowUpManager::AddCategory ( System::SharedPtr< MapiMessage message,
System::String  categoryName 
)
static

Adds the category for a message.

Parameters
messageThe MapiMessage in which a category will be added.
categoryNameCategory name.
Exceptions
ArgumentNullExceptionIf message is null.
ArgumentExceptionIf categoryName is null or empty.

◆ AddVotingButton()

static void Aspose::Email::Mapi::FollowUpManager::AddVotingButton ( System::SharedPtr< MapiMessage message,
System::String  displayName 
)
static

Adds the voting button.

Parameters
messageThe MapiMessage in which the voting button is added.
displayNameThe display name of button.
Exceptions
ArgumentNullExceptionIf message is null.
ArgumentExceptionIf displayName is null or empty.

◆ ClearCategories()

static void Aspose::Email::Mapi::FollowUpManager::ClearCategories ( System::SharedPtr< MapiMessage message)
static

Clears the categories.

Parameters
messageThe MapiMessage in which the categories will be cleared.
Exceptions
ArgumentNullExceptionIf message is null.

◆ ClearFlag()

static void Aspose::Email::Mapi::FollowUpManager::ClearFlag ( System::SharedPtr< MapiMessage message)
static

Clears the follow-up flag and reminder.

Parameters
messageThe MapiMessage in which a flag is set.
Exceptions
ArgumentNullExceptionIf message is null.

◆ ClearVotingButtons()

static void Aspose::Email::Mapi::FollowUpManager::ClearVotingButtons ( System::SharedPtr< MapiMessage message)
static

Deletes the voting buttons.

Parameters
messageThe MapiMessage in which the categories will be cleared.
Exceptions
ArgumentNullExceptionIf message is null.

◆ GetCategories()

static System::SharedPtr<System::Collections::Generic::IList<System::String> > Aspose::Email::Mapi::FollowUpManager::GetCategories ( System::SharedPtr< MapiMessage message)
static

Get the available message categories.

Parameters
messageThe MapiMessage in which the categories are added.
Returns
The list of added categories.
Exceptions
ArgumentNullExceptionIf message is null.

◆ GetOptions()

static System::SharedPtr<FollowUpOptions> Aspose::Email::Mapi::FollowUpManager::GetOptions ( System::SharedPtr< MapiMessage message)
static

Gets the follow-up options of a message.

Parameters
messageThe MapiMessage in which options is set.
Returns
The FollowUpOptions that represents options for using follow-up flags, reminders, category and voting buttons.
Exceptions
ArgumentNullExceptionIf message is null.

◆ GetVotingButtons()

static System::ArrayPtr<System::String> Aspose::Email::Mapi::FollowUpManager::GetVotingButtons ( System::SharedPtr< MapiMessage message)
static

Get the available message voting buttons.

Parameters
messageThe MapiMessage in which the buttons are added.
Returns
The list of added voting buttons.
Exceptions
ArgumentNullExceptionIf message is null.

◆ MarkAsCompleted()

static void Aspose::Email::Mapi::FollowUpManager::MarkAsCompleted ( System::SharedPtr< MapiMessage message)
static

Marks the flagged message as completed.

Parameters
messageThe MapiMessage in which a flag is set.
Exceptions
ArgumentNullExceptionIf message is null.

◆ RemoveCategory()

static void Aspose::Email::Mapi::FollowUpManager::RemoveCategory ( System::SharedPtr< MapiMessage message,
System::String  categoryName 
)
static

Removes the category.

Parameters
messageThe message.
categoryNameName of the category.
Exceptions
ArgumentNullExceptionIf message is null.
ArgumentExceptionIf categoryName is null or empty.

◆ RemoveVotingButton()

static void Aspose::Email::Mapi::FollowUpManager::RemoveVotingButton ( System::SharedPtr< MapiMessage message,
System::String  displayName 
)
static

Removes the voting button.

Parameters
messageThe MapiMessage in which the voting button is removed.
displayNameThe display name of button.
Exceptions
ArgumentNullExceptionIf message is null.
ArgumentExceptionIf displayName is null or empty.

◆ SetCategory()

static void Aspose::Email::Mapi::FollowUpManager::SetCategory ( System::SharedPtr< MapiMessageItemBase message,
System::String  categoryName 
)
static

◆ SetFlag() [1/2]

static void Aspose::Email::Mapi::FollowUpManager::SetFlag ( System::SharedPtr< MapiMessage message,
System::String  flagRequest 
)
static

Sets the follow-up flag for a message.

Parameters
messageThe MapiMessage in which a flag will be set.
flagRequestA string indicating the requested action for an e-mail message.
Exceptions
ArgumentExceptionIf flagRequest is null or empty.
ArgumentNullExceptionIf message is null.

◆ SetFlag() [2/2]

static void Aspose::Email::Mapi::FollowUpManager::SetFlag ( System::SharedPtr< MapiMessage message,
System::String  flagRequest,
System::DateTime  startDate,
System::DateTime  dueDate 
)
static

Sets the follow-up flag for a message.

Parameters
messageThe MapiMessage in which a flag will be set.
flagRequestA string indicating the requested action for an e-mail message.
startDateThe start date.
dueDateThe due date.
Exceptions
ArgumentExceptionIf flagRequest is null or empty.
ArgumentNullExceptionIf message is null.

◆ SetFlagForRecipients() [1/2]

static void Aspose::Email::Mapi::FollowUpManager::SetFlagForRecipients ( System::SharedPtr< MapiMessage message,
System::String  flagRequest 
)
static

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

Parameters
messageThe MapiMessage in which a flag will be set.
flagRequestA string indicating the requested action action for recipients of an e-mail message.
Exceptions
ArgumentNullExceptionIf message is null.
ArgumentExceptionIf flagRequest is null or empty.
InvalidOperationExceptionIf message is not set on a draft mode.

◆ SetFlagForRecipients() [2/2]

static void Aspose::Email::Mapi::FollowUpManager::SetFlagForRecipients ( System::SharedPtr< MapiMessage message,
System::String  flagRequest,
System::DateTime  reminderTime 
)
static

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

Parameters
messageThe MapiMessage in which a flag will be set.
flagRequestA string indicating the requested action action for recipients of an e-mail message.
reminderTimeA date indicating the date and time at which the reminder should occur.
Exceptions
ArgumentNullExceptionIf message is null.
ArgumentExceptionIf flagRequest is null or empty.
InvalidOperationExceptionIf message is not set on a draft mode.

◆ SetOptions()

static void Aspose::Email::Mapi::FollowUpManager::SetOptions ( System::SharedPtr< MapiMessage message,
System::SharedPtr< FollowUpOptions options 
)
static

Sets the additional follow-up options for a message.

Parameters
messageThe MapiMessage in which a flag will be set.
optionsThe FollowUpOptions that represents options for using follow-up flags and reminders.
Exceptions
ArgumentNullExceptionIf message is null.
ArgumentNullExceptionIf options is null.

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Graph::V1::Commands::UpdateMessageCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::UpdateMessageCommand
friend

◆ Aspose::Email::Mapi::MapiMessageItemBase