Gmail Connector

The high-performance Gmail Connector provides read/write capabilities within your application, allowing you to perform numerous Gmail operations with minimal coding or even no-coding at all. Integrate Gmail data into applications such as SSIS, SQL Server, any ODBC-compatible application, or even directly within a programming language using this connector.

Download for SSIS Download for SQL Server and ODBC Documentation

Integrate Gmail with these applications

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications

Actions supported by Gmail Connector

Gmail Connector supports following actions for REST API integration:

Download Message Attachments (With search condition)

Description

Lists the message attachments for the specified search criterial and user id.

Parameters

You can provide the following parameters to this action:

  • SaveFolder
  • OverwriteFile
  • Search Expression
  • IncludeSpamTrash
  • LabelIds
  • MaxResults
  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • MessageId
  • PartId
  • AttachmentId
  • MimeType
  • Filename
  • Headers
  • AttachmentSize
  • PayloadMimeType
  • ThreadId
  • MessageSnippet
  • MessageSizeEstimate
  • InternalDate
  • HistoryId
  • Size
  • SavedPath
  • SavedSize

Visit documentation for more information.

Get a Specific Attachment included in a Specific Message for the Current User

Description

Gets a specific attachment included on a specific message for the current user.

Parameters

You can provide the following parameters to this action:

  • MessageId
  • AttachmentId
  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Data
  • Size

Visit documentation for more information.

Get a Specific Message for a Specific User

Description

Gets a specific message for the specified user.

Parameters

You can provide the following parameters to this action:

  • Id
  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • Message Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Subject
  • BodySnippet
  • To
  • ToEmail
  • Date
  • From
  • FromEmail
  • PlainTextBody
  • HtmlBody
  • ContentType
  • LabelIds
  • ThreadId
  • PayloadMimeType
  • PayloadBodySize
  • SizeEstimate
  • HistoryId
  • InternalDate
  • MessageDate
  • GoogleSmtpSource
  • ReturnPath
  • ReceivedSPF
  • Rfc822MessageID
  • MIMEVersion
  • Mailer
  • ThreadIndex
  • ContentLanguage

Visit documentation for more information.

Get a Specific Message for the Current User

Description

Gets a specific message for the current user.

Parameters

You can provide the following parameters to this action:

  • Id
  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • Message Id

Output Fields

The following fields are returned after calling this action:

  • Id
  • Subject
  • BodySnippet
  • To
  • ToEmail
  • Date
  • From
  • FromEmail
  • PlainTextBody
  • HtmlBody
  • ContentType
  • LabelIds
  • ThreadId
  • PayloadMimeType
  • PayloadBodySize
  • SizeEstimate
  • HistoryId
  • InternalDate
  • MessageDate
  • GoogleSmtpSource
  • ReturnPath
  • ReceivedSPF
  • Rfc822MessageID
  • MIMEVersion
  • Mailer
  • ThreadIndex
  • ContentLanguage

Visit documentation for more information.

Get labels

Description

Get labels for a specific user.

Parameters

You can provide the following parameters to this action:

  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Name
  • MessageListVisibility
  • LabelListVisibility
  • Type
  • MessagesTotal
  • MessagesUnread
  • ThreadsTotal
  • ThreadsUnread
  • TextColor
  • BackgroundColor

Visit documentation for more information.

Get List of Messages for a Specific User

Description

Lists the messages for the specified user.

Parameters

You can provide the following parameters to this action:

  • ApiVersion
  • UserId
  • Search Expression
  • IncludeSpamTrash
  • LabelIds
  • MaxResults

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Subject
  • BodySnippet
  • To
  • ToEmail
  • Date
  • From
  • FromEmail
  • PlainTextBody
  • HtmlBody
  • ContentType
  • LabelIds
  • ThreadId
  • PayloadMimeType
  • PayloadBodySize
  • SizeEstimate
  • HistoryId
  • InternalDate
  • MessageDate
  • GoogleSmtpSource
  • ReturnPath
  • ReceivedSPF
  • Rfc822MessageID
  • MIMEVersion
  • Mailer
  • ThreadIndex
  • ContentLanguage

