BulkMail class

BulkMail

Represents a bulkMail.

Parent class

Inherits from object

Constructors

• (int bulkMailId "Id of bulkMail") - Load existing bulkMail
  
• (string name "Name of bulkMail", int parentId "Parent of bulkMail", int mailTemplateId "Id of mail template") - Create bulkMail
  
• (string name "Name of bulkMail", int parentId "Parent of bulkMail", int mailTemplateId "Id of mail template", int resourceTemplateId "Id of bulkMail resource template") - Create bulkMail
  
• (string name "Name of bulkMail", int parentId "Parent of bulkMail", int mailTemplateId "Id of mail template", int resourceTemplateId "Id of bulkMail resource template", EmailAccount fromEmail "from email account") - Create bulkMail
  

Methods

• Empty Save() - Save bulkMail
  
• int Send() - Send bulkMail with default options. MaxToSend = -1, Test = false.
  
• int SendBulkMail(int maxToSend "Max mail send, default is maximum (-1)", bool isTest "Is test link, default is real", bool isSyncronious "Type of send, default is not syncronious") - Send bulkMail with full options
  
• int SendSyncronious() - Send bulkMail syncronious with default options. MaxToSend = -1, Test = false.
  
• int SendWithCallback(Function callback "Callback function", int maxToSend "Max mail send, default maximum", bool isTest "Is test link, default is real") - Send bulkMail with callback, it is syncronious
  
• int SendWithSchedule(CatTaskSchedule schedule "Use the given schedule instance to send the mails", int maxToSend "Max mail send, default maximum") - Send bulkMail with schedule
  
• Empty SetGroups(Array of int groupIds "Array of group id") - Set groups to bulkMail
  
• Empty SetGroupsToBeRebuilt(Array of int groupIds "Array of group id") - Set groups to be rebuilt to bulkMail
  
• Empty SetUsers(Array of int userIds "Array of user id") - Set users to bulkMail
  
• (From object) string ToString() - The string representation of the object.
  

Properties

• int DependantBulkMail { get; set; } - Dependant of the bulkMail
  
• array DependantSelectedHistories { get; set; } - selected history of the dependant bulkMail, return array of BulkMailHistory object
  
• bool DependantSendToCompleted { get; set; } - Dependant bulkMail completed status
  
• bool DependantSendToNotStarted { get; set; } - Dependant bulkMail not start status
  
• bool DependantSendToPartly { get; set; } - Dependant bulkMail partly status
  
• EmailAccount From { get; set; } - EmailAccount used to send
  
• Array of int GroupIds { get; } - GroupIds of the bulkMail
  
• Array of int GroupRebuildIds { get; } - GroupIds to be rebuild before sent bulkMail
  
• array History { get; } - History of the bulkMail, return array of BulkMailHistory object
  
• int Id { get; } - Id of the bulkMail
  
• int MailTemplateId { get; } - MailTemplateId Id of the bulkMail
  
• string Name { get; set; } - Name of the bulkMail
  
• int NoInOutQueue { get; } - Number of mail in queue
  
• int NoOfSent { get; } - Number of mail sent
  
• string ObjectTypeName { get; } - The name of the type of object.
  
• int ParentId { get; } - Parent Id of the bulkMail
  
• int Priority { get; set; } - Priority of the bulkMail (0: Bulkmail_Priority_Normal, 1: Bulkmail_Priority_Low, 2: Bulkmail_Priority_High)
  
• int ResourceTemplateId { get; } - ResourceTemplateId Id of the bulkMail
  
• (From object) TypeInformation TypeInformation { get; } - Get information about this class.
  
• Array of int UserIds { get; } - UserIds of the bulkMail
  

Examples

//*** create Bulkmail***//

string bulkmailName = "test";
number parentId = 17145420;
number mailTemplateId = 17146733;
number resourceTemplateId = 2079;
EmailAccount fromEmail = new EmailAccount ("panel");
BulkMail bm = new BulkMail (bulkmailName, parentId , mailTemplateId, resourceTemplateId, fromEmail);
//bm.SetUsers ({....});
//bm.SetGroups({...});
//bm.SetGroupsToBeRebuilt({...});
bm.Save();

//*** create Dependent Bulkmail***//

string bulkmailName = "test";
number parentId = 17145420;
number mailTemplateId = 17146733;
number resourceTemplateId = 17146732;//resource template with dependent true
EmailAccount fromEmail = new EmailAccount ("panel");
BulkMail bm = new BulkMail (bulkmailName, parentId , mailTemplateId, resourceTemplateId, fromEmail);
number dependantBulkmailId = 17146766;
bm.DependantBulkMail = dependantBulkmailId;
bm.DependantSelectedHistories = new BulkMail (dependantBulkmailId).History;
bm.DependantSendToNotStarted = true;
bm.DependantSendToPartly = true;
bm.DependantSendToCompleted = false;
bm.Save();

//*** send Bulkmail ***//

new BulkMail(bulkmailId).Send(); //Returns CatTask instance id of the sending

//*** Send Bulkmail syncronious ***//

new BulkMail(bulkmailId).SendSyncronious(); //Return number of mails being sent

//*** SendBulkMaild ***//

new BulkMail(bulkmailId).SendBulkMail(maxToSend , isTest, isSyncronious);//Send bulkMail with full options

//*** SendWithCallback***//

new BulkMail(bulkmailId).SendWithCallback(function(number nrSending) {
	bool hasEnough = false;
	if (!hasEnough) throw (nrSending);
}, maxToSend, isTest);

//*** SendWithSchedule ***//

new BulkMail(bulkmailId).SendWithSchedule(new CatTaskSpecificTimeSchedule(new DateTime()), maxToSend);