OOQL language mail

provide internal or external mail management


send - send a new (internal/external) email message

  mail
send Mail_RecipientList [Mail_RecipientListCC ] [Mail_RecipientListBCC] subject GenericValue
                                     body GenericValue {attach ObjectIdName } {file FileName };

show - print an internal email message (identified by its id)

  mail
show GenericString [Mail_GetOption] [[!/not] markread] [Token_Option] [ExportFile_Option];

list - list messages from a user internal mailbox

  mail
list [Mail_GetOption] [Token_Option] [ExportFile_Option];

remove - delete an internal email message (identified by its id)

  mail
remove GenericString ;


Mail_RecipientList
to Mail_Recipient { , Mail_Recipient }

Mail_RecipientListCC
cc Mail_Recipient { , Mail_Recipient }

Mail_RecipientListBCC
bcc Mail_Recipient { , Mail_Recipient }

Mail_Recipient
user[ AdminName ]
team[ AdminName ]
assignment[ AdminName ]

Mail_GetOption
get [Mail_GetBasicOption]
   
  Mail_GetBasicOption
  { Mail_GetBasicToken [as IDENTIFIER] { Mail_GetBasicToken [as IDENTIFIER] } }
  Mail_GetBasicToken [as IDENTIFIER]
     
    Mail_GetBasicToken
    id  
    name  
    subject  
    body  
    sender  
    date  
    attach [ . Object_GetBasicOption ]
    to  
    cc  
    read  


KEYWORDs
assignment addressee user role; if the assignment has no email address the message will be sent to each related user
attach object(s) attached to the email message
bcc blind carbon copy recipients (users / teams /assignments)
body the text of the email message
cc carbon copy recipients (users / teams /assignments)
date the mail sent date
file local path for attachement file(s)
id id of an internal email message
name id of an internal email message
markread set if the [internal] email message is marked as read when you open it
read check if the [internal] message has been read
sender the sender user
subject the subject of the email message
team addressee team; if the team has no email address the message will be sent to each user
to message recipients (users / teams /assignments)
user addressee user; according to user definition, the email will be sent internally or externally


SAMPLES


mail send to user['name.surname'] cc user[User2],team[TM01] subject "Test mail" body "Message body" attach #00001-00000004 attach CL04 'ObjectName' 01 file "c:\document.txt" file "c:\PDFs\document.pdf";

mail list get { id subject };

mail show 000000B8 get { name sender attach.{class name revision } } token { "|" "." "-"} ;

mail list get { id attach.{class name revision } } token xml;

mail remove 000000B8 ;

common syntax

Common_GetBasicOption
Common_GetBasicToken [ as IDENTIFIER ]

Common_GetBasicToken
id  
name  
origdate  
moddate  
moduser  
description  
svnrev  
hidden  
image  
imagedata  
feature[ AdminName ] [. Feature_GetBasicOption]
feature[] [. Feature_GetBasicOption]
feature [. Feature_GetBasicOption]
application [. Menu_GetBasicOption]
super  
admintype  

Edit_Operator
add
remove

Edit_RefOperator
addbefore AdminName set
addafter AdminName set
add
remove
movebefore
moveafter

Edit_AddOperator
addbefore AdminName define
addafter AdminName define
append

Edit_MoveOperator
movebefore
moveafter

Event_Type
action
check

AdminPatternList
AdminNamePattern {, AdminNamePattern}

AdminNamePattern
*
PATTERNIDENTIFIER
STRINGVAL
AdminName

GenericPatternList
GenericPattern {, GenericPattern}

GenericPattern
*
IDENTIFIER
PATTERNIDENTIFIER
GenericValue

AdminActor
user AdminName
team AdminName
assignment AdminName

AdminName
IDENTIFIER
QUOTED_STRING
SQUOTED_STRING

GenericValue
DATETIME
GenericNumber
GenericString
BOOLEANVAL

GenericString
STRINGVAL
QUOTED_STRING
SQUOTED_STRING

GenericNumber
NUMBER
REALNUMBER

Filter_Option
moddate Date_Range
application AdminNamePattern

Date_Range
=  DATETIME  
!= DATETIME
 
<  DATETIME
 
>  DATETIME
 
<= DATETIME
 
>= DATETIME
 
in [ DATETIME , DATETIME ]
 
in ( DATETIME , DATETIME ]
 
in [ DATETIME , DATETIME )
 
in ( DATETIME , DATETIME )  

Token_Option
token { Token_Separator { Token_Separator } }
token Token_Separator

Token_Separator
QUOTED_STRING
SQUOTED_STRING
IDENTIFIER
STRINGVAL
json
json-
json+
xml
xml-
xml+

ExportFile_Option
exportfile FileName [append] [xml | json ]

ImportFile_Option
importfile FileName [xml | json |emxxml]

LogFile_Option
logfile FileName [append]

FileName
QUOTED_STRING
SQUOTED_STRING

basic elements
grammar rules
[ ] = optional element - only one item is allowed : ( 0 or 1 )
{ } = optional element - more than one is allowed : ( 0 or N )
/ = alternative
= one of ...
   
  all bold texts represent keywords or command syntax

IDVAL
#<5 dec digits [ 0-9 ]>-<8 hex digits [ 0-9 A-F ]>
  example:
  #00020-34F2A80E

COMMENT
// <any character until the end of the line(\n \r)>
  example:
  // My single line comment

LONGCOMMENT
/* <any character> */
 

example:
  /* My multi line comment starts here
  continue here
  and finish here */


DATETIME
<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits>
  examples:
   2009-12-23    2009/03/19   2009.11.14
<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits> <hours>:<minutes>:[<seconds>]
  examples:
   2009-12-23 10:23   2009/03/19 16:03:34  2009.11.14 00:20:04

NUMBER
[+-]<decimal digits [ 0-9 ]>
  examples:
   -1203   +276   25

BOOLEANVAL
true / false

REALNUMBER
[+-]<decimal digits [ 0-9 ]>.<decimal digits [ 0-9 ]>[E(+-)<esponent [0-9]>]
  example:
   -37.837   +2.3874   13.887   1.4862E-04

QUOTED_STRING
"<any character>"
  example:
   "my quoted string"

SQUOTED_STRING
'<any character>'
  example:
   'my single quoted string'

IDENTIFIER
<one or more of [ a-z A-Z ]><zero or more of [ a-z A-Z 0-9 _ ]>
  example:
   Var1    object_Name_02

VARIABLE
$<one o more of [ a-z A-Z 0-9 ]><zero or more of [ a-z A-Z 0-9 _ ]>
 

example:
   $1   $var_02    $1b


STRINGVAL
<one or more of [ a-z A-Z 0-9 -_ $ ? @ | ~ % & / = : + \ # ' ]>
  a string not recognized as identifier

PATTERNIDENTIFIER
<a string with * (match 0 or more characters) and ? (match 1 character) wildcards>
  example:
   mypa*er?_ide?ti*

© 2008-2015 MS Enterprise Solutions | Website Templates by IceTemplates.com
Please Read: Privacy Policy and Terms of Use