How to Setup Email

Send an email when an upload starts, finishes, or fails - optionally with the build attached.

!NOTE: The Email service is marked Experimental. It works, but expect rough edges.

The Build Uploader sends mail through SMTP, which means you need an email account that allows SMTP access. Gmail is the most common choice and is what this page uses as the example.

---

Where things get saved

• Edit->Preferences->Build Uploader->Services->Email holds your username and password. Saved to your own PC only and never written into your project. Every person on your team enters their own.
• Project Settings->Build Uploader->Services->Email holds the server, port and who the mail comes from. Saved to <YourProjectPath>/BuildUploader/ and safe to commit so your team shares them.

Create the account in Project Settings, then enter its password in Preferences. The Name is what links the two - it must match exactly.

---

1. Get an app password (Gmail)

Gmail will not accept your normal account password over SMTP. You need an App Password.

• Turn on 2-Step Verification on your Google account if you haven't already
  • Google only offers App Passwords to accounts that have it
• Go to Google App Passwords
  • (Or press the Gmail App Passwords button at the top of the Preferences page)
• Type a name (eg: Unity Build Uploader) and press Create
• Copy the 16 character password it shows you. You only get to see it once

Using a different provider? You want its SMTP host, port, username and password. Look for "SMTP settings" in its help pages.

---

2. Setup Project Settings: Project Settings->Build Uploader->Services->Email

• Under Accounts press + to create an account
  • Name: anything you like. This is just a label so you can pick it in a dropdown later. eg: Build Notifications
  • Host: the SMTP server. For Gmail this is smtp.gmail.com
  • Port: 587 for TLS, 465 for SSL. 587 is the usual choice
  • From Email: the address the mail will appear to come from. For Gmail this must be your own address
  • Display Name: the name recipients see next to the address. eg: Build Bot

---

3. Setup Preferences: Edit->Preferences->Build Uploader->Services->Email

• Turn on Enabled
• Under Accounts find the account you just created (matched by Name)
  • Username: your SMTP username. For Gmail this is your full email address
  • Password: the App Password from step 1
    • Press Show if you want to see what you pasted

---

4. Use it in an Upload Config

• Go to Window->Build Uploader->Open Window
• Add an Email Send Mail action to your Upload Config
  • Account: the account you made
  • To: who receives it
  • Subject: the subject line
  • Body: the message
  • CC / BCC: optional. Press + to add more recipients
  • Attachments: optional. Press + and enter a file path to attach
• Every one of those fields supports {keys} - see String Formatter
  • Because Attachments supports them too, you can attach the build itself by using the key that resolves to the uploaded file's path
• Set Triggers and When To Execute to control when it fires
  • eg: OnTaskFinished + IfFailed emails you only when a build breaks

!NOTE: Attaching a build usually will not work - most mail providers reject attachments over about 25MB. Upload the build to Google Drive or Dropbox first and put the resulting link in the Body instead.