RulePredicates (Exchange Web Services Java API 2.0 API)

java.lang.Object
- microsoft.exchange.webservices.data.property.complex.ComplexProperty
- - microsoft.exchange.webservices.data.property.complex.RulePredicates

All Implemented Interfaces:

ISelfValidate, ComplexFunctionDelegate<EwsServiceXmlReader>
```
public final class RulePredicates
extends ComplexProperty
```
Represents the set of conditions and exception available for a rule.

Constructor Summary

Constructors
Modifier Constructor and Description

protected RulePredicates()
Initializes a new instance of the RulePredicates class.

Constructors
Modifier	Constructor and Description
`protected`	`RulePredicates()` Initializes a new instance of the RulePredicates class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringList`	`getCategories()` Gets the categories that an incoming message should be stamped with for the condition or exception to apply.
`StringList`	`getContainsBodyStrings()` Gets the strings that should appear in the body of incoming messages for the condition or exception to apply.
`StringList`	`getContainsHeaderStrings()` Gets the strings that should appear in the headers of incoming messages for the condition or exception to apply.
`StringList`	`getContainsRecipientStrings()` Gets the strings that should appear in either the To or Cc fields of incoming messages for the condition or exception to apply.
`StringList`	`getContainsSenderStrings()` Gets the strings that should appear in the From field of incoming messages for the condition or exception to apply.
`StringList`	`getContainsSubjectOrBodyStrings()` Gets the strings that should appear in either the body or the subject of incoming messages for the condition or exception to apply.
`StringList`	`getContainsSubjectStrings()` Gets the strings that should appear in the subject of incoming messages for the condition or exception to apply.
`FlaggedForAction`	`getFlaggedForAction()` Gets or sets the flag for action value that should appear on incoming messages for the condition or execption to apply.
`EmailAddressCollection`	`getFromAddresses()` Gets the e-mail addresses of the senders of incoming messages for the condition or exception to apply.
`StringList`	`getFromConnectedAccounts()` Gets the e-mail account names from which incoming messages must have been aggregated for the condition or exception to apply.
`boolean`	`getHasAttachments()` Gets or sets a value indicating whether incoming messages must have attachments for the condition or exception to apply.
`Importance`	`getImportance()` Gets or sets the importance that should be stamped on incoming messages for the condition or exception to apply.
`boolean`	`getIsApprovalRequest()` Gets or sets a value indicating whether incoming messages must be approval request for the condition or exception to apply.
`boolean`	`getIsAutomaticForward()` Gets or sets a value indicating whether incoming messages must be automatic forwards for the condition or exception to apply.
`boolean`	`getIsAutomaticReply()` Gets or sets a value indicating whether incoming messages must be automatic replies for the condition or exception to apply.
`boolean`	`getIsEncrypted()` Gets or sets a value indicating whether incoming messages must be S/MIME encrypted for the condition or exception to apply.
`boolean`	`getIsMeetingRequest()` Gets or sets a value indicating whether incoming messages must be meeting request for the condition or exception to apply.
`boolean`	`getIsMeetingResponse()` Gets or sets a value indicating whether incoming messages must be meeting response for the condition or exception to apply.
`boolean`	`getIsNonDeliveryReport()` Gets or sets a value indicating whether incoming messages must be non-delivery reports (NDR) for the condition or exception to apply.
`boolean`	`getIsPermissionControlled()` Gets or sets a value indicating whether incoming messages must be permission controlled (RMS protected) for the condition or exception to apply.
`boolean`	`getIsReadReceipt()` Gets or sets a value indicating whether incoming messages must be read receipts for the condition or exception to apply.
`boolean`	`getIsSigned()` Gets or sets a value indicating whether incoming messages must be S/MIME signed for the condition or exception to apply.
`boolean`	`getIsVoicemail()` Gets or sets a value indicating whether incoming messages must be voice mails for the condition or exception to apply.
`StringList`	`getItemClasses()` Gets the item classes that must be stamped on incoming messages for the condition or exception to apply.
`StringList`	`getMessageClassifications()` Gets the message classifications that must be stamped on incoming messages for the condition or exception to apply.
`boolean`	`getNotSentToMe()` Gets or sets a value indicating whether the owner of the mailbox must NOT be a To recipient of the incoming messages for the condition or exception to apply.
`Sensitivity`	`getSensitivity()` Gets or sets the sensitivity that must be stamped on incoming messages for the condition or exception to apply.
`boolean`	`getSentCcMe()` Gets or sets a value indicating whether the owner of the mailbox must be a Cc recipient of incoming messages for the condition or exception to apply.
`boolean`	`getSentOnlyToMe()` Gets or sets a value indicating whether the owner of the mailbox must be the only To recipient of incoming messages for the condition or exception to apply.
`EmailAddressCollection`	`getSentToAddresses()` Gets the e-mail addresses incoming messages must have been sent to for the condition or exception to apply.
`boolean`	`getSentToMe()` Gets or sets a value indicating whether the owner of the mailbox must be a To recipient of incoming messages for the condition or exception to apply.
`boolean`	`getSentToOrCcMe()` Gets or sets a value indicating whether the owner of the mailbox must be either a To or Cc recipient of incoming messages for the condition or exception to apply.
`RulePredicateDateRange`	`getWithinDateRange()` Gets the date range within which incoming messages must have been received for the condition or exception to apply.
`RulePredicateSizeRange`	`getWithinSizeRange()` Gets the minimum and maximum sizes incoming messages must have for the condition or exception to apply.
`protected void`	`internalValidate()` Validates this instance.
`void`	`setFlaggedForAction(FlaggedForAction value)`
`void`	`setHasAttachments(boolean value)`
`void`	`setImportance(Importance value)`
`void`	`setIsApprovalRequest(boolean value)`
`void`	`setIsAutomaticForward(boolean value)`
`void`	`setIsAutomaticReply(boolean value)`
`void`	`setIsEncrypted(boolean value)`
`void`	`setIsMeetingRequest(boolean value)`
`void`	`setIsMeetingResponse(boolean value)`
`void`	`setIsNonDeliveryReport(boolean value)`
`void`	`setIsPermissionControlled(boolean value)`
`void`	`setIsReadReceipt(boolean value)`
`void`	`setIsSigned(boolean value)`
`void`	`setIsVoicemail(boolean value)`
`void`	`setNotSentToMe(boolean value)`
`void`	`setSensitivity(Sensitivity value)`
`void`	`setSentCcMe(boolean value)`
`void`	`setSentOnlyToMe(boolean value)`
`void`	`setSentToMe(boolean value)`
`void`	`setSentToOrCcMe(boolean value)`
`boolean`	`tryReadElementFromXml(EwsServiceXmlReader reader)` Tries to read element from XML.
`void`	`writeElementsToXml(EwsServiceXmlWriter writer)` Writes elements to XML.

Methods inherited from class microsoft.exchange.webservices.data.property.complex.ComplexProperty
addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, clearChangeLog, func, getNamespace, loadFromXml, loadFromXml, readAttributesFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, tryReadElementFromXmlToPatch, updateFromXml, updateFromXml, validate, writeAttributesToXml, writeToXml, writeToXml

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RulePredicates
```
protected RulePredicates()
```
    Initializes a new instance of the RulePredicates class.
- Method Detail
  - getCategories
```
public StringList getCategories()
```
    Gets the categories that an incoming message should be stamped with for the condition or exception to apply. To disable this predicate, empty the list.
  - getContainsBodyStrings
```
public StringList getContainsBodyStrings()
```
    Gets the strings that should appear in the body of incoming messages for the condition or exception to apply. To disable this predicate, empty the list.
  - getContainsHeaderStrings
```
public StringList getContainsHeaderStrings()
```
    Gets the strings that should appear in the headers of incoming messages for the condition or exception to apply. To disable this predicate, empty the list.
  - getContainsRecipientStrings
```
public StringList getContainsRecipientStrings()
```
    Gets the strings that should appear in either the To or Cc fields of incoming messages for the condition or exception to apply. To disable this predicate, empty the list.
  - getContainsSenderStrings
```
public StringList getContainsSenderStrings()
```
    Gets the strings that should appear in the From field of incoming messages for the condition or exception to apply. To disable this predicate, empty the list.
  - getContainsSubjectOrBodyStrings
```
public StringList getContainsSubjectOrBodyStrings()
```
    Gets the strings that should appear in either the body or the subject of incoming messages for the condition or exception to apply. To disable this predicate, empty the list.
  - getContainsSubjectStrings
```
public StringList getContainsSubjectStrings()
```
    Gets the strings that should appear in the subject of incoming messages for the condition or exception to apply. To disable this predicate, empty the list.
  - getFlaggedForAction
```
public FlaggedForAction getFlaggedForAction()
```
    Gets or sets the flag for action value that should appear on incoming messages for the condition or execption to apply. To disable this predicate, set it to null.
  - setFlaggedForAction
```
public void setFlaggedForAction(FlaggedForAction value)
```
  - getFromAddresses
```
public EmailAddressCollection getFromAddresses()
```
    Gets the e-mail addresses of the senders of incoming messages for the condition or exception to apply. To disable this predicate, empty the list.
  - getHasAttachments
```
public boolean getHasAttachments()
```
    Gets or sets a value indicating whether incoming messages must have attachments for the condition or exception to apply.
  - setHasAttachments
```
public void setHasAttachments(boolean value)
```
  - getImportance
```
public Importance getImportance()
```
    Gets or sets the importance that should be stamped on incoming messages for the condition or exception to apply. To disable this predicate, set it to null.
  - setImportance
```
public void setImportance(Importance value)
```
  - getIsApprovalRequest
```
public boolean getIsApprovalRequest()
```
    Gets or sets a value indicating whether incoming messages must be approval request for the condition or exception to apply.
  - setIsApprovalRequest
```
public void setIsApprovalRequest(boolean value)
```
  - getIsAutomaticForward
```
public boolean getIsAutomaticForward()
```
    Gets or sets a value indicating whether incoming messages must be automatic forwards for the condition or exception to apply.
  - setIsAutomaticForward
```
public void setIsAutomaticForward(boolean value)
```
  - getIsAutomaticReply
```
public boolean getIsAutomaticReply()
```
    Gets or sets a value indicating whether incoming messages must be automatic replies for the condition or exception to apply.
  - setIsAutomaticReply
```
public void setIsAutomaticReply(boolean value)
```
  - getIsEncrypted
```
public boolean getIsEncrypted()
```
    Gets or sets a value indicating whether incoming messages must be S/MIME encrypted for the condition or exception to apply.
  - setIsEncrypted
```
public void setIsEncrypted(boolean value)
```
  - getIsMeetingRequest
```
public boolean getIsMeetingRequest()
```
    Gets or sets a value indicating whether incoming messages must be meeting request for the condition or exception to apply.
  - setIsMeetingRequest
```
public void setIsMeetingRequest(boolean value)
```
  - getIsMeetingResponse
```
public boolean getIsMeetingResponse()
```
    Gets or sets a value indicating whether incoming messages must be meeting response for the condition or exception to apply.
  - setIsMeetingResponse
```
public void setIsMeetingResponse(boolean value)
```
  - getIsNonDeliveryReport
```
public boolean getIsNonDeliveryReport()
```
    Gets or sets a value indicating whether incoming messages must be non-delivery reports (NDR) for the condition or exception to apply.
  - setIsNonDeliveryReport
```
public void setIsNonDeliveryReport(boolean value)
```
  - getIsPermissionControlled
```
public boolean getIsPermissionControlled()
```
    Gets or sets a value indicating whether incoming messages must be permission controlled (RMS protected) for the condition or exception to apply.
  - setIsPermissionControlled
```
public void setIsPermissionControlled(boolean value)
```
  - getIsSigned
```
public boolean getIsSigned()
```
    Gets or sets a value indicating whether incoming messages must be S/MIME signed for the condition or exception to apply.
  - setIsSigned
```
public void setIsSigned(boolean value)
```
  - getIsVoicemail
```
public boolean getIsVoicemail()
```
    Gets or sets a value indicating whether incoming messages must be voice mails for the condition or exception to apply.
  - setIsVoicemail
```
public void setIsVoicemail(boolean value)
```
  - getIsReadReceipt
```
public boolean getIsReadReceipt()
```
    Gets or sets a value indicating whether incoming messages must be read receipts for the condition or exception to apply.
  - setIsReadReceipt
```
public void setIsReadReceipt(boolean value)
```
  - getFromConnectedAccounts
```
public StringList getFromConnectedAccounts()
```
    Gets the e-mail account names from which incoming messages must have been aggregated for the condition or exception to apply. To disable this predicate, empty the list.
  - getItemClasses
```
public StringList getItemClasses()
```
    Gets the item classes that must be stamped on incoming messages for the condition or exception to apply. To disable this predicate, empty the list.
  - getMessageClassifications
```
public StringList getMessageClassifications()
```
    Gets the message classifications that must be stamped on incoming messages for the condition or exception to apply. To disable this predicate, empty the list.
  - getNotSentToMe
```
public boolean getNotSentToMe()
```
    Gets or sets a value indicating whether the owner of the mailbox must NOT be a To recipient of the incoming messages for the condition or exception to apply.
  - setNotSentToMe
```
public void setNotSentToMe(boolean value)
```
  - getSentCcMe
```
public boolean getSentCcMe()
```
    Gets or sets a value indicating whether the owner of the mailbox must be a Cc recipient of incoming messages for the condition or exception to apply.
  - setSentCcMe
```
public void setSentCcMe(boolean value)
```
  - getSentOnlyToMe
```
public boolean getSentOnlyToMe()
```
    Gets or sets a value indicating whether the owner of the mailbox must be the only To recipient of incoming messages for the condition or exception to apply.
  - setSentOnlyToMe
```
public void setSentOnlyToMe(boolean value)
```
  - getSentToAddresses
```
public EmailAddressCollection getSentToAddresses()
```
    Gets the e-mail addresses incoming messages must have been sent to for the condition or exception to apply. To disable this predicate, empty the list.
  - getSentToMe
```
public boolean getSentToMe()
```
    Gets or sets a value indicating whether the owner of the mailbox must be a To recipient of incoming messages for the condition or exception to apply.
  - setSentToMe
```
public void setSentToMe(boolean value)
```
  - getSentToOrCcMe
```
public boolean getSentToOrCcMe()
```
    Gets or sets a value indicating whether the owner of the mailbox must be either a To or Cc recipient of incoming messages for the condition or exception to apply.
  - setSentToOrCcMe
```
public void setSentToOrCcMe(boolean value)
```
  - getSensitivity
```
public Sensitivity getSensitivity()
```
    Gets or sets the sensitivity that must be stamped on incoming messages for the condition or exception to apply. To disable this predicate, set it to null.
  - setSensitivity
```
public void setSensitivity(Sensitivity value)
```
  - getWithinDateRange
```
public RulePredicateDateRange getWithinDateRange()
```
    Gets the date range within which incoming messages must have been received for the condition or exception to apply. To disable this predicate, set both its Start and End property to null.
  - getWithinSizeRange
```
public RulePredicateSizeRange getWithinSizeRange()
```
    Gets the minimum and maximum sizes incoming messages must have for the condition or exception to apply. To disable this predicate, set both its MinimumSize and MaximumSize property to null.
  - tryReadElementFromXml
```
public boolean tryReadElementFromXml(EwsServiceXmlReader reader)
                              throws Exception
