com.mendix.modules.email.EmailModule Class Reference

List of all members.

Static Public Member Functions
static void	mail (ISMTPConfiguration configuration, String msg, String subject, String to) throws CoreException
static void	mail (ISMTPConfiguration configuration, String htmlmsg, String plainmsg, String subject, String to) throws CoreException
static void	mail (ISMTPConfiguration configuration, String msg, String subject, String to, IContext context, IMendixObject attachment) throws CoreException
static void	mail (ISMTPConfiguration configuration, String htmlmsg, String plainmsg, String subject, String to, IContext context, IMendixObject attachment) throws CoreException
static void	mail (ISMTPConfiguration configuration, String msg, String subject, List< String > to, List< String > cc, List< String > bcc, IContext context, List< IMendixObject > attachments) throws CoreException
static void	mail (ISMTPConfiguration configuration, String htmlmsg, String plainmsg, String subject, List< String > to, List< String > cc, List< String > bcc, IContext context, List< IMendixObject > attachments) throws CoreException

---

Detailed Description

This class can be used to send email. All methods behave in a similar way, there are just multiple methods for your convenience.

---

Member Function Documentation

static void com.mendix.modules.email.EmailModule.mail	(	ISMTPConfiguration	configuration,
		String	msg,
		String	subject,
		String	to
	)		throws CoreException [static]

Sends an email to to with subject subject and message msg.

Parameters:

configuration
msg	The message to send
subject	The subject of the email
to	The recipient

Exceptions:

CoreException

static void com.mendix.modules.email.EmailModule.mail	(	ISMTPConfiguration	configuration,
		String	htmlmsg,
		String	plainmsg,
		String	subject,
		String	to
	)		throws CoreException [static]

Sends an email to to with subject subject and message as html, the shown message will be htmlmsg. If the receipts don't support html messages the plainmsg will be shown.

Parameters:

configuration
htmlmsg
plainmsg
subject
to

Exceptions:

CoreException

static void com.mendix.modules.email.EmailModule.mail	(	ISMTPConfiguration	configuration,
		String	msg,
		String	subject,
		String	to,
		IContext	context,
		IMendixObject	attachment
	)		throws CoreException [static]

Parameters:

configuration	an SMTPConfiguration which contains all information to send your email.
msg	the message body that will be send.
subject	the subject of the email.
to	the recipient of the email message.
context	this context will be used to check if the current user has the rights to access to the attachments.
attachment	the attachment to be sent along with the email.

static void com.mendix.modules.email.EmailModule.mail	(	ISMTPConfiguration	configuration,
		String	htmlmsg,
		String	plainmsg,
		String	subject,
		String	to,
		IContext	context,
		IMendixObject	attachment
	)		throws CoreException [static]

Parameters:

configuration	an SMTPConfiguration which contains all information to send your email.
htmlmsg	the message body as html text this is what most of the recipients will see.
plainmsg	the message in plain text (this will be shown if the recipient doesn't accept html messages).
subject	the subject of the email.
to	the recipient of the email message.
context	this context will be used to check if the current user has the rights to access to the attachments.
attachment	the attachment to be sent along with the email.

static void com.mendix.modules.email.EmailModule.mail	(	ISMTPConfiguration	configuration,
		String	msg,
		String	subject,
		List< String >	to,
		List< String >	cc,
		List< String >	bcc,
		IContext	context,
		List< IMendixObject >	attachments
	)		throws CoreException [static]

Sends an email to to, cc and bcc with subject subject and message msg width attachments attachments using settings in configuration.

Parameters:

configuration	an SMTPConfiguration to send your email with.
msg	the message to send.
subject	the subject of the email.
to	the recipients of the email message.
cc	the CC recipients.
bcc	the BCC recipients.
context	this context will be used to check if the current user has the rights to access to the attachments.
attachments	the attachments you want to send along with the email.

static void com.mendix.modules.email.EmailModule.mail	(	ISMTPConfiguration	configuration,
		String	htmlmsg,
		String	plainmsg,
		String	subject,
		List< String >	to,
		List< String >	cc,
		List< String >	bcc,
		IContext	context,
		List< IMendixObject >	attachments
	)		throws CoreException [static]

Parameters:

configuration	an SMTPConfiguration which contains all information to send your email
htmlmsg	the message body as html text this is what most of the recipients will see.
plainmsg	the message in plain text (this will be shown if the recipient doesn't accept html messages).
subject	the subject of the email.
to	the recipients of the email message.
cc	the CC recipients.
bcc	the BCC recipients.
context	this context will be used to check if the current user has the rights to access to the attachments.
attachments	the attachments to be sent along with the email.

---

The documentation for this class was generated from the following file:

• EmailModule.java