Difference between revisions of "EmailAccount class"

From Catglobe Wiki
Jump to: navigation, search
Line 10: Line 10:
 
|Description=Instanciate an existing global email account by name}}
 
|Description=Instanciate an existing global email account by name}}
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
{{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}}
+
{{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 resource id. Unused for webshop and support types}}
 
|Description=Instanciate an existing email account}}
 
|Description=Instanciate an existing email account}}
 
|Methods=
 
|Methods=

Revision as of 08:24, 30 November 2016

EmailAccount



Represents an email account.

Constructors

  • (int type "2: WebShop, 3: Support") - Instanciate an existing email account
  • (string type "The part before the @") - Instanciate an existing global email account by name
  • (int type "0: Resource, 1: GlobalEmail, 2: WebShop, 3: Support", int id "Resource id or global email resource 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

Example 1:
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
----------
Example 2:
number GlobalEmail=1;
number global_email_id=26;
EmailAccount a = new EmailAccount(GlobalEmail,global_email_id);
print(a.ActualEmail);
print(a.Address);
print(a.Alias);
print(a.Default);
print(a.ResourceId);

//Result:
panel@voxmeter.dk
panel@voxmeter.catglobe.com
Voxmeter
False
16238


// EX for creating a new global email account
string name = "test";
EmailAccount a = new EmailAccount (1,0);

a.Address = name + a.Address;
a.Alias = name;
a.Save();

// EX for get global email without knowing current site domain.
EmailAccount a = new EmailAccount("test"); 

a.ActualEmail="an@maysunshine.vn";
a.UseActualEmail =true;
a.Save();