COMSOL 6.4 - Email Methods

Email Methods

Email methods are used for sending emails from an application, typically with attachments containing results from a simulation.


Name	Syntax	Description
emailFromAddress	String emailFromAddress()	Returns the email from address from the COMSOL Server or preferences setting.
sendEmail	sendEmail(String subject, String bodyText)	Sends an email to the default recipient(s) with the specified subject and body text.
sendEmail	sendEmail(String subject, String bodyText, ModelEntity... modelEntity)	Sends an email to the default recipient(s) with the specified subject, body text, and zero or more attachments created from Report, Export, and Table nodes in the embedded model.
sendEmail	sendEmail(String toAddress, String subject, String bodyText, ModelEntity... modelEntity)	Sends an email to the specified recipient(s) with the specified subject, body text, and zero or more attachments created from Report, Export, and Table nodes in the embedded model.
userEmailAddress	String userEmailAddress()	Returns the user email address(es) corresponding to the currently logged in user, or an empty string if the user has not configured an email address.

Email Class Methods

The class EmailMessage can be used to create custom email messages.


Name	Syntax	Description
EmailMessage	EmailMessage mail = new EmailMessage()	Creates a new EmailMessage object.
EmailMessage.setServer	mail.setServer(String host, int port)	Sets the email (SMTP) server host and port to use for this email message.
EmailMessage.setUser	mail.setUser(String name, String password)	Sets the username and password to use for email (SMTP) server authentication. This method must be called after the setServer method.
EmailMessage.setSecurity	mail.setSecurity(String security)	Sets the connection security type for email (SMTP) server communication. Valid values are 'none', 'starttls', and 'tls'. This method must be called after the setServer method.
EmailMessage.setFrom	mail.setFrom(String fromAddress)	Sets the from address.
EmailMessage.setTo	mail.setTo(String... to)	Sets the to addresses.
EmailMessage.setCc	mail.setCc(String... cc)	Sets the cc addresses.
EmailMessage.setBcc	mail.setBcc(String... bcc)	Sets the bcc addresses.
EmailMessage.setSubject	mail.setSubject(String subject)	Sets the email subject line. Note that newline characters are not allowed.
EmailMessage.setBodyText	mail.setBodyText(String body)	Sets the email body as plain text. An email can contain both a text and an HTML body.
EmailMessage.setBodyHtml	mail.setBodyHtml(String body)	Sets the email body as HTML text. An email can contain both a text and an HTML body.
EmailMessage.attachFile	mail.attachFile(String filename)	Adds an attachment from a file. The attachment MIME type is determined by the filename extension.
EmailMessage.attachFile	mail.attachFile(String filename, String mimeType)	Adds an attachment from a file with the specified MIME type.
EmailMessage.attachFromModel	mail.attachFromModel(ModelEntity modelEntity)	Adds an attachment created from a report, export, or table feature in the model.
EmailMessage.attachText	mail.attachText(String text, String mimeSubType)	Adds a text attachment with a specified sub-MIME type, such as plain or HTML.
EmailMessage.attachBinary	mail.attachBinary(byte[] binary, String mimeType)	Adds an attachment from a byte array with the specified MIME type.
EmailMessage.send	mail.send()	Sends the email to the email (SMTP) server. An email object can only be sent once.

Each to, cc, and bcc address string can contain multiple email addresses separated by a comma or a semicolon character. Whitespace is allowed before and after the separator character.

Email Preferences

To set general email preferences, open the page of the window. There you can specify a and a . To set preferences for an outgoing email (SMTP) server, open the page under the page, as shown in the figure below.