BulkMail new: Difference between revisions

← Older edit Newer edit →

VisualWikitext

Revision as of 08:09, 1 February 2012

BulkMail_new

Create new bulk mail object

Syntax

BulkMail_new(bulkMailName, parentResourceId, mailTemplateId)

or

BulkMail_new( bulkMailName, parentResourceId, mailTemplateId , bulkMailTemplateResourceId)

Arguments

bulkMailName: is string. It is the name of new bulkMail
parentResourceId: is number. It is parent resource id of the new bulkMail
mailTemplateId: 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: Bulkmail_Priority_Low Bulkmail_Priority_Normal Bulkmail_Priority_High
BULKMAIL_NO_IN_OUT_QUEUE	Number (read only)	Default is 0
BULKMAIL_NO_OF_SENT	Number (read only)	Default is 0

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

@@ Line 1: / Line 1: @@
-[[Category:Email_and_SMS_Functions]]
+{{HelpFiles}}
-{{HelpFiles}}
-====BulkMail_new====
+==== BulkMail_new  ====
 Create new bulk mail object
 '''Syntax'''
 BulkMail_new(bulkMailName, parentResourceId, mailTemplateId)
 or
 BulkMail_new( bulkMailName, parentResourceId, mailTemplateId , bulkMailTemplateResourceId)
 '''Arguments'''
-* bulkMailName: is string. It is the name of new bulkMail
+*bulkMailName: is string. It is the name of new bulkMail
-* parentResourceId: is number. It is parent resource id of the new bulkMail
+*parentResourceId: is number. It is parent resource id of the new bulkMail
-* mailTemplateId: is number. It is the mail template resource Id gotten from Communicator template
+*mailTemplateId: is number. It is the mail template resource Id gotten from Communicator template
-* bulkMailTemplateResourceId: is number. It is bulkMail template resource Id
+*bulkMailTemplateResourceId: is number. It is bulkMail template resource Id
 '''Return value'''
 Array which is BulkMail object:
-{| class="tableintopic" style="border-collapse: collapse" width="1067" cellpadding="2"
+{| width="1067" cellpadding="2" class="tableintopic" style="border-collapse: collapse"
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" bgcolor="#C0C0C0" |
+| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
 '''Index'''
-| style="border: 1px solid #010101" width="356" bgcolor="#C0C0C0" |
-'''Data type'''
+| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" bgcolor="#C0C0C0" |
+'''Data type'''
-'''Value'''
+| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |
+'''Value'''
 |- align="left" valign="top"
 | width="356" style="border: 1px solid #010101" |
 BULKMAIL_RESOURCE_ID
-| width="356" style="border: 1px solid #010101" |
-number
+| width="356" style="border: 1px solid #010101" |
-| width="356" style="border: 1px solid #010101" |
+number
+| width="356" style="border: 1px solid #010101" |
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_NAME
-| style="border: 1px solid #010101" width="356" |
-number
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+number
-Entered value
+| width="356" style="border: 1px solid #010101" |
+Entered value
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_PARENT_RESOURCE_ID
-| style="border: 1px solid #010101" width="356" |
-string
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+string
-Entered value
+| width="356" style="border: 1px solid #010101" |
+Entered value
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_TEMPLATE_RESOURCE_ID
-| style="border: 1px solid #010101" width="356" |
-number
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+number
-if it is not specified explicitly in the constructor as a parameter, then get default bulk mail template
+| width="356" style="border: 1px solid #010101" |
+if it is not specified explicitly in the constructor as a parameter, then get default bulk mail template
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_MAIL_TEMPLATE_RESOURCE_ID
-| style="border: 1px solid #010101" width="356" |
-number
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+number
-Entered value
+| width="356" style="border: 1px solid #010101" |
+Entered value
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_EMAIL_ACCOUNT
-| style="border: 1px solid #010101" width="356" |
-string
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+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 ""
+| width="356" style="border: 1px solid #010101" |
+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 ""
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_USER_RESOURCE_IDS
-| style="border: 1px solid #010101" width="356" |
-array
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+array
-{}
+| width="356" style="border: 1px solid #010101" |
+{}
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_GROUP_RESOURCE_IDS
-| style="border: 1px solid #010101" width="356" |
-array
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+array
-{}
+| width="356" style="border: 1px solid #010101" |
+{}
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_GROUP_TO_BE_REBUILD_RESOURCE_IDS
-| style="border: 1px solid #010101" width="356" |
-array
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+array
-{}
+| width="356" style="border: 1px solid #010101" |
+{}
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_PRIORITY
-| style="border: 1px solid #010101" width="356" |
-number
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+number
-Normal
-There must be constants defined for 3 levels of priority:
+| width="356" style="border: 1px solid #010101" |
+Normal
-Bulkmail_Priority_Low
+There must be constants defined for 3 levels of priority:
-Bulkmail_Priority_Normal
+Bulkmail_Priority_Low
+Bulkmail_Priority_Normal
+Bulkmail_Priority_High
-Bulkmail_Priority_High
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_NO_IN_OUT_QUEUE
-| style="border: 1px solid #010101" width="356" |
-Number (read only)
+| width="356" style="border: 1px solid #010101" |
-| style="border: 1px solid #010101" width="356" |
+Number (read only)
-Default is 0
+| width="356" style="border: 1px solid #010101" |
+Default is 0
 |- align="left" valign="top"
-| style="border: 1px solid #010101" width="356" |
+| width="356" style="border: 1px solid #010101" |
 BULKMAIL_NO_OF_SENT
-| style="border: 1px solid #010101" width="356" |
-Number (read only)
-| style="border: 1px solid #010101" width="356" |
-Default is 0
-'''Example'''
+| width="356" style="border: 1px solid #010101" |
+Number (read only)
-string bulkMailName = "TestBulkMail";
+| width="356" style="border: 1px solid #010101" |
+Default is 0 <br> <!-- imported from file: 7597.htm-->
-number parentResourceId = 34778803;
+|}
-number mailTemplateResourceId = 501537;
+'''Example'''
-array newBM = BulkMail_new(bulkMailName, parentResourceId, mailTemplateResourceId);
+string bulkMailName = "TestBulkMail";
-print(newBM); // {27,0,TestBulkMail,34778803,34409968,501537,Administrator@mycatinet.catglobe.com,{},{},{},0,0,0}
+number parentResourceId = 34778803;
+number mailTemplateResourceId = 501537;
-'''Availability'''
+array newBM = BulkMail_new(bulkMailName, parentResourceId, mailTemplateResourceId);
-Version 5.8
+print(newBM); // {27,0,TestBulkMail,34778803,34409968,501537,Administrator@mycatinet.catglobe.com,{},{},{},0,0,0}
-__NOTOC__
-<!-- imported from file: 7597.htm-->
+<br>Availability
+Version 5.8 __NOTOC__ <br>
+[[Category:Email_and_SMS_Functions]]