[This is preliminary documentation and is subject to change.]
Gets all the details corresponding to all the email rules set by the currently logged in user.
Namespace:
OfficeClip.DBLayer.DesktopAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public DataSet GetEmailRules( int userId ) |
Visual Basic (Declaration) |
---|
Public Function GetEmailRules ( _ userId As Integer _ ) As DataSet |
Visual C++ |
---|
public: DataSet^ GetEmailRules( int userId ) |
Parameters
- userId
- Type: System..::.Int32
Return Value
DataSet containg all the email rules information. This DataSet consists of a single DataTable with the following columns.- emailRuleId (System.Int32)Id of the email rule.
- UserId (System.Int32)Id of the user who has created this email rule. (Currently logged in user.)
- ConditionId (System.Int32)This is the type of the condition. Possible values are 1 or 2.
- ConditionFieldId (System.Int32)Id of the condition fields Values corresponding to the condition type 1 are: 0 = Contains 1 = Does not contain 2 = Contains word 3 = Starts with 4 = Ends with 5 = Equals Values corresponding to the condition type 2 are: 0 = Message size 1 = Attachments size
- ConditionValueId (System.Int32)Field id corresponding to the condition id. Field values corresponding to fields of condition type 1 are: 0 = From Address 1 = From name 2 = Subject 3 = Text 4 = To or CC 5 = Account Field values corresponding to fields of condition type 2 are: 0 = Is greater than 1 = Is less than
- ConditionValue (System.String)Value specified by the user to match the condition.
- ActionId (System.Int32)Id of the action to be taken if the value specified by the user matches the condition. 1 = Move the email to a specific folder 2 = Mark the email message as high priority 3 = Notify the user of the email in OfficeClip alerts
- ActionValue (System.Int32)This contains the email folder in which the user wishes the email to be moved if action id chosen is 1.
- RuleOrderNumber (System.Int32)This determines the order in which a particular rule will be processed.