com.aspose.email

Constructor Detail

• InboxRule

  public InboxRule()

  Initializes a new instance of the InboxRule class

Method Detail

• getRuleId

  public final String getRuleId()

  Gets or sets the rule identifier.

• setRuleId

  public final void setRuleId(String value)

  Gets or sets the rule identifier.

• getDisplayName

  public final String getDisplayName()

  Gets or sets the display name of a rule.

• setDisplayName

  public final void setDisplayName(String value)

  Gets or sets the display name of a rule.

• getPriority

  public final int getPriority()

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

• setPriority

  public final void setPriority(int value)

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

• isEnabled

  public final boolean isEnabled()

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

• setEnabled

  public final void setEnabled(boolean value)

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

• isReadOnly

  public final Boolean isReadOnly()

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

• setReadOnly

  public final void setReadOnly(Boolean value)

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

• isNotSupported

  public final boolean isNotSupported()

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

• isInError

  public final boolean isInError()

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

• getConditions

  public final RulePredicates getConditions()

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

• setConditions

  public final void setConditions(RulePredicates value)

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

• getExceptions

  public final RulePredicates getExceptions()

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

• setExceptions

  public final void setExceptions(RulePredicates value)

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

• getActions

  public final RuleActions getActions()

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

• setActions

  public final void setActions(RuleActions value)

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

• createRuleMoveFrom

  public static InboxRule createRuleMoveFrom(MailAddress from,
                             String destinationFolderId)

  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

  Throws:

  AsposeArgumentNullException - from is null

  AsposeArgumentException - destinationFolderId is null or empty

• createRuleDeleteFrom

  public static InboxRule createRuleDeleteFrom(MailAddress from)

  Creates inbox rule that deletes messages from specified senders

  Parameters:

  from - A EmailAddress of sender

  Returns:

  A created InboxRule

  Throws:

  AsposeArgumentNullException - from is null

• createRuleMoveContaining

  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:

  filter - A strings to search

  destinationFolderId - An id of folder in which messages will be moved

  Returns:

  A created InboxRule

  Throws:

  AsposeArgumentException - filter is null or empty

  AsposeArgumentException - destinationFolderId is null or empty

• createRuleDeleteContaining

  public static InboxRule createRuleDeleteContaining(String[] filter)

  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

  Throws:

  AsposeArgumentException - filter is null or empty