BulkMail send: Difference between revisions

← Older edit

VisualWikitext

Latest revision as of 02:52, 9 July 2020

BulkMail_send

Send bulk mail

Syntax

BulkMail_send(bulkMailResourceId[,MaxToSend[,schedule]])

Arguments

bulkMailResourceId: Is a numeric (non-decimal) expression. It is the bulkmail Resource Id.

MaxToSend: Is a numeric (non-decimal) expression. It is the max email which send.

schedule: Use the given schedule to send the mails. It is CatTaskSchedule object see more at CatTaskInstantSchedule, CatTaskSpecificTimeSchedule, CatTaskNeverSchedule

Return type

Returns CatTask instance id of the sending

Example with maxTosend

number bulkMailResourceId = 9399212;

BulkMail_send(bulkMailResourceId);

BulkMail_send(bulkMailResourceId, 20);// 20 is max email which will send

Example with schedule bulkmail

//schedule for send bulkmail at a specific time
number bulkmailRId = 15562486;
number maxToSend = 1;
DateTime dt = new DateTime("2017/05/31 03:10");
CatTaskSpecificTimeSchedule schedule  = new CatTaskSpecificTimeSchedule(dt);
BulkMail_send(bulkmailRId, maxToSend, schedule);//Returns CatTask instance id: 104701 (CatTaskMetaDataId: 54184)

//schedule for send bulkmail now
number bulkmailRId = 15562486;
number maxToSend = 1;
CatTaskInstantSchedule schedule  = new CatTaskInstantSchedule();
BulkMail_send(bulkmailRId, maxToSend, schedule);//Returns CatTask instance id: 104702 (CatTaskMetaDataId: 54185)

//stop schedule of sending bulkmail
CatTaskScheduleHelper csHelper = new CatTaskScheduleHelper();
number taskId = 104701;
CatTaskNeverSchedule schedule = new CatTaskNeverSchedule();
csHelper.RescheduleByInstanceId(taskId, schedule);

@@ Line 2: / Line 2: @@
 {{HelpFiles}}
-====BulkMail_send====
+==== BulkMail_send ====
 Send bulk mail
@@ Line 8: / Line 8: @@
 '''Syntax'''
-BulkMail_send(bulkMailResourceId)
+BulkMail_send(bulkMailResourceId[,''MaxToSend''[,schedule]])
 '''Arguments'''
-''bulkMailResourceId:'' is a number
+''bulkMailResourceId:'' Is a numeric (non-decimal) expression. It is the bulkmail Resource Id.
+''MaxToSend:'' Is a numeric (non-decimal) expression. It is the max email which send.
+''schedule:'' Use the given schedule to send the mails. It is CatTaskSchedule object see more at [[CatTaskInstantSchedule class|CatTaskInstantSchedule]], [[CatTaskSpecificTimeSchedule class|CatTaskSpecificTimeSchedule]], [[CatTaskNeverSchedule class|CatTaskNeverSchedule]]
 '''Return type'''
-empty
+Returns CatTask instance id of the sending
-'''Example'''
+'''Example with maxTosend'''
+<source lang="javascript">
 number bulkMailResourceId = 9399212;
 BulkMail_send(bulkMailResourceId);
-BulkMail_save(newBM);
+BulkMail_send(bulkMailResourceId, 20);// 20 is max email which will send
+</source>
+'''Example with schedule bulkmail'''
+<source lang="javascript">
+//schedule for send bulkmail at a specific time
+number bulkmailRId = 15562486;
+number maxToSend = 1;
+DateTime dt = new DateTime("2017/05/31 03:10");
+CatTaskSpecificTimeSchedule schedule  = new CatTaskSpecificTimeSchedule(dt);
+BulkMail_send(bulkmailRId, maxToSend, schedule);//Returns CatTask instance id: 104701 (CatTaskMetaDataId: 54184)
-'''Availability'''
+//schedule for send bulkmail now
+number bulkmailRId = 15562486;
+number maxToSend = 1;
+CatTaskInstantSchedule schedule  = new CatTaskInstantSchedule();
+BulkMail_send(bulkmailRId, maxToSend, schedule);//Returns CatTask instance id: 104702 (CatTaskMetaDataId: 54185)
-Version 5.8
+//stop schedule of sending bulkmail
-__NOTOC__
+CatTaskScheduleHelper csHelper = new CatTaskScheduleHelper();
-<!-- imported from file: 7599.htm-->
+number taskId = 104701;
+CatTaskNeverSchedule schedule = new CatTaskNeverSchedule();
+csHelper.RescheduleByInstanceId(taskId, schedule);
+</source>