Difference between revisions of "BulkMail countRecipients"

From Catglobe Wiki
Jump to: navigation, search
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
 
{{HelpFiles}}
 
{{HelpFiles}}
  
====BulkMail_countRecipients====
+
==== BulkMail_countRecipients ====
  
Count the number of recipients when the bulk mail is sent (without sending it)
+
Count the number of recipients whom the bulk mail is not sent to
  
 
'''Syntax'''
 
'''Syntax'''
  
BulkMail_countRecipients(''bulkMailResourceId'')
+
BulkMail_countRecipients(''bulkMailResourceId''[,''MaxToSend''])
  
 
'''Arguments'''
 
'''Arguments'''
  
* ''bulkMailResourceId'': is a number expression. It is the bulk mail's resource id
+
*''bulkMailResourceId'': is a number expression. It is the bulk mail's resource id
 +
 
 +
''MaxToSend:'' Is a numeric (non-decimal) expression. It is the max email which send.
  
 
'''Return value'''
 
'''Return value'''
Line 20: Line 22:
 
'''Example'''
 
'''Example'''
  
''number n = BulkMail_countRecipients(12345);''
+
number bmId = 8637;
 +
 
 +
string guid = getResourceGuid(Resource_Type_BulkMail, bmId);
 +
 
 +
number bmRId = getResourceUniqueIdFromGuid(guid);
 +
 
 +
number n = BulkMail_countRecipients(bmRId);
 +
 
 +
number m = BulkMail_countRecipients(bmRId, 20); // count 20 recipients
 +
 
 +
print(n);
  
 
'''Availability'''
 
'''Availability'''
  
Version 5.6
+
Version 5.6 __NOTOC__
__NOTOC__
 
 
<!-- imported from file: 6244.htm-->
 
<!-- imported from file: 6244.htm-->

Latest revision as of 09:40, 1 July 2016


BulkMail_countRecipients

Count the number of recipients whom the bulk mail is not sent to

Syntax

BulkMail_countRecipients(bulkMailResourceId[,MaxToSend])

Arguments

  • bulkMailResourceId: is a number expression. It is the bulk mail's resource id

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

Return value

number

Example

number bmId = 8637;

string guid = getResourceGuid(Resource_Type_BulkMail, bmId);

number bmRId = getResourceUniqueIdFromGuid(guid);

number n = BulkMail_countRecipients(bmRId);

number m = BulkMail_countRecipients(bmRId, 20); // count 20 recipients

print(n);

Availability

Version 5.6