MailInterface Class

The MailInterface interface can be accessed from the Repository using GetMailInterface(). The returned interface provides access to the Enterprise Architect Model Mail Interface. Use this interface to automate the process of creating and sending messages using Enterprise Architect's Model Mail system.

MailInterface Attributes

Attribute

Remarks

See also

MessagingEnabled

Boolean

Notes: Read Only

Advises whether messaging is enabled on the current model.

ObjectType

ObjectType

Notes: Read Only

Distinguishes objects referenced through a dispatch interface.

ObjectType

MailInterface Methods

Method

Remarks

See also

ComposeMailMessage(string InitialRecipientGUID, string InitialSubject, messageflag InitialFlag, string InitialMessageText)

Boolean

Notes: Creates a new mail message using the values specified in the input parameters; the message is displayed in the composition window, ready for sending.

This method does NOT send the message.

Parameters:

  • InitialRecipientGUID: String - Initial value for the GUID of the addressee user (an Enterprise Architect user defined in the current model)
  • InitialSubject: String - Initial value for the Subject text to display for this message
  • InitialFlag: MessageFlag - Initial value for the flag type/color to attach to this message
  • InitialMessageText: String - Initial value for the text that is the body of the message

GetAttributeHyperlink(string AttributeGUID, string LinkText)

String

Notes: Returns a string containing a hyperlink to the attribute specified by the input parameter AttributeGUID.

Parameters:

  • AttributeGUID: String - The GUID of the attribute for which a hyperlink is required
  • LinkText: String - The text to display for the hyperlink (such as the attribute name)

GetDiagramHyperlink (string DiagramGUID, string LinkText)

String

Notes: Returns a string containing a hyperlink to the diagram specified by the input parameter DiagramGUID.

Parameters:

  • DiagramGUID: String - The GUID of the diagram for which a hyperlink is required
  • LinkText: String - The text to display for the hyperlink (such as the diagram name)

GetElementHyperlink (string ElementGUID, string LinkText)

String

Notes: Returns a string containing a hyperlink to the element specified by the input parameter ElementGUID.

Parameters:

  • ElementGUID: String - The GUID of the element for which a hyperlink is required
  • LinkText: String - The text to display for the hyperlink (such as the element name)

GetFileHyperlink (string FilePath, string LinkText)

String

Notes: Returns a string containing a hyperlink to the file specified by the input parameter FilePath.

Parameters:

  • FilePath: String - The path name of the file for which a hyperlink is required
  • LinkText: String - The text to display for the hyperlink (such as the file name)

GetLastError ()

String

Notes: Returns the last error message set for the MailInterface.

GetMethodHyperlink (string MethodGUID, string LinkText)

String

Notes: Returns a string containing a hyperlink to the method specified by the input parameter MethodGUID.

Parameters:

  • MethodGUID: String - The GUID of the method for which a hyperlink is required
  • LinkText: String - The text to display for the hyperlink (such as the method name)

GetPackageHyperlink (string PackageGUID, string LinkText)

String

Notes: Returns a string containing a hyperlink to the Package specified by the input parameter PackageGUID.

Parameters:

  • PackageGUID: String - The GUID of the Package for which a hyperlink is required
  • LinkText: String - The text to display for the hyperlink (such as the Package name)

GetRecipientGUID (string UserName)

String

Notes: Returns the GUID of the specified Enterprise Architect user.

Parameters:

  • UserName: String - The name of a user defined in the current model

GetWebHyperlink (string URL, string LinkText)

String

Notes: Returns a string containing a hyperlink to the URL specified by the input parameter URL.

Parameters:

  • URL: String - The URL of the item for which a hyperlink is required
  • LinkText: String - The text to display for the hyperlink

SendMailMessage (string RecipientGUID, string Subject, messageflag Flag, string MessageText)

Boolean

Notes: Creates and sends a new mail message using the values specified in the input parameters.

Parameters:

  • RecipientGUID: String - The GUID of the addressee user (an Enterprise Architect user defined in the current model)
  • Subject: String - The Subject text to display for this message
  • Flag: MessageFlag - The flag type/color to attach to this message
  • MessageText: String - The text that is the body of the message