Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.
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 |
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:
|
||||||||
GetElementHyperlink (string ElementGUID, string LinkText) |
String |
Returns a string containing a hyperlink to the element specified by the input parameter ElementGUID. Parameters:
|
||||||||
GetAttributeHyperlink(string AttributeGUID, string LinkText) |
String |
Returns a string containing a hyperlink to the attribute specified by the input parameter AttributeGUID. Parameters:
|
||||||||
GetMethodHyperlink(string MethodGUID, string LinkText) |
String |
Returns a string containing a hyperlink to the method specified by the input parameter MethodGUID. Parameters:
|
||||||||
GetDiagramHyperlink(string DiagramGUID, string LinkText) |
String |
Returns a string containing a hyperlink to the diagram specified by the input parameter DiagramGUID. Parameters:
|
||||||||
GetPackageHyperlink(string PackageGUID, string LinkText) |
String |
Returns a string containing a hyperlink to the package specified by the input parameter PackageGUID. Parameters:
|
||||||||
GetFileHyperlink(string FilePath, string LinkText) |
String |
Returns a string containing a hyperlink to the file specified by the input parameter FilePath. Parameters:
|
||||||||
GetWebHyperlink(string URL, string LinkText) |
String |
Returns a string containing a hyperlink to the URL specified by the input parameter URL. Parameters:
|
||||||||
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:
|
||||||||
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:
|