The e-mail interface. More...

#include "murl_i_email.h"

Inherited by Murl::Platform::Android::EMail, Murl::Platform::Emscripten::EMail, Murl::Platform::Ios::EMail, Murl::Platform::Osx::EMail, and Murl::Platform::Win32::EMail.

Public Member Functions
virtual Bool	SetSubject (const String &subject)=0
	Set the e-mail subject string. More...

virtual Bool	SetMessage (const String &message)=0
	Set the e-mail message string. More...

virtual Bool	AddToRecipient (const String &address)=0
	Add a receipient e-mail address string to the TO field. More...

virtual Bool	AddCcRecipient (const String &address)=0
	Add a receipient e-mail address string to the carbon copy field. More...

virtual Bool	AddBccRecipient (const String &address)=0
	Add a receipient e-mail address string to the blind carbon copy field. More...

virtual Bool	AddAttachment (const String &fileName, const String &mimeType, const Data &data)=0
	Add an attachment to the e-mail. More...

virtual const String &	GetSubject () const =0
	Get the e-mail subject string. More...

virtual const String &	GetMessage () const =0
	Get the e-mail message string. More...

virtual UInt32	GetNumberOfToRecipients () const =0
	Get the number of available receipients of the TO field. More...

virtual const String &	GetToRecipient (UInt32 index) const =0
	Get the receipients e-mail address string from the TO field. More...

virtual UInt32	GetNumberOfCcRecipients () const =0
	Get the number of available receipients of the carbon copy field. More...

virtual const String &	GetCcRecipient (UInt32 index) const =0
	Get the receipients e-mail address string from the carbon copy field. More...

virtual UInt32	GetNumberOfBccRecipients () const =0
	Get the number of available receipients of the blind carbon copy field. More...

virtual const String &	GetBccRecipient (UInt32 index) const =0
	Get the receipients e-mail address string from the blind carbon copy field. More...

virtual UInt32	GetNumberOfAttachments () const =0
	Get the number of attachments. More...

virtual const String &	GetAttachmentFileName (UInt32 index) const =0
	Get the name of an attachment. More...

virtual const String &	GetAttachmentMimeType (UInt32 index) const =0
	Get the MIME type of an attachment. More...

virtual const Data &	GetAttachmentData (UInt32 index) const =0
	Get the data of an attachment. More...

virtual Bool	Send ()=0
	Send the e-mail. More...

virtual Bool	IsInQueue () const =0
	Check if the e-mail is in the send queue. More...

virtual Bool	IsSending () const =0
	Check if the e-mail is currently sent. More...

virtual Bool	WasSent () const =0
	Check if the e-mail was sent in the most recent tick. More...

virtual Bool	WasSaved () const =0
	Check if the e-mail was saved in the most recent tick. More...

virtual Bool	WasCancelled () const =0
	Check if the e-mail was cancelled in the most recent tick. More...

virtual Bool	WasRejected () const =0
	Check if the e-mail was rejected in the most recent tick. More...

Detailed Description

The e-mail interface.

The IEMail object can be created by the IWebControl object.

Member Function Documentation

◆ SetSubject()

virtual Bool Murl::IEMail::SetSubject ( const String & subject )

pure virtual

Set the e-mail subject string.

Parameters

subject The e-mail subject string.

Returns: true if successful.

◆ SetMessage()

virtual Bool Murl::IEMail::SetMessage ( const String & message )

pure virtual

Set the e-mail message string.

Parameters

message The e-mail message string.

Returns: true if successful.

◆ AddToRecipient()

virtual Bool Murl::IEMail::AddToRecipient ( const String & address )

pure virtual

Add a receipient e-mail address string to the TO field.

Parameters

address The e-mail address string.

Returns: true if successful.

◆ AddCcRecipient()

virtual Bool Murl::IEMail::AddCcRecipient ( const String & address )

pure virtual

Add a receipient e-mail address string to the carbon copy field.

Parameters

address The e-mail address string.

Returns: true if successful.

◆ AddBccRecipient()

virtual Bool Murl::IEMail::AddBccRecipient ( const String & address )

pure virtual

Add a receipient e-mail address string to the blind carbon copy field.

Parameters

address The e-mail address string.

Returns: true if successful.

◆ AddAttachment()

virtual Bool Murl::IEMail::AddAttachment	(	const String &	fileName,
		const String &	mimeType,
		const Data &	data
	)

pure virtual

Add an attachment to the e-mail.

Currently only supported on iOS devices.

Parameters

fileName	The name of the attachment.
mimeType	The MIME type of the attachment (e.g. "image/png").
data	The data of the attachment.

Returns: true if successful.

◆ GetSubject()

virtual const String& Murl::IEMail::GetSubject ( ) const

pure virtual

Get the e-mail subject string.

Returns: subject The e-mail subject string.

◆ GetMessage()

virtual const String& Murl::IEMail::GetMessage ( ) const

pure virtual

Get the e-mail message string.

Returns: message The e-mail message string.

◆ GetNumberOfToRecipients()

