InboxRule

Inheritance: java.lang.Object

public final class InboxRule

Represents a inbox rule

Constructors

Constructor	Description
InboxRule()	Initializes a new instance of the InboxRule class

Methods

Method	Description
createRuleDeleteContaining(String[] filter)	Creates inbox rule that deletes messages containing the specified strings in either the body or the subject
createRuleDeleteFrom(MailAddress from)	Creates inbox rule that deletes messages from specified senders
createRuleMoveContaining(String[] filter, String destinationFolderId)	Creates inbox rule that moves messages containing the specified strings in either the body or the subject into the specified folder
createRuleMoveFrom(MailAddress from, String destinationFolderId)	Creates inbox rule that moves messages from specified senders into the specified folder
equals(Object arg0)
getActions()	Gets or sets the actions to be taken on a message when the conditions are fulfilled.
getClass()
getConditions()	Gets or sets the conditions that, when fulfilled, will trigger the rule actions for that rule.
getDisplayName()	Gets or sets the display name of a rule.
getExceptions()	Gets or sets the exceptions that represent all the available rule exception conditions for the inbox rule.
getPriority()	Gets or sets a value that indicates the order in which a rule is to be run.
getRuleId()	Gets or sets the rule identifier.
hashCode()
isEnabled()	Gets or sets a value indicating whether the rule is enabled.
isInError()	Gets a value indicating whether the rule is in an error condition.
isNotSupported()	Gets a value indicating whether the rule cannot be modified with the managed code APIs.
isReadOnly()	Gets or sets a value indicating whether the rule is read-only.
notify()
notifyAll()
setActions(RuleActions value)	Gets or sets the actions to be taken on a message when the conditions are fulfilled.
setConditions(RulePredicates value)	Gets or sets the conditions that, when fulfilled, will trigger the rule actions for that rule.
setDisplayName(String value)	Gets or sets the display name of a rule.
setEnabled(boolean value)	Gets or sets a value indicating whether the rule is enabled.
setExceptions(RulePredicates value)	Gets or sets the exceptions that represent all the available rule exception conditions for the inbox rule.
setPriority(int value)	Gets or sets a value that indicates the order in which a rule is to be run.
setReadOnly(Boolean value)	Gets or sets a value indicating whether the rule is read-only.
setRuleId(String value)	Gets or sets the rule identifier.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

InboxRule()

public InboxRule()

Initializes a new instance of the InboxRule class

createRuleDeleteContaining(String[] filter)

public static InboxRule createRuleDeleteContaining(String[] filter)

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

Parameters:

Parameter	Type	Description
filter	java.lang.String[]	A strings to search

Returns: InboxRule - A created InboxRule

createRuleDeleteFrom(MailAddress from)

public static InboxRule createRuleDeleteFrom(MailAddress from)

Creates inbox rule that deletes messages from specified senders

Parameters:

Parameter	Type	Description
from	MailAddress	A EmailAddress of sender

Returns: InboxRule - A created InboxRule

createRuleMoveContaining(String[] filter, String destinationFolderId)

public static InboxRule createRuleMoveContaining(String[] filter, String destinationFolderId)

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

Parameters:

Parameter	Type	Description
filter	java.lang.String[]	A strings to search
destinationFolderId	java.lang.String	An id of folder in which messages will be moved

Returns: InboxRule - A created InboxRule

createRuleMoveFrom(MailAddress from, String destinationFolderId)

public static InboxRule createRuleMoveFrom(MailAddress from, String destinationFolderId)

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

Parameters:

Parameter	Type	Description
from	MailAddress	A EmailAddress of sender
destinationFolderId	java.lang.String	An id of folder in which messages will be moved

Returns: InboxRule - A created InboxRule

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getActions()

public final RuleActions getActions()

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

Returns: RuleActions

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getConditions()

public final RulePredicates getConditions()

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

Returns: RulePredicates

getDisplayName()

public final String getDisplayName()

Gets or sets the display name of a rule.

Returns: java.lang.String

getExceptions()

public final RulePredicates getExceptions()

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

Returns: RulePredicates

getPriority()

public final int getPriority()

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

Returns: int

getRuleId()

public final String getRuleId()

Gets or sets the rule identifier.

Returns: java.lang.String

hashCode()

public native int hashCode()

Returns: int

isEnabled()

public final boolean isEnabled()

Gets or sets a value indicating whether the rule is enabled.

Returns: boolean

isInError()

public final boolean isInError()

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

Returns: boolean

isNotSupported()

public final boolean isNotSupported()

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

Returns: boolean

isReadOnly()

public final Boolean isReadOnly()

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

Returns: java.lang.Boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setActions(RuleActions value)

public final void setActions(RuleActions value)

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

Parameters:

Parameter	Type	Description
value	RuleActions

setConditions(RulePredicates value)

public final void setConditions(RulePredicates value)

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

Parameters:

Parameter	Type	Description
value	RulePredicates

setDisplayName(String value)

public final void setDisplayName(String value)

Gets or sets the display name of a rule.

Parameters:

Parameter	Type	Description
value	java.lang.String

setEnabled(boolean value)

public final void setEnabled(boolean value)

Gets or sets a value indicating whether the rule is enabled.

Parameters:

Parameter	Type	Description
value	boolean

setExceptions(RulePredicates value)

public final void setExceptions(RulePredicates value)

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

Parameters:

Parameter	Type	Description
value	RulePredicates

setPriority(int value)

public final void setPriority(int value)

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

Parameters:

Parameter	Type	Description
value	int

setReadOnly(Boolean value)

public final void setReadOnly(Boolean value)

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

Parameters:

Parameter	Type	Description
value	java.lang.Boolean

setRuleId(String value)

public final void setRuleId(String value)

Gets or sets the rule identifier.

Parameters:

Parameter	Type	Description
value	java.lang.String

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int