BulkMail

Represents a bulkMail.

Inherits from object

(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 bulkMailTemplateId "Id of bulkMail template") - Create bulkMail
(string name "Name of bulkMail", int parentId "Parent of bulkMail", int mailTemplateId "Id of mail template", int bulkMailTemplateId "Id of bulkMail template", string fromEmail "Prefix existing global email by name. The part before @") - Create bulkMail

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.

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; } - 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 TemplateId { get; } - TemplateId Id of the bulkMail
(From object) TypeInformation TypeInformation { get; } - Get information about this class.
Array of int UserIds { get; } - UserIds of the bulkMail

BulkMail class