Difference between revisions of "EmailTemplate class"
Nguyenduyan (talk | contribs) |
|||
| Line 2: | Line 2: | ||
|Name=<nowiki>EmailTemplate</nowiki> | |Name=<nowiki>EmailTemplate</nowiki> | ||
|Description=<nowiki>Represents an email account.</nowiki> | |Description=<nowiki>Represents an email account.</nowiki> | ||
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceId</nowiki>|Description=<nowiki>The resource id of existing template</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceId</nowiki>|Description=<nowiki>The resource id of existing template</nowiki>}} | ||
| Line 14: | Line 14: | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Which resource to store the emails under</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>emails</nowiki>|Description=<nowiki>List of emails to send test mail to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>backupUserResourceId</nowiki>|Description=<nowiki>In case an email doesnt have a user, revert to showing this users info in the mail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=EmailAccount|Name=<nowiki>from</nowiki>|Description=<nowiki>From address</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Which resource to store the emails under</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>emails</nowiki>|Description=<nowiki>List of emails to send test mail to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>backupUserResourceId</nowiki>|Description=<nowiki>In case an email doesnt have a user, revert to showing this users info in the mail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=EmailAccount|Name=<nowiki>from</nowiki>|Description=<nowiki>From address</nowiki>}} | ||
|Description=<nowiki>Merge emails and send as test</nowiki>}} | |Description=<nowiki>Merge emails and send as test</nowiki>}} | ||
| − | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>CreatedDate</nowiki>|HasGetter=1|Description=<nowiki>Get the time of creation.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>CreatedDate</nowiki>|HasGetter=1|Description=<nowiki>Get the time of creation.</nowiki>}} | ||
| Line 25: | Line 25: | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ResourceName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get the resource name.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ResourceName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get the resource name.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>SubjectDefaultLanguage</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the default language subject.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>SubjectDefaultLanguage</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the default language subject.</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|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>}} |
|StaticMethods= | |StaticMethods= | ||
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>EmailTemplate_getAllFromParent</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>EmailTemplate_getAllFromParent</nowiki>|Parameters= | ||
Revision as of 08:02, 2 July 2020
EmailTemplate
Represents an email account.
Parent class
Inherits from object
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
- 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
- (From object) 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.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Static Methods
- array EmailTemplate_getAllFromParent(int parentResourceId "The resource id of existing template") - Find all mail template that are children on the given resource
(See more at: EmailTemplate_getAllFromParent)
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:
//Ex for using SendTestLinks
EmailTemplate et = new EmailTemplate (15550048);
EmailAccount acc = new EmailAccount("antest");
array toEmails = {
"a1@maysunshine.vn",
"a2@maysunshine.vn",
"a3@maysunshine.vn",
"a4@maysunshine.vn"
};
et.SendTestLinks(15548961, toEmails, 15548957, acc);
//if have no user on system map with the above email address, info of user 15548957 will be shown on the mail
