Difference between revisions of "EmailTemplate class"

From Catglobe Wiki
Jump to: navigation, search
Line 14: Line 14:
 
|Description=Find all mail template that are children on the given resource}}
 
|Description=Find all mail template that are children on the given resource}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Save the Email template}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Save the Email template}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=SendTestLinks|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=parentResourceId|Description=Which resource to store the emails under|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=emails|Description=List of emails to send test mail to|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=backupUserResourceId|Description=In case an email doesnt have a user, revert to showing this users info in the mail|Comma=,}}{{CGscriptParameters_Template|Type=EmailAccount|Name=from|Description=From address}}
 +
|Description=Merge emails and send as test}}
 
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
 
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
 
|Properties=
 
|Properties=

Revision as of 05:21, 5 December 2016

EmailTemplate



Represents an email account.

Constructors

  • (int resourceId "The resource id of existing template") - Instanciate an existing template
  • (string name "Name of the new template", int parentResourceId "The resource id of existing template") - Create a new template

Methods

  • array GetAllFromParent(int parentResourceId "The resource id of existing template") - Find all mail template that are children on the given resource
  • Empty Save() - Save the Email template
  • Empty SendTestLinks(int parentResourceId "Which resource to store the emails under", array emails "List of emails to send test mail to", int backupUserResourceId "In case an email doesnt have a user, revert to showing this users info in the mail", EmailAccount from "From address") - Merge emails and send as test
  • string ToString() - The string representation of the object.

Properties

  • DateTime CreatedDate { get; } - Get the time of creation.
  • string MessageDefaultLanguage { get; set; } - Get/Set the default language mail body.
  • DateTime ModifiedDate { get; } - Get the time of last modification.
  • string ObjectTypeName { get; } - The name of the type of object.
  • int ParentResourceId { get; set; } - Get the resource id.
  • int PrimaryKey { get; } - Get the primary id for use in ancient functions.
  • int ResourceId { get; } - Get the resource id.
  • string ResourceName { get; set; } - Get the resource name.
  • string SubjectDefaultLanguage { get; set; } - Get/Set the default language subject.
  • TypeInformation TypeInformation { get; } - Get information about this class.


Examples

EmailTemplate email = new EmailTemplate(15537524);
number parentRsId = email.ParentResourceId;

EmailTemplate emailNew = new EmailTemplate("BinhTESTNEW", parentRsId);
emailNew.SubjectDefaultLanguage = "newSub";
emailNew.MessageDefaultLanguage = "Newbody";
emailNew.Save();

Result:

Emailtemplate new.jpg