```
    Tries to read element from XML.
    
    Overrides:
    
    tryReadElementFromXml in class ComplexProperty
    
    Parameters:
    
    reader - The reader
    
    Returns:
    
    True if element was read.
    
    Throws:
    
    Exception
  - writeElementsToXml
```
public void writeElementsToXml(EwsServiceXmlWriter writer)
                        throws Exception
```
    Writes elements to XML.
    
    Overrides:
    
    writeElementsToXml in class ComplexProperty
    
    Parameters:
    
    writer - The writer.
    
    Throws:
    
    Exception
  - internalValidate
```
protected void internalValidate()
                         throws Exception
```
    Validates this instance.
    
    Overrides:
    
    internalValidate in class ComplexProperty
    
    Throws:
    
    Exception - the exception

Class RulePredicates

Constructor Summary

Method Summary

Methods inherited from class microsoft.exchange.webservices.data.property.complex.ComplexProperty

Methods inherited from class java.lang.Object

Constructor Detail

RulePredicates

Method Detail

getCategories

getContainsBodyStrings

getContainsHeaderStrings

getContainsRecipientStrings

getContainsSenderStrings

getContainsSubjectOrBodyStrings

getContainsSubjectStrings

getFlaggedForAction

setFlaggedForAction

getFromAddresses

getHasAttachments

setHasAttachments

getImportance

setImportance

getIsApprovalRequest

setIsApprovalRequest

getIsAutomaticForward

setIsAutomaticForward

getIsAutomaticReply

setIsAutomaticReply

getIsEncrypted

setIsEncrypted

getIsMeetingRequest

setIsMeetingRequest

getIsMeetingResponse

setIsMeetingResponse

getIsNonDeliveryReport

setIsNonDeliveryReport

getIsPermissionControlled

setIsPermissionControlled

getIsSigned

setIsSigned

getIsVoicemail

setIsVoicemail

getIsReadReceipt

setIsReadReceipt

getFromConnectedAccounts

getItemClasses

getMessageClassifications

getNotSentToMe

setNotSentToMe

getSentCcMe

setSentCcMe

getSentOnlyToMe

setSentOnlyToMe

getSentToAddresses

getSentToMe

setSentToMe

getSentToOrCcMe

setSentToOrCcMe

getSensitivity

setSensitivity

getWithinDateRange

getWithinSizeRange

tryReadElementFromXml

writeElementsToXml

internalValidate