BulkMail class - Revision history

Administrator at 08:17, 12 May 2022

2022-05-12T08:17:28Z

← Older revision		Revision as of 08:17, 12 May 2022
Line 60:		Line 60:
	{{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>

Administrator at 04:17, 27 April 2022

2022-04-27T04:17:59Z

← Older revision		Revision as of 04:17, 27 April 2022
Line 13:		Line 13:
	\|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>resourceTemplateId</nowiki>\|Description=<nowiki>Id of bulkMail resource 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=

Administrator at 03:14, 27 April 2022

2022-04-27T03:14:57Z

Administrator at 06:47, 4 March 2022

2022-03-04T06:47:37Z

← Older revision		Revision as of 06:47, 4 March 2022
Line 1:		Line 1:
	~~[In progress]~~		{{CGscriptClass_Template
			\|Name=<nowiki>BulkMail</nowiki>
			\|Description=<nowiki>Represents a bulkMail.</nowiki>
			\|InheritsFrom=object\|Constructors=
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>bulkMailId</nowiki>\|Description=<nowiki>Id of bulkMail</nowiki>}}
			\|Description=<nowiki>Load existing bulkMail</nowiki>}}
			{{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>}}
			\|Description=<nowiki>Create bulkMail</nowiki>}}
			{{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>}}
			\|Description=<nowiki>Create bulkMail</nowiki>}}
			{{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>}}
			\|Description=<nowiki>Create bulkMail</nowiki>}}
			\|Methods=
			{{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>SendBulkMail</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>maxToSend</nowiki>\|Description=<nowiki>Max mail send, default is maximum (-1)</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isTest</nowiki>\|Description=<nowiki>Is test link, default is real</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isSyncronious</nowiki>\|Description=<nowiki>Type of send, default is not syncronious</nowiki>}}
			\|Description=<nowiki>Send bulkMail with full options</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendSyncronious</nowiki>\|Description=<nowiki>Send bulkMail syncronious with default options. MaxToSend = -1, Test = false.</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendWithCallback</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=Function\|Name=<nowiki>callback</nowiki>\|Description=<nowiki>Callback function</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>maxToSend</nowiki>\|Description=<nowiki>Max mail send, default maximum</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isTest</nowiki>\|Description=<nowiki>Is test link, default is real</nowiki>}}
			\|Description=<nowiki>Send bulkMail with callback, it is syncronious</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendWithSchedule</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=CatTaskSchedule\|Name=<nowiki>schedule</nowiki>\|Description=<nowiki>Use the given schedule instance to send the mails</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>maxToSend</nowiki>\|Description=<nowiki>Max mail send, default maximum</nowiki>}}
			\|Description=<nowiki>Send bulkMail with schedule</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetGroups</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>groupIds</nowiki>\|Description=<nowiki>Array of group id</nowiki>}}
			\|Description=<nowiki>Set groups to bulkMail</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetGroupsToBeRebuilt</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>groupIds</nowiki>\|Description=<nowiki>Array of group id</nowiki>}}
			\|Description=<nowiki>Set groups to be rebuilt to bulkMail</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetUsers</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>userIds</nowiki>\|Description=<nowiki>Array of user id</nowiki>}}
			\|Description=<nowiki>Set users to bulkMail</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
			\|Properties=
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>DependantBulkMail</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Dependant of the bulkMail</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\|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>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>MailTemplateId</nowiki>\|HasGetter=1\|Description=<nowiki>MailTemplateId Id of the bulkMail</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Name of the bulkMail</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>NoInOutQueue</nowiki>\|HasGetter=1\|Description=<nowiki>Number of mail in queue</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>NoOfSent</nowiki>\|HasGetter=1\|Description=<nowiki>Number of mail sent</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>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=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>}}
			}}

Administrator: Replaced content with "[In progress]"

2022-02-24T03:08:00Z

Replaced content with "[In progress]"

