BulkMail new
BulkMail_new
Create new bulk mail object
Syntax
BulkMail_new(bulkMailName, parentResourceId, mailTemplateResourceId)
or
BulkMail_new( bulkMailName, parentResourceId, mailTemplateResourceId , bulkMailTemplateResourceId)
Arguments
- bulkMailName: is string. It is the name of new bulkMail
- parentResourceId: is number. It is parent resource id of the new bulkMail
- mailTemplateResourceId: is number. It is the mail template resource Id gotten from Communicator template
- bulkMailTemplateResourceId: is number. It is bulkMail template resource Id
Return value
Array which is BulkMail object:
|
Index |
Data type |
Value |
|
BULKMAIL_RESOURCE_ID |
number |
0 |
|
BULKMAIL_NAME |
number |
Entered value |
|
BULKMAIL_PARENT_RESOURCE_ID |
string |
Entered value |
|
BULKMAIL_TEMPLATE_RESOURCE_ID |
number |
if it is not specified explicitly in the constructor as a parameter, then get default bulk mail template |
|
BULKMAIL_MAIL_TEMPLATE_RESOURCE_ID |
number |
Entered value |
|
BULKMAIL_EMAIL_ACCOUNT |
string |
It will be the default private email inside the parent resource or the first global email in case there is no a default private email. If there is no any private and global email then it's "" |
|
BULKMAIL_USER_RESOURCE_IDS |
array |
{} |
|
BULKMAIL_GROUP_RESOURCE_IDS |
array |
{} |
|
BULKMAIL_GROUP_TO_BE_REBUILD_RESOURCE_IDS |
array |
{} |
|
BULKMAIL_PRIORITY |
number |
Normal There must be constants defined for 3 levels of priority: 0: Bulkmail_Priority_Normal 1: Bulkmail_Priority_Low 2: Bulkmail_Priority_High |
|
BULKMAIL_NO_IN_OUT_QUEUE |
Number (read only) |
Default is 0 |
|
BULKMAIL_NO_OF_SENT |
Number (read only) |
Default is 0 |
|
BULKMAIL_DEPENDANT_BULKMAIL |
number |
|
|
BULKMAIL_SELECTED_HISTORY |
array |
|
|
BULKMAIL_SELECTED_RECIPIENTS |
|
Example
string bulkMailName = "TestBulkMail";
number parentResourceId = 34778803;
number mailTemplateResourceId = 501537;
array newBM = BulkMail_new(bulkMailName, parentResourceId, mailTemplateResourceId);
print(newBM); // {27,0,TestBulkMail,34778803,34409968,501537,Administrator@mycatinet.catglobe.com,{},{},{},0,0,0}
Availability
Version 5.8