Visit documentation for more information.

Get List of Messages for the Current User

Description

Lists the messages for the current user.

Parameters

You can provide the following parameters to this action:

  • ApiVersion
  • UserId
  • Search Expression
  • IncludeSpamTrash
  • LabelIds
  • MaxResults

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Subject
  • BodySnippet
  • To
  • ToEmail
  • Date
  • From
  • FromEmail
  • PlainTextBody
  • HtmlBody
  • ContentType
  • LabelIds
  • ThreadId
  • PayloadMimeType
  • PayloadBodySize
  • SizeEstimate
  • HistoryId
  • InternalDate
  • MessageDate
  • GoogleSmtpSource
  • ReturnPath
  • ReceivedSPF
  • Rfc822MessageID
  • MIMEVersion
  • Mailer
  • ThreadIndex
  • ContentLanguage

Visit documentation for more information.

Get message attachment for user

Description

Gets a specific attachment included on a specific message for the specified user.

Parameters

You can provide the following parameters to this action:

  • MessageId
  • AttachmentId
  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Data
  • Size

Visit documentation for more information.

Get Message Attachments (With search condition)

Description

Lists the message attachments for the specified search criterial and user id.

Parameters

You can provide the following parameters to this action:

  • Search Expression
  • IncludeSpamTrash
  • LabelIds
  • MaxResults
  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • MessageId
  • PartId
  • AttachmentId
  • MimeType
  • Filename
  • Headers
  • AttachmentSize
  • PayloadMimeType
  • ThreadId
  • MessageSnippet
  • MessageSizeEstimate
  • HistoryId
  • InternalDate

Visit documentation for more information.

Send a New Message for the specified User

Description

Sends an email using specified user's mailbox. You can specify various parameters like subject, to , from while sending mail. It doesnt support attachments yet.

Parameters

You can provide the following parameters to this action:

  • To
  • From
  • Cc
  • Bcc
  • ReplyTo
  • Subject
  • Body
  • MessageId
  • MimeType
  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • From
  • To
  • Cc
  • Bcc
  • ReplyTo
  • Subject
  • Body
  • MessageId
  • MimeType

Output Fields

The following fields are returned after calling this action:

  • Id
  • Subject
  • BodySnippet
  • To
  • ToEmail
  • Date
  • From
  • FromEmail
  • PlainTextBody
  • HtmlBody
  • ContentType
  • LabelIds
  • ThreadId
  • PayloadMimeType
  • PayloadBodySize
  • SizeEstimate
  • HistoryId
  • InternalDate
  • MessageDate
  • GoogleSmtpSource
  • ReturnPath
  • ReceivedSPF
  • Rfc822MessageID
  • MIMEVersion
  • Mailer
  • ThreadIndex
  • ContentLanguage

Visit documentation for more information.

Make Generic API Request

Description

This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameters

You can provide the following parameters to this action:

  • HTTP - Url or File Path
  • HTTP - Request Body
  • HTTP - Is MultiPart Body (Pass File data/Mixed Key/value)
  • HTTP - Headers (e.g. hdr1:aaa || hdr2:bbb)
  • Parser - Filter (e.g. $.rows[*] )
  • Download - Enable reading binary data
  • Download - File overwrite mode
  • Download - Save file path
  • Download - Enable raw output mode as single row
  • Download - Raw output data RowTemplate
  • Download - Request Timeout (Milliseconds)
  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Make Generic API Request (Bulk Write)

Description

This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameters

You can provide the following parameters to this action:

  • Url
  • IsMultiPart
  • Filter
  • Headers
  • ApiVersion
  • UserId

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Download for SSIS Download for SQL Server and ODBC