X

Overview

Events

Actions

Home > Application Reference > Gmail

Jump to a Section

Overview

Authorizing an Account

In the Event card field Name Your Account, enter a nickname for the Gmail account. The nickname can be anything - the actual name of the account, a Gmail calendar title, or a generic nickname.

An OAuth window opens asking for your Gmail account and password information.

When you enter your Gmail account information and password, the Event card asks if you want to authorize access to your Gmail account. Click Allow.

Once you create an account configuration on one Gmail card, you can use the same configuration every time you create a FLO with Gmail.

You can also create multiple configurations for each channel to link all your accounts to the Designer, and manage the configurations from your settings page.

  • Gmail Errors

    General

    For information on specific errors being returned from the Gmail API, see the Gmail API reference.

    You can also check the status of the Gmail API for any possible service outages.

    Authentication

    Having difficulties connecting to your Gmail account? Try reauthorizing your account in Settings –> Accounts, or deleting the account and adding it again.

    You can find a list of all your available accounts under Settings –> Accounts.

    We are constantly aggregating more data about errors, so if this article doesn’t help solve your problem, check back soon.

Events

  • Label Added or Removed

    Monitors your inbox and starts a FLO when a label is applied to or removed from a message in your inbox.

    Output Fields

    • Labels
      • Label Added (text): The title of the newly added label.
      • Label Removed (text): The title of the newly removed label.
    • Email
      • Message ID (text): The unique ID of the message. The message ID can also be found in the URL of the email (https://mail.google.com/mail/u/0/#inbox/**15dc79cdab93c15b**).
      • Thread ID (text): The unique ID of the message thread (new, non-threaded messages have the same message and thread IDs).
      • Subject (text): The subject line of the email.
      • To (text): The recipient of the email. Formatted as - Name <email@email.com>.
      • Text Body (text): The text in the body of the incoming message.
      • HTML Body (text): The HTML formatted body of the email message.
      • From (text): The sender of the email. Formatted as - Name <email@email.com>.
      • CC (List of text): A List of any CC’d persons. List items formatted as - Name <email@email.com>.
      • BCC (List of text): A List of any BCC’d persons. List items formatted as - Name <email@email.com>.
      • Attachment IDs (List of text): A list of the unique IDs of any attachments to this email.
      • Labels (List of text): A List of any categories or labels attributed to the message. Example: Unread, Important, Category_Personal.
    • Context
      • Execution ID (Text): The unique ID of the FLO instance. (Assigned a different ID every time the FLO runs.)

    Gmail’s documentation

  • New Email

    Monitors your inbox and starts a FLO when you recieve a new email.

    Output Fields

    • Email
      • Message ID (text): The unique ID of the incoming message.
      • Thread ID (text): The unique ID of the message thread (new, non-threaded messages have the same message and thread IDs).
      • To (text): The recipient of the email. Formatted as - Name <email@email.com>.
      • From (text): The sender of the email. Formatted as - Name <email@email.com>.
      • Text Body (text): The text in the body of the incoming message.
      • HTML Body (text): The HTML formatted body of the email message.
      • CC (List of text): A List of any CC’d persons. List items formatted as - Name <email@email.com>.
      • BCC (List of text): A List of any BCC’d persons. List items formatted as - Name <email@email.com>.
      • Text Body (List of text): A List of any categories or labels attributed to the message. Example: Unread, Important, Category_Personal.
      • Attachment IDs (List of object): List of information about the file (or files) that are attached (if any), including:
        • filename (text): the name of the attachment, e.g. “mylogo.png”
        • attachmentID (text): the unique ID assigned to the attachment
        • messageID (text): same as the email’s Message ID
        • type (text): the file type, such as “image/png”

    Gmail’s documentation

Actions

  • Download Attachment

    Download an attachment from an email.

    Input Fields

    • Download
      • File Name (text): Name of the attachment.
      • Attachment ID (text): The ID of the attachment.
      • Message ID (string): The ID of the message containing the attachment.
        • How to find IDs: In your message, select more (the down arrow next to reply on the upper right of the message). In the dropdown menu, select show original. The Message ID is near the top, and the Attachment ID (X-Attachment-ID)

    Output Fields

    • Attachment
      • File Content (file): The downloaded attachment.
      • File Name (text): The name of the downloaded attachment.
      • Size (text): The size of the attachment.
      • File type (text): The file type: .png, .jpg, .pdf, etc.

    Gmail’s documentation

  • Read Email

    Reads an email in Gmail.

    Input Field

    • Read
      • Message ID (text): The ID of the email you wish to read. You’ll typically get the message ID from the Message ID output from of an earlier event or action, such as New Email.

    Output Fields

    • Email
      • Thread ID (text): The ID of the email thread.
      • Subject (text): The subject of the email.
      • Text Body (text): The content of the email.
      • HTML Body (text): The HTML content (if in HTML).
      • From (text): Who the email is from.
      • CC (list of text): Who is CC’ed on the email.
      • Attachment IDs (list of objects): List of information about the file (or files) that are attached (if any), including:
        • filename (text): the name of the attachment, e.g. “mylogo.png”
        • attachmentID (text): the unique ID assigned to the attachment
        • messageID (text): same as the email’s Message ID
        • type (text): the file type, such as “image/png”
      • Labels (list of text): List of labels on the email.

  • Search Emails

    Search for an email or multiple emails

    Options

    • Result Set (dropdown)
      • First matching email Returns a single email, the first that meets the search criteria.
      • All matching emails Returns a list of all emails matching the search chriteria.
        • These options enable differing outputs, detailed below.

    Input Fields

    • Search
      • Query (text): Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, “from:someuser@example.com rfc822msgid:somemsgid@example.com is:unread”. More Info
      • With Label IDs (text): Any Labels you want to include in your message filtering. Example: Important, Starred, Spam, etc.
      • Max Result Size (number): available only when all matching emails selected, specifies the maximum number of emails you recieve back.
      • Page Token (string): Page token to retrieve a specific page of results in the list.

    Output Fields

    • Result for First Matching Email

      • Message ID (text): The unique ID of the returned message.
      • Subject (text): The subject of the returned message.
      • Text Body (text): The body of the returned message.

    • Result for All Matching Emails

      • Emails (list): List of Email objects returned from the search.

    Gmail’s Search Emails Documentation

  • Send Email

    Send an email via a Gmail account.

    Options

    • Body is HTML? (dropdown): yes/no that allows you to specify whether or not the body of the email is HTML, which allows you to provide formatting for the email; otherwise, it is plain text.

    Input Fields

    • email
      • to (list of text): one or more email addresses to send to. You can type the email(s) in directly (if it’s always the same) or pass an input from a previous action or function card (if it changes each time the FLO runs). To send to more than one email, provide a list of individual emails or a single text string with multiple email addresses separated by a comma or semicolon (e.g. “foo@bar.com, baz@bar.com”).
      • cc (list of text): one or more email addresses to copy on the email
      • subject (text): subject of the email
      • body (text): the content of the email (plain text or HTML depending on the the Option setting above).

    Output Fields

    • mail
      • messageId (text): the unique id of the email generated by Gmail

  • Send Email with Attachment

    Send an email via a Gmail account, including an attachment.

    Options

    • Body is HTML? (dropdown): yes/no that allows you to specify whether or not the body of the list is HTML. This can be useful if you want the body of your email to contain an HTML template. NOTE: If you are using the Compose function to create the body of your email, select “no” for this option.

    Input Fields

    • Email
      • To (text): the email address being sent to
      • Subject (text): subject of the email
      • Body (text): the content of the email
    • File
      • File Name (text): The name of the file you want to attach.
      • File Content (file): The file itself – a file type output from another action that generates or returns a file.

    Output Fields

    • Message ID (text): the unique id of the email generated by Gmail