Difference between revisions of "BulkMail class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=<nowiki>BulkMail</nowiki> |Description=<nowiki>Represents a bulkMail.</nowiki> |InheritsFrom=object|Constructors= {{CGscriptConstructors_Templat...")
 
 
(5 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
|Description=<nowiki>Create bulkMail</nowiki>}}
 
|Description=<nowiki>Create bulkMail</nowiki>}}
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
−
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of bulkMail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Parent of bulkMail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>mailTemplateId</nowiki>|Description=<nowiki>Id of mail template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>bulkMailTemplateId</nowiki>|Description=<nowiki>Id of bulkMail template</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of bulkMail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Parent of bulkMail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>mailTemplateId</nowiki>|Description=<nowiki>Id of mail template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateId</nowiki>|Description=<nowiki>Id of bulkMail resource template</nowiki>}}
 
|Description=<nowiki>Create bulkMail</nowiki>}}
 
|Description=<nowiki>Create bulkMail</nowiki>}}
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
−
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of bulkMail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Parent of bulkMail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>mailTemplateId</nowiki>|Description=<nowiki>Id of mail template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>bulkMailTemplateId</nowiki>|Description=<nowiki>Id of bulkMail template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>fromEmail</nowiki>|Description=<nowiki>Prefix existing global email by name. The part before @</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of bulkMail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Parent of bulkMail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>mailTemplateId</nowiki>|Description=<nowiki>Id of mail template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateId</nowiki>|Description=<nowiki>Id of bulkMail resource template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=EmailAccount|Name=<nowiki>fromEmail</nowiki>|Description=<nowiki>from email account</nowiki>}}
 
|Description=<nowiki>Create bulkMail</nowiki>}}
 
|Description=<nowiki>Create bulkMail</nowiki>}}
 
|Methods=
 
|Methods=
−
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>History</nowiki>|Description=<nowiki>History of the bulkMail</nowiki>}}
 
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save bulkMail</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save bulkMail</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Send</nowiki>|Description=<nowiki>Send bulkMail with default options. MaxToSend = -1, Test = false.</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Send</nowiki>|Description=<nowiki>Send bulkMail with default options. MaxToSend = -1, Test = false.</nowiki>}}
Line 41: Line 40:
 
|Properties=
 
|Properties=
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>DependantBulkMail</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Dependant of the bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>DependantBulkMail</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Dependant of the bulkMail</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=EmailAccount|Name=<nowiki>From</nowiki>|HasGetter=1|Description=<nowiki>EmailAccount used to send</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>DependantSelectedHistories</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>selected history of the dependant bulkMail, return array of BulkMailHistory object</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToCompleted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Dependant bulkMail completed status</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToNotStarted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Dependant bulkMail not start status</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToPartly</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Dependant bulkMail partly status</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=EmailAccount|Name=<nowiki>From</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>EmailAccount used to send</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>GroupIds</nowiki>|HasGetter=1|Description=<nowiki>GroupIds of the bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>GroupIds</nowiki>|HasGetter=1|Description=<nowiki>GroupIds of the bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>GroupRebuildIds</nowiki>|HasGetter=1|Description=<nowiki>GroupIds to be rebuild before sent bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>GroupRebuildIds</nowiki>|HasGetter=1|Description=<nowiki>GroupIds to be rebuild before sent bulkMail</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>History</nowiki>|HasGetter=1|Description=<nowiki>History of the bulkMail, return array of BulkMailHistory object</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Id of the bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Id of the bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MailTemplateId</nowiki>|HasGetter=1|Description=<nowiki>MailTemplateId Id of the bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MailTemplateId</nowiki>|HasGetter=1|Description=<nowiki>MailTemplateId Id of the bulkMail</nowiki>}}
Line 51: Line 55:
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ParentId</nowiki>|HasGetter=1|Description=<nowiki>Parent Id of the bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ParentId</nowiki>|HasGetter=1|Description=<nowiki>Parent Id of the bulkMail</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Priority</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Priority of the bulkMail (Normal, Low, High)</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Priority</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Priority of the bulkMail (0: Bulkmail_Priority_Normal, 1: Bulkmail_Priority_Low, 2: Bulkmail_Priority_High)</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TemplateId</nowiki>|HasGetter=1|Description=<nowiki>TemplateId Id of the bulkMail</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateId</nowiki>|HasGetter=1|Description=<nowiki>ResourceTemplateId Id of the bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>UserIds</nowiki>|HasGetter=1|Description=<nowiki>UserIds of the bulkMail</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>UserIds</nowiki>|HasGetter=1|Description=<nowiki>UserIds of the bulkMail</nowiki>}}
 
}}
 
}}
 +
 +
=== <span style="color:#DF8621">'''Examples'''</span> ===
 +
<source lang="javascript">
 +
//*** 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();
 +
</source>
 +
<source lang="javascript">
 +
//*** 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();
 +
</source>
 +
 +
<source lang="javascript">
 +
//*** send Bulkmail ***//
 +
 +
new BulkMail(bulkmailId).Send(); //Returns CatTask instance id of the sending
 +
</source>
 +
 +
<source lang="javascript">
 +
//*** Send Bulkmail syncronious ***//
 +
 +
new BulkMail(bulkmailId).SendSyncronious(); //Return number of mails being sent
 +
</source>
 +
 +
<source lang="javascript">
 +
//*** SendBulkMaild ***//
 +
 +
new BulkMail(bulkmailId).SendBulkMail(maxToSend , isTest, isSyncronious);//Send bulkMail with full options
 +
</source>
 +
 +
<source lang="javascript">
 +
//*** SendWithCallback***//
 +
 +
new BulkMail(bulkmailId).SendWithCallback(function(number nrSending) {
 +
bool hasEnough = false;
 +
if (!hasEnough) throw (nrSending);
 +
}, maxToSend, isTest);
 +
 +
</source>
 +
<source lang="javascript">
 +
//*** SendWithSchedule ***//
 +
 +
new BulkMail(bulkmailId).SendWithSchedule(new CatTaskSpecificTimeSchedule(new DateTime()), maxToSend);
 +
</source>

Latest revision as of 09:17, 12 May 2022

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);
Retrieved from "http://wiki.catglobe.com/index.php?title=BulkMail_class&oldid=240453"