Represents a inbox rule More...

Inherits Object.

Public Member Functions
System::String	get_RuleId () const
	Gets the rule identifier. More...

void	set_RuleId (System::String value)
	Sets the rule identifier. More...

System::String	get_DisplayName () const
	Gets the display name of a rule. More...

void	set_DisplayName (System::String value)
	Sets the display name of a rule. More...

int32_t	get_Priority () const
	Gets a value that indicates the order in which a rule is to be run. More...

void	set_Priority (int32_t value)
	Sets a value that indicates the order in which a rule is to be run. More...

bool	get_IsEnabled () const
	Gets a value indicating whether the rule is enabled. More...

void	set_IsEnabled (bool value)
	Sets a value indicating whether the rule is enabled. More...

System::Nullable< bool >	get_IsReadOnly () const
	Gets a value indicating whether the rule is read-only. More...

void	set_IsReadOnly (System::Nullable< bool > value)
	Sets a value indicating whether the rule is read-only. More...

bool	get_IsNotSupported () const
	Gets a value indicating whether the rule cannot be modified with the managed code APIs. More...

void	set_IsNotSupported (bool value)
	Gets a value indicating whether the rule cannot be modified with the managed code APIs. More...

bool	get_IsInError () const
	Gets a value indicating whether the rule is in an error condition. More...

void	set_IsInError (bool value)
	Gets a value indicating whether the rule is in an error condition. More...

System::SharedPtr< RulePredicates >	get_Conditions () const
	Gets the conditions that, when fulfilled, will trigger the rule actions for that rule. More...

void	set_Conditions (System::SharedPtr< RulePredicates > value)
	Sets the conditions that, when fulfilled, will trigger the rule actions for that rule. More...

System::SharedPtr< RulePredicates >	get_Exceptions () const
	Gets the exceptions that represent all the available rule exception conditions for the inbox rule. More...

void	set_Exceptions (System::SharedPtr< RulePredicates > value)
	Sets the exceptions that represent all the available rule exception conditions for the inbox rule. More...

System::SharedPtr< RuleActions >	get_Actions () const
	Gets the actions to be taken on a message when the conditions are fulfilled. More...

void	set_Actions (System::SharedPtr< RuleActions > value)
	Sets the actions to be taken on a message when the conditions are fulfilled. More...

	InboxRule ()
	Initializes a new instance of the InboxRule class More...

Static Public Member Functions
static System::SharedPtr< InboxRule >	CreateRuleMoveFrom (System::SharedPtr< MailAddress > from, System::String destinationFolderId)
	Creates inbox rule that moves messages from specified senders into the specified folder More...

static System::SharedPtr< InboxRule >	CreateRuleDeleteFrom (System::SharedPtr< MailAddress > from)
	Creates inbox rule that deletes messages from specified senders More...

static System::SharedPtr< InboxRule >	CreateRuleMoveContaining (System::ArrayPtr< System::String > filter, System::String destinationFolderId)
	Creates inbox rule that moves messages containing the specified strings in either the body or the subject into the specified folder More...

static System::SharedPtr< InboxRule >	CreateRuleDeleteContaining (System::ArrayPtr< System::String > filter)
	Creates inbox rule that deletes messages containing the specified strings in either the body or the subject More...

Friends
class	Aspose::Email::Clients::Exchange::WebService::EWSClient2010

class	Aspose::Email::Clients::Graph::V1::Model::TLMessageRule

Detailed Description

Represents a inbox rule

Constructor & Destructor Documentation

◆ InboxRule()

Aspose::Email::Clients::Exchange::InboxRule::InboxRule ( )

Initializes a new instance of the InboxRule class

Member Function Documentation

◆ CreateRuleDeleteContaining()

static System::SharedPtr<InboxRule> Aspose::Email::Clients::Exchange::InboxRule::CreateRuleDeleteContaining ( System::ArrayPtr< System::String > filter )

static

Creates inbox rule that deletes messages containing the specified strings in either the body or the subject

Parameters

filter A strings to search

Returns: A created InboxRule

Exceptions

AsposeArgumentException filter is null or empty

◆ CreateRuleDeleteFrom()

static System::SharedPtr<InboxRule> Aspose::Email::Clients::Exchange::InboxRule::CreateRuleDeleteFrom ( System::SharedPtr< MailAddress > from )

static

Creates inbox rule that deletes messages from specified senders

Parameters

from	A EmailAddress of sender

Returns: A created InboxRule

Exceptions

AsposeArgumentNullException from is null

◆ CreateRuleMoveContaining()

static System::SharedPtr<InboxRule> Aspose::Email::Clients::Exchange::InboxRule::CreateRuleMoveContaining	(	System::ArrayPtr< System::String >	filter,
		System::String	destinationFolderId
	)

static

Creates inbox rule that moves messages containing the specified strings in either the body or the subject into the specified folder

Parameters

filter	A strings to search
destinationFolderId	An id of folder in which messages will be moved

Returns: A created InboxRule

Exceptions

AsposeArgumentException	filter is `null` or `empty`
AsposeArgumentException	destinationFolderId is `null` or `empty`

◆ CreateRuleMoveFrom()

static System::SharedPtr<InboxRule> Aspose::Email::Clients::Exchange::InboxRule::CreateRuleMoveFrom	(	System::SharedPtr< MailAddress >	from,
		System::String	destinationFolderId
	)

static

