|
|
| 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>}}
| |
| }}
| |