← Older revision		Revision as of 03:08, 24 February 2022
Line 1:		Line 1:
	~~{{CGscriptClass_Template~~		[In progress]
	~~\|Name=<nowiki>BulkMail</nowiki>~~
	~~\|Description=<nowiki>~~[In progress] ~~Represents a bulkMail.</nowiki>~~
	~~\|InheritsFrom=object\|Constructors=~~
	~~{{CGscriptConstructors_Template\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>bulkMailId</nowiki>\|Description=<nowiki>Id of bulkMail</nowiki>}}~~
	~~\|Description=<nowiki>Load existing bulkMail</nowiki>}}~~
	~~{{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>}}
	~~\|Description=<nowiki>Create bulkMail</nowiki>}}~~
	~~{{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>}}
	~~\|Description=<nowiki>Create bulkMail</nowiki>}}~~
	~~{{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>}}
	~~\|Description=<nowiki>Create bulkMail</nowiki>}}~~
	~~\|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=int\|Name=<nowiki>Send</nowiki>\|Description=<nowiki>Send bulkMail with default options. MaxToSend = -1, Test = false.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendBulkMail</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>maxToSend</nowiki>\|Description=<nowiki>Max mail send, default is maximum (-1)</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isTest</nowiki>\|Description=<nowiki>Is test link, default is real</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isSyncronious</nowiki>\|Description=<nowiki>Type of send, default is not syncronious</nowiki>}}
	~~\|Description=<nowiki>Send bulkMail with full options</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendSyncronious</nowiki>\|Description=<nowiki>Send bulkMail syncronious with default options. MaxToSend = -1, Test = false.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendWithCallback</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=Function\|Name=<nowiki>callback</nowiki>\|Description=<nowiki>Callback function</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>maxToSend</nowiki>\|Description=<nowiki>Max mail send, default maximum</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isTest</nowiki>\|Description=<nowiki>Is test link, default is real</nowiki>}}
	~~\|Description=<nowiki>Send bulkMail with callback, it is syncronious</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendWithSchedule</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=CatTaskSchedule\|Name=<nowiki>schedule</nowiki>\|Description=<nowiki>Use the given schedule instance to send the mails</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>maxToSend</nowiki>\|Description=<nowiki>Max mail send, default maximum</nowiki>}}
	~~\|Description=<nowiki>Send bulkMail with schedule</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetGroups</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>groupIds</nowiki>\|Description=<nowiki>Array of group id</nowiki>}}~~
	~~\|Description=<nowiki>Set groups to bulkMail</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetGroupsToBeRebuilt</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>groupIds</nowiki>\|Description=<nowiki>Array of group id</nowiki>}}~~
	~~\|Description=<nowiki>Set groups to be rebuilt to bulkMail</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetUsers</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>userIds</nowiki>\|Description=<nowiki>Array of user id</nowiki>}}~~
	~~\|Description=<nowiki>Set users to bulkMail</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}~~
	~~\|Properties=~~
	~~{{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 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=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=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Name of the bulkMail</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>NoInOutQueue</nowiki>\|HasGetter=1\|Description=<nowiki>Number of mail in queue</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>NoOfSent</nowiki>\|HasGetter=1\|Description=<nowiki>Number of mail sent</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>Priority</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Priority of the bulkMail (Normal, Low, High)</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>TemplateId</nowiki>\|HasGetter=1\|Description=<nowiki>TemplateId 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=Array of ints\|Name=<nowiki>UserIds</nowiki>\|HasGetter=1\|Description=<nowiki>UserIds of the bulkMail</nowiki>}}~~
	}}

Administrator at 07:45, 17 February 2022

2022-02-17T07:45:20Z

