Reference

Endpoint Get List of Messages for the Current User

Name

get_my_messages

Description

Lists the messages for the current user

Related Tables

MyMessages

Parameters

Parameter Required Options
Name: ApiVersion

Label: ApiVersion

The version of the API to use.
Name: UserId

Label: UserId

Enter the Gmail user ID.
Option Value
Enter Your User Id
Example User Id firstname.lastname@domain.com
Name: Search

Label: Search Expression

Expression to return messages matching the specified query. Supports the same query format as the Gmail search box.
Option Value
all messages
has any words in subject or body FREE PRODUCT
has exact phrase in subject or body "FREE PRODUCT"
has subject (contains any word) subject:FREE PRODUCT
has subject (contains phrase) subject:(FREE PRODUCT)
to (name) to:david
to (email) to:david.smith@gmail.com
from (name) from:david
from (name or email) from:(Platform Notifications) OR from:(no-reply@accounts.google.com)
cc (name) cc:david
bcc (name) bcc:david
multiple conditions (AND) is:unread AND subject:(Share request for)
multiple conditions (OR) is:unread OR subject:(Share request for)
from sender from:someuser@example.com
from sender (OR) from:a@company.com OR from:b@company.com
from sender by name from:amy
from sender by name (OR) from:amy OR from:bob
has attachment has:attachment
has attachment (larger than 10MB) larger:10M
has attachment (smaller than 10MB) smaller:10M
size (exact bytes) 1024
is unread is:unread
is read is:read
date after after:2004/04/16
date before before:2004/04/16
age older than (2days) older_than:2d
age older than (4years) older_than:4y
age newer than (2days) newer_than:2d
age newer than (4months) newer_than:4m
from specific sender and unread emails only from:someuser@example.com rfc822msgid: is:unread
sent date range (static dates) in:sent after:2014/01/01 before:2014/02/01
sent date range (dynamic dates) in:sent after:<> before:<>
Name: IncludeSpamTrash

Label: IncludeSpamTrash

Include messages from SPAM and TRASH in the results.
Option Value
not set
true 1
false 0
Name: LabelIds

Label: LabelIds

Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have.
Name: MaxResults

Label: MaxResults

Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(500) 500
Subject DT_WSTR nvarchar(300) 300
BodySnippet DT_WSTR nvarchar(4000) 4000
To DT_WSTR nvarchar(200) 200
ToEmail DT_WSTR nvarchar(200) 200
Date DT_WSTR nvarchar(200) 200
From DT_WSTR nvarchar(200) 200
FromEmail DT_WSTR nvarchar(200) 200
PlainTextBody DT_NTEXT nvarchar(MAX)
HtmlBody DT_NTEXT nvarchar(MAX)
ContentType DT_WSTR nvarchar(200) 200
LabelIds DT_WSTR nvarchar(500) 500
ThreadId DT_WSTR nvarchar(500) 500
PayloadMimeType DT_WSTR nvarchar(200) 200
PayloadBodySize DT_I4 int
SizeEstimate DT_I4 int
HistoryId DT_WSTR nvarchar(500) 500
InternalDate DT_WSTR nvarchar(200) 200
MessageDate DT_DBTIMESTAMP datetime
GoogleSmtpSource DT_WSTR nvarchar(4000) 4000
ReturnPath DT_WSTR nvarchar(500) 500
ReceivedSPF DT_WSTR nvarchar(500) 500
Rfc822MessageID DT_WSTR nvarchar(200) 200
MIMEVersion DT_WSTR nvarchar(20) 20
Mailer DT_WSTR nvarchar(200) 200
ThreadIndex DT_WSTR nvarchar(500) 500
ContentLanguage DT_WSTR nvarchar(100) 100
If the column you are looking for is missing, consider customizing Gmail Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Gmail Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the MyMessages table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Gmail
Read / search Gmail messages, download attachments, send mail and more using Gmail REST API.
Gmail
MyMessages
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the MyMessages table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get list of messages for the current user:

API Destination - Gmail
Read / search Gmail messages, download attachments, send mail and more using Gmail REST API.
Gmail
MyMessages
Select
There are no parameters to configure.
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get MyMessages 

SELECT * FROM MyMessages

get_my_messages endpoint belongs to MyMessages table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get MyMessages 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM MyMessages';

EXEC (@MyQuery) AT [LS_TO_GMAIL_IN_GATEWAY];

get_my_messages endpoint belongs to MyMessages table(s), and can therefore be used via those table(s).