Creates inbox rule that moves messages from specified senders into the specified folder

Parameters

from	A EmailAddress of sender
destinationFolderId	An id of folder in which messages will be moved

Returns: A created InboxRule

Exceptions

AsposeArgumentNullException	from is `null`
AsposeArgumentException	destinationFolderId is `null` or `empty`

◆ get_Actions()

System::SharedPtr<RuleActions> Aspose::Email::Clients::Exchange::InboxRule::get_Actions ( ) const

Gets the actions to be taken on a message when the conditions are fulfilled.

◆ get_Conditions()

System::SharedPtr<RulePredicates> Aspose::Email::Clients::Exchange::InboxRule::get_Conditions ( ) const

Gets the conditions that, when fulfilled, will trigger the rule actions for that rule.

◆ get_DisplayName()

System::String Aspose::Email::Clients::Exchange::InboxRule::get_DisplayName ( ) const

Gets the display name of a rule.

◆ get_Exceptions()

System::SharedPtr<RulePredicates> Aspose::Email::Clients::Exchange::InboxRule::get_Exceptions ( ) const

Gets the exceptions that represent all the available rule exception conditions for the inbox rule.

◆ get_IsEnabled()

bool Aspose::Email::Clients::Exchange::InboxRule::get_IsEnabled ( ) const

Gets a value indicating whether the rule is enabled.

◆ get_IsInError()

bool Aspose::Email::Clients::Exchange::InboxRule::get_IsInError ( ) const

Gets a value indicating whether the rule is in an error condition.

◆ get_IsNotSupported()

bool Aspose::Email::Clients::Exchange::InboxRule::get_IsNotSupported ( ) const

Gets a value indicating whether the rule cannot be modified with the managed code APIs.

◆ get_IsReadOnly()

System::Nullable<bool> Aspose::Email::Clients::Exchange::InboxRule::get_IsReadOnly ( ) const

Gets a value indicating whether the rule is read-only.

◆ get_Priority()

int32_t Aspose::Email::Clients::Exchange::InboxRule::get_Priority ( ) const

Gets a value that indicates the order in which a rule is to be run.

◆ get_RuleId()

System::String Aspose::Email::Clients::Exchange::InboxRule::get_RuleId ( ) const

Gets the rule identifier.

◆ set_Actions()

void Aspose::Email::Clients::Exchange::InboxRule::set_Actions ( System::SharedPtr< RuleActions > value )

Sets the actions to be taken on a message when the conditions are fulfilled.

◆ set_Conditions()

void Aspose::Email::Clients::Exchange::InboxRule::set_Conditions ( System::SharedPtr< RulePredicates > value )

Sets the conditions that, when fulfilled, will trigger the rule actions for that rule.

◆ set_DisplayName()

void Aspose::Email::Clients::Exchange::InboxRule::set_DisplayName ( System::String value )

Sets the display name of a rule.

◆ set_Exceptions()

void Aspose::Email::Clients::Exchange::InboxRule::set_Exceptions ( System::SharedPtr< RulePredicates > value )

Sets the exceptions that represent all the available rule exception conditions for the inbox rule.

◆ set_IsEnabled()

void Aspose::Email::Clients::Exchange::InboxRule::set_IsEnabled ( bool value )

Sets a value indicating whether the rule is enabled.

◆ set_IsInError()

void Aspose::Email::Clients::Exchange::InboxRule::set_IsInError ( bool value )

Gets a value indicating whether the rule is in an error condition.

◆ set_IsNotSupported()

void Aspose::Email::Clients::Exchange::InboxRule::set_IsNotSupported ( bool value )

Gets a value indicating whether the rule cannot be modified with the managed code APIs.

◆ set_IsReadOnly()

void Aspose::Email::Clients::Exchange::InboxRule::set_IsReadOnly ( System::Nullable< bool > value )

Sets a value indicating whether the rule is read-only.

◆ set_Priority()

void Aspose::Email::Clients::Exchange::InboxRule::set_Priority ( int32_t value )

Sets a value that indicates the order in which a rule is to be run.

◆ set_RuleId()

void Aspose::Email::Clients::Exchange::InboxRule::set_RuleId ( System::String value )

Sets the rule identifier.

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::WebService::EWSClient2010

friend class Aspose::Email::Clients::Exchange::WebService::EWSClient2010

friend

◆ Aspose::Email::Clients::Graph::V1::Model::TLMessageRule

friend class Aspose::Email::Clients::Graph::V1::Model::TLMessageRule

friend

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ InboxRule()

Member Function Documentation

◆ CreateRuleDeleteContaining()

◆ CreateRuleDeleteFrom()

◆ CreateRuleMoveContaining()

◆ CreateRuleMoveFrom()

◆ get_Actions()

◆ get_Conditions()

◆ get_DisplayName()

◆ get_Exceptions()

◆ get_IsEnabled()

◆ get_IsInError()

◆ get_IsNotSupported()

◆ get_IsReadOnly()

◆ get_Priority()

◆ get_RuleId()

◆ set_Actions()

◆ set_Conditions()

◆ set_DisplayName()

◆ set_Exceptions()

◆ set_IsEnabled()

◆ set_IsInError()

◆ set_IsNotSupported()

◆ set_IsReadOnly()

◆ set_Priority()

◆ set_RuleId()

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::WebService::EWSClient2010

◆ Aspose::Email::Clients::Graph::V1::Model::TLMessageRule