EASendMail Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Send mail using a EPT document. The data is written as HTML to the supplied stream or the default response stream. The EASendMail class acts as the underlying engine for the EA Send mail AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingPageableComponent
        ContentStudio.Site.ActiveScriptingEPTBase
          ContentStudio.Site.ActiveScripting.EPTEASendMail

Namespace: ContentStudio.Site.ActiveScripting.EPT
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public sealed class EASendMail : EPTBase

The EASendMail type exposes the following members.

Constructors

  NameDescription
Public methodEASendMail
Constructs a new instance of the EASendMail class that writes to the default response stream
Public methodEASendMail(Stream)
Constructs a new instance of the InsertAuthor class that writes to the supplied stream
Public methodEASendMail(MasterPageBase)
Constructs a new instance of the EASendMail class that writes to the supplied stream
Public methodEASendMail(SiteBase)
Constructs a new instance of the EASendMail class that writes to the supplied stream
Public methodEASendMail(UserControlBase)
Constructs a new instance of the EASendMail class that writes to the supplied stream
Public methodEASendMail(SiteBase, UserControlBase)
Constructs a new instance of the EASendMail class that writes to the supplied stream
Public methodEASendMail(Stream, SiteBase, UserControlBase)
Constructs a new instance of the EASendMail class that writes to the supplied stream
Top
Properties

  NameDescription
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyErrorEmail
Sets or gets the email address that should receive information about errors that occur. The default value is an empty string (no error message is sent).
Public propertyExtraQString
Sets or gets an extra query string value that is appended to the page URL. The default value is an empty string.
Public propertyPassWord
Sets or gets the user password that is used for authentication. The default value is an empty string.
Public propertyPlainText
Sets or gets a value indicating if the mail should be sent as plain text without formatting. The default value is false (send with formatting).
Public propertyPTID
Sets or gets an optional presentation template ID. The default value is zero.
Public propertySendOnce
Gets or sets a value indicating if the mail should be sent only on first revision. The default value is an true.
Public propertyServerName
Sets or gets the name or IP address of the mail server to use. If it is an empty string, the default SMTP server according to the CS settings is used. The default value is an empty string.
Public propertyStaticBcc
Sets or gets the email addresses to put in the BCC field. The default value is an empty string.
Public propertyStaticCc
Sets or gets the email addresses to put in the CC field. The default value is an empty string.
Public propertyStaticFrom
Sets or gets the email address to put in the FROM field. The default value is an empty string.
Public propertyStaticSubject
Sets or gets the text to put in the SUBJECT field. The default value is an empty string.
Public propertyStaticTo
Sets or gets the email addresses to put in the TO field. The default value is an empty string.
Public propertyUserName
Sets or gets the user name that is used for authentication. The default value is an empty string.
Public propertyXmlBcc
Sets or gets the EPT field containing the BCC email addresses.
Public propertyXmlCc
Sets or gets the EPT field containing the CC email addresses.
Public propertyXmlFrom
Sets or gets the EPT field containing the FROM email addresses.
Public propertyXmlSendmail
Sets or gets a value indicating if the send mail functionality should be enabled. The value should correspond to a checkbox value, where "1" means that the functionality is enabled. The default value is an empty string.
Public propertyXmlSubject
Sets or gets the EPT field containing the SUBJECT field.
Public propertyXmlTo
Sets or gets the EPT field containing the TO email addresses.
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the component and writes its content into the specified stream
Public methodToString (Inherited from Object.)
Top
Remarks

To use this class, create an instance of this object, set the properties that does not have the values you expect, and call the Invoke method.
See Also

Reference