Difference between revisions of "EmailAccount class"

From Catglobe Wiki
Jump to: navigation, search
Line 4: Line 4:
 
|Constructors=
 
|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=type|Description=2: WebShop, 3: Support}}
+
{{CGscriptParameters_Template|Type=int|Name=type|Description=2: WebShop, 3: Support}}
 
|Description=Instanciate an existing email account}}
 
|Description=Instanciate an existing email account}}
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=type|Description=0: Resource, 1: GlobalEmail, 2: WebShop, 3: Support|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=id|Description=Resource id or global email id. Unused for webshop and support types}}
+
{{CGscriptParameters_Template|Type=int|Name=type|Description=0: Resource, 1: GlobalEmail, 2: WebShop, 3: Support|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=id|Description=Resource id or global email id. Unused for webshop and support types}}
 
|Description=Instanciate an existing email account}}
 
|Description=Instanciate an existing email account}}
 
|Methods=
 
|Methods=
Line 19: Line 19:
 
{{CGscriptProperties_Template|ReturnType=bool|Name=IsGEA|HasGetter=1|Description=Is the alias for a Global Email or not.}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=IsGEA|HasGetter=1|Description=Is the alias for a Global Email or not.}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=number|Name=ResourceId|HasGetter=1|Description=Id of account}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=ResourceId|HasGetter=1|Description=Id of account}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=UseActualEmail|HasGetter=1|HasSetter=1|Description=If true, the from email will be ActualMail. Otherwise, it will be Address.}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=UseActualEmail|HasGetter=1|HasSetter=1|Description=If true, the from email will be ActualMail. Otherwise, it will be Address.}}
 
}}
 
}}
 +
 +
=== Examples<br/> ===
 +
 +
<source lang="javascript">
 +
number WebShop=2;
 +
number Support=3;
 +
EmailAccount a = new EmailAccount(Support);
 +
print(a.ActualEmail);
 +
print(a.Address);
 +
print(a.Alias);
 +
print(a.Default);
 +
print(a.ResourceId);
 +
 +
//Result:
 +
 +
info@voxmeter.dk
 +
Support@voxmeter.catglobe.com
 +
Support
 +
False
 +
832
 +
</source>

Revision as of 10:11, 13 October 2016

EmailAccount



Represents an email account.

Constructors

  • (int type "2: WebShop, 3: Support") - Instanciate an existing email account
  • (int type "0: Resource, 1: GlobalEmail, 2: WebShop, 3: Support", int id "Resource id or global email id. Unused for webshop and support types") - Instanciate an existing email account

Methods

  • Empty Save() - Save the Email Account
  • string ToString() - The string representation of the object.

Properties

  • string ActualEmail { get; set; } - Actual Email address
  • string Address { get; set; } - Email address
  • string Alias { get; set; } - Alias
  • bool Default { get; } - Is this the default email account for the resource.
  • bool IsGEA { get; } - Is the alias for a Global Email or not.
  • string ObjectTypeName { get; } - The name of the type of object.
  • int ResourceId { get; } - Id of account
  • TypeInformation TypeInformation { get; } - Get information about this class.
  • bool UseActualEmail { get; set; } - If true, the from email will be ActualMail. Otherwise, it will be Address.


Examples

number WebShop=2;
number Support=3;
EmailAccount a = new EmailAccount(Support);
print(a.ActualEmail);
print(a.Address);
print(a.Alias);
print(a.Default);
print(a.ResourceId);

//Result:

info@voxmeter.dk
Support@voxmeter.catglobe.com
Support
False
832