Reference

Endpoint Get Message Attachments (With search condition)


Name

get_message_attachments

Description

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

Parameters

Parameter Required Options
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.
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

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
MessageId DT_WSTR nvarchar(50) 50
PartId DT_WSTR nvarchar(50) 50
AttachmentId DT_WSTR nvarchar(1000) 1000
MimeType DT_WSTR nvarchar(200) 200
Filename DT_WSTR nvarchar(108) 108
Headers DT_WSTR nvarchar(2000) 2000
AttachmentSize DT_I8 bigint
PayloadMimeType DT_WSTR nvarchar(200) 200
ThreadId DT_WSTR nvarchar(50) 50
MessageSnippet DT_WSTR nvarchar(1000) 1000
MessageSizeEstimate DT_I8 bigint
HistoryId DT_WSTR nvarchar(50) 50
InternalDate DT_WSTR nvarchar(50) 50
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

API Source - Gmail
Read / search Gmail messages, download attachments, send mail and more using Gmail REST API.
Gmail
Get Message Attachments (With search condition)
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Gmail
Read / search Gmail messages, download attachments, send mail and more using Gmail REST API.
Gmail
Get Message Attachments (With search condition)
There are no parameters to configure.
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get Gmail message attchments

This example shows how to search messages using search condition and list all attchments.

SELECT * 
FROM get_message_attachments
WITH(
	  --Search='after:<<yearstart+1d|~|yyyy/MM/dd,FUN_TO_DATE>> before:<<today-1d|~|yyyy/MM/dd,FUN_TO_DATE>>'
	  Search='subject:(daily report)'
	  )

SQL Server

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

Get Gmail message attchments

This example shows how to search messages using search condition and list all attchments.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * 
FROM get_message_attachments
WITH(
	  --Search=''after:<<yearstart+1d|~|yyyy/MM/dd,FUN_TO_DATE>> before:<<today-1d|~|yyyy/MM/dd,FUN_TO_DATE>>''
	  Search=''subject:(daily report)''
	  )';

EXEC (@MyQuery) AT [LS_TO_GMAIL_IN_GATEWAY];