Email Object

The Email object allows data local to FreeFlyer to be transmitted to an external user via email. Any combination of text and internal FreeFlyer data may be transmitted. See the Email Guide for more information.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DoAuthenticate	Denotes whether an email will be sent by authenticating to the email server.	Type: Variable Access: Read/Write
From	The email address that is seen as the sender by the recipient.	Type: String Access: Read/Write
LoginID	The user ID for the email account.	Type: String Access: Read/Write
LoginPassword	The password for the email account.	Type: String Access: Read/Write
MailServer	The URL of the mail server to use for sending the email.	Type: String Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Port	The port on which to connect to the email server.	Type: Variable Access: Read/Write
Recipients	A comma separated list of email addresses defining who will receive the email.	Type: String Access: Read/Write
Subject	The subject of the email.	Type: String Access: Read/Write

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

Email Object

Description

Available In Editions:

Timing Precision Mode