Difference between revisions of "BulkMail class"
| 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= | + | {{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= | ||
Revision as of 05:17, 27 April 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