virtual UInt32 Murl::IEMail::GetNumberOfToRecipients ( ) const

pure virtual

Get the number of available receipients of the TO field.

Returns: The number of available receipients.

◆ GetToRecipient()

virtual const String& Murl::IEMail::GetToRecipient ( UInt32 index ) const

pure virtual

Get the receipients e-mail address string from the TO field.

A valid index is [0 .. GetNumberOfToRecipients() - 1].

Parameters

index The zero-based index of the receipients.

Returns: The receipients e-mail address string.

◆ GetNumberOfCcRecipients()

virtual UInt32 Murl::IEMail::GetNumberOfCcRecipients ( ) const

pure virtual

Get the number of available receipients of the carbon copy field.

Returns: The number of available receipients.

◆ GetCcRecipient()

virtual const String& Murl::IEMail::GetCcRecipient ( UInt32 index ) const

pure virtual

Get the receipients e-mail address string from the carbon copy field.

A valid index is [0 .. GetNumberOfToRecipients() - 1].

Parameters

index The zero-based index of the receipients.

Returns: The receipients e-mail address string.

◆ GetNumberOfBccRecipients()

virtual UInt32 Murl::IEMail::GetNumberOfBccRecipients ( ) const

pure virtual

Get the number of available receipients of the blind carbon copy field.

Returns: The number of available receipients.

◆ GetBccRecipient()

virtual const String& Murl::IEMail::GetBccRecipient ( UInt32 index ) const

pure virtual

Get the receipients e-mail address string from the blind carbon copy field.

A valid index is [0 .. GetNumberOfToRecipients() - 1].

Parameters

index The zero-based index of the receipients.

Returns: The receipients e-mail address string.

◆ GetNumberOfAttachments()

virtual UInt32 Murl::IEMail::GetNumberOfAttachments ( ) const

pure virtual

Get the number of attachments.

Returns: The number of attachments.

◆ GetAttachmentFileName()

virtual const String& Murl::IEMail::GetAttachmentFileName ( UInt32 index ) const

pure virtual

Get the name of an attachment.

A valid index is [0 .. GetNumberOfAttachments() - 1].

Parameters

index The zero-based index of the attachment.

Returns: The name of the attachment.

◆ GetAttachmentMimeType()

virtual const String& Murl::IEMail::GetAttachmentMimeType ( UInt32 index ) const

pure virtual

Get the MIME type of an attachment.

A valid index is [0 .. GetNumberOfAttachments() - 1].

Parameters

index The zero-based index of the attachment.

Returns: The MIME type of the attachment.

◆ GetAttachmentData()

virtual const Data& Murl::IEMail::GetAttachmentData ( UInt32 index ) const

pure virtual

Get the data of an attachment.

A valid index is [0 .. GetNumberOfAttachments() - 1].

Parameters

index The zero-based index of the attachment.

Returns: The data of the attachment.

◆ Send()

virtual Bool Murl::IEMail::Send ( )

pure virtual

Send the e-mail.

Returns: true if successful.

◆ IsInQueue()

virtual Bool Murl::IEMail::IsInQueue ( ) const

pure virtual

Check if the e-mail is in the send queue.

Returns: true if the e-mail is in the send queue.

◆ IsSending()

virtual Bool Murl::IEMail::IsSending ( ) const

pure virtual

Check if the e-mail is currently sent.

Returns: true if the e-mail is currently sent.

◆ WasSent()

virtual Bool Murl::IEMail::WasSent ( ) const

pure virtual

Check if the e-mail was sent in the most recent tick.

Returns: true if the e-mail was sent in the most recent tick.

◆ WasSaved()

virtual Bool Murl::IEMail::WasSaved ( ) const

pure virtual

Check if the e-mail was saved in the most recent tick.

Returns: true if the e-mail was saved in the most recent tick.

◆ WasCancelled()

virtual Bool Murl::IEMail::WasCancelled ( ) const

pure virtual

Check if the e-mail was cancelled in the most recent tick.

Returns: true if the e-mail was cancelled in the most recent tick.

◆ WasRejected()

virtual Bool Murl::IEMail::WasRejected ( ) const

pure virtual

Check if the e-mail was rejected in the most recent tick.

Returns: true if the e-mail was rejected in the most recent tick.

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

murl_i_email.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ SetSubject()

◆ SetMessage()

◆ AddToRecipient()

◆ AddCcRecipient()

◆ AddBccRecipient()

◆ AddAttachment()

◆ GetSubject()

◆ GetMessage()

◆ GetNumberOfToRecipients()

◆ GetToRecipient()

◆ GetNumberOfCcRecipients()

◆ GetCcRecipient()

◆ GetNumberOfBccRecipients()

◆ GetBccRecipient()

◆ GetNumberOfAttachments()

◆ GetAttachmentFileName()

◆ GetAttachmentMimeType()

◆ GetAttachmentData()

◆ Send()

◆ IsInQueue()

◆ IsSending()

◆ WasSent()

◆ WasSaved()

◆ WasCancelled()

◆ WasRejected()