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

Type

Notes

ObjectType

ObjectType

Read Only

Distinguishes objects referenced through a dispatch interface

MessagingEnabled

Boolean

Read Only

Advises whether messaging is enabled on the current model

MailInterface Methods:

Method

Type

Notes

GetLastError ( )

String

Returns the last error message set for the MailInterface

GetRecipientGUID (string UserName)

String

Returns the GUID of the specified Enterprise Architect user

Parameters:

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

GetElementHyperlink (string ElementGUID, string LinkText)

String

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 (e.g. the element name)

GetAttributeHyperlink(string AttributeGUID, string LinkText)

String

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 (e.g. the attribute name)

GetMethodHyperlink(string MethodGUID, string LinkText)

String

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 (e.g. the method name)

GetDiagramHyperlink(string DiagramGUID, string LinkText)

String

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 (e.g. the diagram name)

GetPackageHyperlink(string PackageGUID, string LinkText)

String

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 (e.g. the package name)

GetFileHyperlink(string FilePath, string LinkText)

String

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 (e.g. The file's name)

GetWebHyperlink(string URL, string LinkText)

String

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

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

Boolean

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

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

Boolean

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