Difference between revisions of "EmailAccount class"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 
+
{{CGscriptClass_Template
 
+
|Name=<nowiki>EmailAccount</nowiki>
EmailAccount : Represents an email account.
+
|Description=<nowiki>Represents an email account.</nowiki>
Constructors:
+
|Constructors=
(int type (2: WebShop, 3: Support)) - Instanciate an existing email account
+
{{CGscriptConstructors_Template|Parameters=
(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
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>type</nowiki>|Description=<nowiki>2: WebShop, 3: Support</nowiki>}}
Methods:
+
|Description=<nowiki>Instanciate an existing email account</nowiki>}}
Empty Save() - Save the Email Account
+
{{CGscriptConstructors_Template|Parameters=
string ToString() - The string representation of the object.
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>type</nowiki>|Description=<nowiki>0: Resource, 1: GlobalEmail, 2: WebShop, 3: Support</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Resource id or global email id. Unused for webshop and support types</nowiki>}}
Properties:
+
|Description=<nowiki>Instanciate an existing email account</nowiki>}}
string ActualEmail HasGetter HasSetter - (Actual Email address)
+
|Methods=
string Address HasGetter HasSetter - (Email address)
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the Email Account</nowiki>}}
string Alias HasGetter HasSetter - (Alias)
+
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
bool Default HasGetter - (Is this the default email account for the resource.)
+
|Properties=
bool IsGEA HasGetter - (Is the alias for a Global Email or not.)
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ActualEmail</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Actual Email address</nowiki>}}
string ObjectTypeName HasGetter - (The name of the type of object.)
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Address</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Email address</nowiki>}}
int ResourceId HasGetter - (Id of account)
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Alias</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Alias</nowiki>}}
TypeInformation TypeInformation HasGetter - (Get information about this class.)
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Default</nowiki>|HasGetter=1|Description=<nowiki>Is this the default email account for the resource.</nowiki>}}
bool UseActualEmail HasGetter HasSetter - (If true, the from email will be ActualMail. Otherwise, it will be Address.)
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsGEA</nowiki>|HasGetter=1|Description=<nowiki>Is the alias for a Global Email or not.</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>Id of account</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>UseActualEmail</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If true, the from email will be ActualMail. Otherwise, it will be Address.</nowiki>}}
 +
}}

Revision as of 09:04, 3 August 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.