Difference between revisions of "BulkMail send"

From Catglobe Wiki
Jump to: navigation, search
Line 8: Line 8:
 
'''Syntax'''
 
'''Syntax'''
  
BulkMail_send(bulkMailResourceId[,''MaxToSend''])
+
BulkMail_send(bulkMailResourceId[,''MaxToSend''][,schedule])
  
 
'''Arguments'''
 
'''Arguments'''
Line 15: Line 15:
  
 
''MaxToSend:'' Is a numeric (non-decimal) expression. It is the max email which send.
 
''MaxToSend:'' Is a numeric (non-decimal) expression. It is the max email which send.
 +
 +
''schedule:'' CatTaskSchedule object (CatTaskInstantSchedule, CatTaskSpecificTimeSchedule, CatTaskNeverSchedule)
  
 
'''Return type'''
 
'''Return type'''
  
empty
+
Returns CatTask instance id
 
 
'''Example'''
 
  
 +
'''Example with maxTosend'''
 +
<source lang="javascript">
 
number bulkMailResourceId = 9399212;
 
number bulkMailResourceId = 9399212;
  
Line 28: Line 30:
 
BulkMail_send(bulkMailResourceId, 20);// 20 is max email which will send
 
BulkMail_send(bulkMailResourceId, 20);// 20 is max email which will send
  
<br/>'''Availability'''
+
</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)
 +
 
 +
//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 __NOTOC__
+
//stop schedule of sending bulkmail
<!-- imported from file: 7599.htm-->
+
CatTaskScheduleHelper csHelper = new CatTaskScheduleHelper();
 +
number taskId = 104701;
 +
CatTaskNeverSchedule schedule = new CatTaskNeverSchedule();
 +
csHelper.RescheduleByInstanceId(taskId, schedule);
 +
</source>

Revision as of 04:04, 31 May 2017



BulkMail_send

Send bulk mail

Syntax

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

Arguments

bulkMailResourceId:

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

schedule: CatTaskSchedule object (CatTaskInstantSchedule, CatTaskSpecificTimeSchedule, CatTaskNeverSchedule)

Return type

Returns CatTask instance id

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);