← Older revision		Revision as of 07:45, 17 February 2022
Line 1:		Line 1:
	{{CGscriptClass_Template		{{CGscriptClass_Template
	\|Name=<nowiki>BulkMail</nowiki>		\|Name=<nowiki>BulkMail</nowiki>
	\|Description=<nowiki>Represents a bulkMail.</nowiki>		\|Description=<nowiki>[In progress] Represents a bulkMail.</nowiki>
	\|InheritsFrom=object\|Constructors=		\|InheritsFrom=object\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=

Administrator: Created page with "{{CGscriptClass_Template |Name=BulkMail |Description=Represents a bulkMail. |InheritsFrom=object|Constructors= {{CGscriptConstructors_Templat..."

2022-02-17T07:42:09Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>BulkMail</nowiki> |Description=<nowiki>Represents a bulkMail.</nowiki> |InheritsFrom=object|Constructors= {{CGscriptConstructors_Templat..."

New page

{{CGscriptClass_Template
|Name=<nowiki>BulkMail</nowiki>
|Description=<nowiki>Represents a bulkMail.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>bulkMailId</nowiki>|Description=<nowiki>Id of bulkMail</nowiki>}}
|Description=<nowiki>Load existing bulkMail</nowiki>}}
{{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>}}
|Description=<nowiki>Create bulkMail</nowiki>}}
{{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>}}
|Description=<nowiki>Create bulkMail</nowiki>}}
{{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>}}
|Description=<nowiki>Create bulkMail</nowiki>}}
|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=int|Name=<nowiki>Send</nowiki>|Description=<nowiki>Send bulkMail with default options. MaxToSend = -1, Test = false.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>SendBulkMail</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>maxToSend</nowiki>|Description=<nowiki>Max mail send, default is maximum (-1)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTest</nowiki>|Description=<nowiki>Is test link, default is real</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isSyncronious</nowiki>|Description=<nowiki>Type of send, default is not syncronious</nowiki>}}
|Description=<nowiki>Send bulkMail with full options</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>SendSyncronious</nowiki>|Description=<nowiki>Send bulkMail syncronious with default options. MaxToSend = -1, Test = false.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>SendWithCallback</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>callback</nowiki>|Description=<nowiki>Callback function</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>maxToSend</nowiki>|Description=<nowiki>Max mail send, default maximum</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTest</nowiki>|Description=<nowiki>Is test link, default is real</nowiki>}}
|Description=<nowiki>Send bulkMail with callback, it is syncronious</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>SendWithSchedule</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=CatTaskSchedule|Name=<nowiki>schedule</nowiki>|Description=<nowiki>Use the given schedule instance to send the mails</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>maxToSend</nowiki>|Description=<nowiki>Max mail send, default maximum</nowiki>}}
|Description=<nowiki>Send bulkMail with schedule</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetGroups</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>groupIds</nowiki>|Description=<nowiki>Array of group id</nowiki>}}
|Description=<nowiki>Set groups to bulkMail</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetGroupsToBeRebuilt</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>groupIds</nowiki>|Description=<nowiki>Array of group id</nowiki>}}
|Description=<nowiki>Set groups to be rebuilt to bulkMail</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetUsers</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>userIds</nowiki>|Description=<nowiki>Array of user id</nowiki>}}
|Description=<nowiki>Set users to bulkMail</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{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 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=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=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Name of the bulkMail</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NoInOutQueue</nowiki>|HasGetter=1|Description=<nowiki>Number of mail in queue</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NoOfSent</nowiki>|HasGetter=1|Description=<nowiki>Number of mail sent</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>Priority</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Priority of the bulkMail (Normal, Low, High)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TemplateId</nowiki>|HasGetter=1|Description=<nowiki>TemplateId 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=Array of ints|Name=<nowiki>UserIds</nowiki>|HasGetter=1|Description=<nowiki>UserIds of the bulkMail</nowiki>}}
}}

