Guide for Unity

1 Overview

Compact Email Service provides the ability to send email without setting up your mail server. Users can send normal email or verification email by one function or one click from Unity.

Download Package: Compact Email Service for Unity2021.3.23f1c1

2 Introduction

Compact Email Service provides the ability to send email without setting up your mail server. Users can send normal email or verification email by on function. Also, users can set reply email address, email content, verification code length, etc.

  • Support to send normal email.

  • Support to send verification email.

  • Support to set reply email address.

  • Support to set source email address, such as noreply@exmaple.com.

  • Support to customize email content.

  • Support to set verification code length.

  • Support to use html tag to format email content.

  • Support to attach one file with limited size (subscriber only).

  • Provide trail emails for a new user (extra cost is required for more emails).

  • To use this compact email service, make sure you can login our website here.

3 Quick Start

Following blew steps, you will use this tool quickly.

3.1 Setup Proxy

Register your account from here. Click “Activate” button to activate your account. After avtivating your account, you can get following API Key.

AccountApiKey

Add a CompactEmailServiceProxy and fill account email and api key as follow.

EmailServiceProxy

  • VerificationCodeLen: The verification code length for verification email, which will not larger than 18.

3.2 Feature

3.2.1 Basic Features

Send email using follow function:

  CompactEmailData emailData = new CompactEmailData(fromEmail, toEmail, replyEmail, subject, content);
  EmailServiceProxy.SendEmail(emailData, OnSendEmailResponse);

  • toEmail: The email address that will receive this email.

  • fromEmail: The sender’s email address which will be shown in receiver side, such as noreply@exmaple.com.

  • replyEmail: The real email address that receiver will reply to.

  • subject: The email subject.

  • content; The body content of the email.

3.2.2 Verification

Notice that you need to use $authcode inside the content for verification email, which will be replaced to the real verification code while sending. You will reveive the verification code from callback function, which you can use to verify the user.

VerifyEmailResult

You can verify your user using the return verification code from client. Your user will receive following email.

SendEmail

3.2.3 HTML Tag

If you want to use html tag to format your email, call function as follow.

  CompactEmailData emailData = new CompactEmailData(fromEmail, toEmail, replyEmail, subject, content);
  EmailServiceProxy.SendEmail(emailData, OnSendEmailResponse, true);

3.2.4 Attachment File

This feature is only effective for the subscribers. You can change plan here.

Notice that this feature only support one attachment file with limited size (preferably less than 1M) so far. The file size should not be too large, otherwise it may fail to send.

To use this feature, you need to fill the following paramters.

  CompactEmailData emailData = new CompactEmailData(fromEmail, toEmail, replyEmail, subject, content, filename, filecontent, fileencoding);
  EmailServiceProxy.SendEmail(emailData, OnSendEmailResponse);

  • filename: attachment file name.

  • filecontent: content of attachment file.

  • fileencoding: encoding of attachment file, such as base64 or utf-8.

4 Support

In the event you are unable to find the information you seek, feel free to contact easycomplex.tech@gmail.com.