MailComposer

The MailComposer class provides an interface to compose and send an email message. More...

Public Member Functions
void	SetToRecipients (params string[] values)
	Sets the initial recipients to include in the email’s “To” field.
void	SetCcRecipients (params string[] values)
	Sets the initial recipients to include in the email’s “Cc” field.
void	SetBccRecipients (params string[] values)
	Sets the initial recipients to include in the email’s “Bcc” field.
void	SetSubject (string value)
	Sets the initial text for the subject line of the email.
void	SetBody (string value, bool isHtml=false)
	Sets the initial body text to include in the email.
void	AddScreenshot (string fileName)
	Captures a screenshot and adds it as an attachment of the email.
void	AddImage (Texture2D image, string fileName, TextureEncodingFormat textureEncodingFormat=TextureEncodingFormat.JPG)
	Adds specified image as an attachment of the email.
void	AddAttachment (byte[] data, string mimeType, string fileName)
	Adds the specified data as an attachment of the email.
void	SetCompletionCallback (EventCallback< MailComposerResult > callback)
	Specify the action to execute after the composer is dismissed.
void	Show ()
	Shows the email composer interface with values initially set.

Static Public Member Functions
static MailComposer	CreateInstance ()
	Initializes a new instance of the MailComposer class.
static bool	CanSendMail ()
	Returns a Boolean indicating whether the current device is able to send email.

Detailed Description

Use this composer to display a standard email interface inside your app. Before presenting the interface, populate the fields with initial values for the subject, email recipients, body text, and attachments of the email. After presenting the interface, the user can edit your initial values before sending the email.

The following code example shows how to compose mail.

using UnityEngine;
using System.Collections;
using VoxelBusters.EssentialKit;
 
public class ExampleClass : MonoBehaviour 
{
    public void Start()
    {
        if (MailComposer.CanSendMail())
        {
            // create new instance and populate fields
            MailComposer    newComposer = MailComposer.CreateInstance();
            newComposer.SetSubject("Example");
            newComposer.SetBody("Lorem ipsum dolor sit amet");
            newComposer.AddScreenshot("screenshot.jpg");
            newComposer.SetCompletionCallback(OnMailComposerClosed);
            newComposer.Show();
        }
        else
        {
            // device doesn't support sending emails
        }
    }
 
    private void OnMailComposerClosed(MailComposerResult result, Error error)
    {
        // add your code
    }
}

Member Function Documentation

CanSendMail()

static bool CanSendMail ( )

static

Returns

true, if the device is configured for sending email, false otherwise.

SetToRecipients()

void SetToRecipients

(

params string[]

values

)

Parameters

values

An array of string values, each of which contains the email address of a single recipient.

SetCcRecipients()

void SetCcRecipients

(

params string[]

values

)

Parameters

values

An array of string values, each of which contains the email address of a single recipient.

SetBccRecipients()

void SetBccRecipients

(

params string[]

values

)

Parameters

values

An array of string values, each of which contains the email address of a single recipient.

SetSubject()

void SetSubject

(

string

value

)

Parameters

value

The text to display in the subject line.

SetBody()

void SetBody	(	string	value,
		bool	isHtml = false )

Parameters

value	The initial body text of the message. The text is interpreted as either plain text or HTML depending on the value of the isHTML parameter..
isHtml	Specify YES if the body parameter contains HTML content or specify NO if it contains plain text.

AddScreenshot()

void AddScreenshot

(

string

fileName

)

Parameters

fileName

The preferred filename to associate with the image.

AddImage()

void AddImage	(	Texture2D	image,
		string	fileName,
		TextureEncodingFormat	textureEncodingFormat = TextureEncodingFormat::JPG )

Parameters

image	The image that has to be added as an attachment.
fileName	The preferred filename to associate with the image.
textureEncodingFormat	Texture encoding format.

AddAttachment()

void AddAttachment	(	byte[]	data,
		string	mimeType,
		string	fileName )

Parameters

data	The data of the file that has to be added as an attachment.
mimeType	The MIME type of the specified data.
fileName	The filename of the specified data.

SetCompletionCallback()

void SetCompletionCallback

(

EventCallback< MailComposerResult >

callback

)

Parameters

callback

The action to be called on completion.