← Older revision		Revision as of 03:08, 24 February 2022
Line 1:		Line 1:
	~~{{CGscriptClass_Template~~		[In progress]
	~~\|Name=<nowiki>BulkMail</nowiki>~~
	~~\|Description=<nowiki>~~[In progress] ~~Represents a bulkMail.</nowiki>~~
	~~\|InheritsFrom=object\|Constructors=~~
	~~{{CGscriptConstructors_Template\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>bulkMailId</nowiki>\|Description=<nowiki>Id of bulkMail</nowiki>}}~~
	~~\|Description=<nowiki>Load existing bulkMail</nowiki>}}~~
	~~{{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>}}
	~~\|Description=<nowiki>Create bulkMail</nowiki>}}~~
	~~{{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>}}
	~~\|Description=<nowiki>Create bulkMail</nowiki>}}~~
	~~{{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>}}
	~~\|Description=<nowiki>Create bulkMail</nowiki>}}~~
	~~\|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=int\|Name=<nowiki>Send</nowiki>\|Description=<nowiki>Send bulkMail with default options. MaxToSend = -1, Test = false.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendBulkMail</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>maxToSend</nowiki>\|Description=<nowiki>Max mail send, default is maximum (-1)</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isTest</nowiki>\|Description=<nowiki>Is test link, default is real</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isSyncronious</nowiki>\|Description=<nowiki>Type of send, default is not syncronious</nowiki>}}
	~~\|Description=<nowiki>Send bulkMail with full options</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendSyncronious</nowiki>\|Description=<nowiki>Send bulkMail syncronious with default options. MaxToSend = -1, Test = false.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendWithCallback</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=Function\|Name=<nowiki>callback</nowiki>\|Description=<nowiki>Callback function</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>maxToSend</nowiki>\|Description=<nowiki>Max mail send, default maximum</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isTest</nowiki>\|Description=<nowiki>Is test link, default is real</nowiki>}}
	~~\|Description=<nowiki>Send bulkMail with callback, it is syncronious</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>SendWithSchedule</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=CatTaskSchedule\|Name=<nowiki>schedule</nowiki>\|Description=<nowiki>Use the given schedule instance to send the mails</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>maxToSend</nowiki>\|Description=<nowiki>Max mail send, default maximum</nowiki>}}
	~~\|Description=<nowiki>Send bulkMail with schedule</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetGroups</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>groupIds</nowiki>\|Description=<nowiki>Array of group id</nowiki>}}~~
	~~\|Description=<nowiki>Set groups to bulkMail</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetGroupsToBeRebuilt</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>groupIds</nowiki>\|Description=<nowiki>Array of group id</nowiki>}}~~
	~~\|Description=<nowiki>Set groups to be rebuilt to bulkMail</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetUsers</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>userIds</nowiki>\|Description=<nowiki>Array of user id</nowiki>}}~~
	~~\|Description=<nowiki>Set users to bulkMail</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}~~
	~~\|Properties=~~
	~~{{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 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=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=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Name of the bulkMail</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>NoInOutQueue</nowiki>\|HasGetter=1\|Description=<nowiki>Number of mail in queue</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>NoOfSent</nowiki>\|HasGetter=1\|Description=<nowiki>Number of mail sent</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>Priority</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Priority of the bulkMail (Normal, Low, High)</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>TemplateId</nowiki>\|HasGetter=1\|Description=<nowiki>TemplateId 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=Array of ints\|Name=<nowiki>UserIds</nowiki>\|HasGetter=1\|Description=<nowiki>UserIds of the bulkMail</nowiki>}}~~
	}}

← Older revision		Revision as of 03:14, 27 April 2022
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=string\|Name=<nowiki>fromEmail</nowiki>\|Description=<nowiki>Prefix existing global email by name. The part before @</nowiki>}}
	\|Description=<nowiki>Create bulkMail</nowiki>}}		\|Description=<nowiki>Create bulkMail</nowiki>}}
	\|Methods=		\|Methods=
Line 44:		Line 44:
	{{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>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=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\|Description=<nowiki>EmailAccount used to send</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>}}
Line 56:		Line 56:
	{{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 (0: Bulkmail_Priority_Normal, 1: Bulkmail_Priority_Low, 2: Bulkmail_Priority_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>}}
	}}		}}