AngeliaMailTM - On-Line Help - COM Interface
When AngeliaMail is installed, a folder will be created (typically "C:\Program Files\AngeliaMail")
that will contain (at a minimum) the AngeliaMail Desktop Configuration Utility (AngeliaConfig.Exe), the AngeliaMail Command
Line Utility (AngeliaMail.Exe), and the AngeliaMail Type Library (AngeliaMail.Tlb). The Type Library contains the COM
interface definitions that allow your programs to access all of the functionality provided by the AngeliaMail Command Line
utility. The AngeliaMail COM object is automatically registered by the installation process.
AngeliaMail COM Object Methods: the command line parameters of the AngeliaMail Command Line Utility are
replicated as methods in the COM object. Typically, each command line parameter has a corresponding method that
serves the same purpose. Those command line parameters that serve multiple purposes will have more than one method
to achieve the same functionality (such as the "+" switch to signal appending command line information to command
file defaults). There are also two additional methods that (1) cause an email to be sent and (2) reset AngeliaMail to
its initial state so that a new email can be created. An exception will be raised if execution of any of AngeliaMail’s
COM Methods results in an error. The AngeliaMail COM Interface ("IAngeliaMailer") implements the
following methods:
- procedure SetSMTPHost (const HostName : string) - where "hostname" is a string value containing
one of the SMTP Hosts defined using the Configuration Utility. By specifying a hostname you are implicitly selecting
SMTP Server address, logon user-id and password if required, and “From” and “Reply-To” email addresses. A host name
must be specified, either using SetSMTPHost, or via an AngeliaMail Command File (see "Command File Path" and
"Command File Name" below).
- procedure SetSMTPTraceOn – causes the SMTP Trace function to be turned on. If tracing is turned on,
a trace of the SMTP connection dialog will be included in the log file. (Also see "Enable Logging" and
"Log File Path" below).
- procedure SetSMTPTraceOff – causes the SMTP Trace function to be turned off. This is the default
behavior.
- procedure SetAddresseeAppendOn – causes the addressee list provided in "SetAddresseeList" to be
appended to any previously supplied addressee list (either from a previous call to SetAddresseeList or to an addressee list
supplied via a Command File).
- procedure SetAddresseeAppendOff - causes the addressee list provided by "SetAddresseeList" to
overwrite any previously supplied addressee list (either from a previous call to SetAddresseeList or an addressee list supplied
via a Command File). This is the default behavior.
- procedure SetAddresseeList (const Addressees : string) – where "addressees" are either EMail Address
Group Names defined via the Configuration Utility or EMail addresses. If more than one EMail address (or EMail Address Group
Name) is specified then use a semi-colon (";") between each EMail Address or Group Name. We recommend that you
avoid using Email addresses in "Addressees" to simplify maintenance of your application(s). Any Email Address
Groups specified will be expanded into the list of EMail addresses that they represent before the email is sent. In addition,
the EMail address list will be de-duped before sending. At least one EMail address (or EMail Address Group) must be specified,
either using "SetAddresseeList", or via a Command File (see "Command File Path" and "Command File
Name" below).
- procedure SetSubjectAppendOn - causes the subject line text provided via SetSubjectLine to be appended to any
previously supplied subject line (either from a previous call to SetSubjectLine or to the default subject line supplied via a
Command File).
- procedure SetSubjectAppendOff - causes any subject line text provided via any following calls to SetSubjectLine
to overwrite any previously supplied subject line whether that subject line was provided via SetSubjectLine or by way of a Command
File. This is the default behavior.
- procedure SetSubjectLine (const Subject : string) - where "subject" contains whatever text you wish
to have appear in the subject line of the email when it is sent. A subject line must be specified either via SetSubjectLine,
or via a Command File (see "Command File Path" and "Command File Name" below).
- procedure SetAttachPathAppendOn - causes the attachment path(s) provided via SetAtttachPathList to be appended
to any previously supplied attachment paths (either from a previous call to SetAttachPathList or to the default attachment path
list supplied via a Command File).
- procedure SetAttachPathAppendOff - causes any attachment path(s) provided via any following calls to
SetAttachPathList to overwrite any previously supplied attachment path information whether that attachment path information was
provided via SetAttachPathList or by way of a Command File. This is the default behavior.
- procedure SetAttachPathList (const AttPaths : string) - where "AttPaths" contains one or more pathnames
specifying file(s) that you wish to attach to the email when sent. If more than one attachment path is specified, then use a
semi-colon (";") between each path name. Attachments are optional.
- procedure SetMessageBodyPath (const MsgPath : string) – where "MsgPath" is the pathname of a text file,
the contents of which will be loaded into the email message body. The path must exist. SetMessageBodyPath and
SetMessageBodyText (see below) are mutually exclusive.
- procedure SetMessageTextAppendOn – causes the message body text provided via SetMessageBodyText to be appended
to any previously supplied message body text (either from a previous call to SetMessageBodyText or to the default message body text
supplied via a Command File).
- procedure SetMessageTextAppendOff - causes the message body text provided via any following calls to
SetMessageBodyText to overwrite any previously provided message body text whether that message body text was provided via
SetMessageBodyText or by way of a Command File. This is the default behavior.
- procedure SetMessageBodyText (const MsgText : string) – where "MsgText" contains whatever text
you wish to have appear in the message body of the email when it is sent. SetMessageBodyText and SetMessageBodyPath
(see above) are mutually exclusive. Message Text is optional.
- procedure SetCommandFilePath (const CmdPath : string) – where "CmdPath" is the complete (or
relative) pathname of an AngeliaMail Command File that was created using the “Command Wizard” in the Configuration Utility
(the normal extension is ".AMC"). Command Files contain collections of parameters and are used to simplify
management of dynamic information such as addressee lists. The path specified must exist. If a file extension is
not specified then ".AMC" will automatically be appended. See Command Files
for a discussion of managing Command Files.
- procedure SetCommandInDefaultFolder – causes SetCommandFileName to search for the specified Command File in
the default (license and configuration) folder. This is the default behavior.
- procedure SetCommandInConfigFolder - causes SetCommandFileName to search for the specified Command File in
the configuration folder.
- procedure SetCommandFileName (const CmdName : string) – where "CmdName" is the file name of an
AngeliaMail Command File that was created using the “Command Wizard” in the Configuration Utility (the normal extension is
".AMC") and stored in either the default (license and configuration) folder or the optional configuration folder
(see "Command File Folder" above). Command Files contain collections of parameters and are used to simplify
management of dynamic information such as addressee lists. The name specified must exist in the specified folder.
If a file extension is not specified then ".AMC" will automatically be appended. See
Command Files for a discussion of managing Command Files.
- procedure SetLoggingOn – call SetLoggingOn to enable logging.
- procedure SetLoggingOff - logging is disabled. This is the default behavior.
- procedure SetLogFilePath (const LogPath : string) – "LogPath" specifies the pathname of the file
where you want log information to be written if logging is enabled. If "LogPath" is not specified then a log
file named "AngeliaMail.Log" will be written in the default (license and configuration) folder if logging is
enabled. This parameter is optional.
- procedure ProcessSMTPEMail – causes AngeliaMail to attempt to send the email specified by the various
"Set" methods described above.
- procedure ResetAngeliaMail – causes AngeliaMail to be reset to its initial state. All parameters
previously set are cleared, and Boolean values are reset to their default condition.