Gmail email send profile

org.intentschema.communication.email.message.send.v1@com.google.gmail.v1

JSON: bare · @sha256:db76ea3dac43…
Hash: sha256:db76ea3dac43ca27d340f8cf9b91d75457993629fea998c590f898f81500e34c

Profile for sending email via the Gmail API. Pins target.system to gmail, adds Gmail-specific extensions (threadId for replies, labelIds for tagging), and bounds attachment sizes to the Gmail limit.

Implements: Send email message (org.intentschema.communication.email.message.send.v1)

Payload

FieldTypeDescription
target *Target(system = "gmail", required: system)
object *object
idempotency_keystring
gmail @com.google.gmailobject
object
FieldTypeDescription
fromstring (email)[]
to *string (email)[] (minItems 1)
ccstring (email)[]
bccstring (email)[]
subject *string
textBodystring
htmlBodystring
attachmentsBlobRef[]
gmail @com.google.gmail
FieldTypeDescription
threadIdstringGmail thread identifier; set when this send belongs to an existing thread.
labelIdsstring[]Gmail labels to apply to the sent message.

Result

FieldTypeDescription
external_id *stringProvider message id.
thread_idstring
sent_at *string (date-time)
gmail @com.google.gmailobject
gmail @com.google.gmail
FieldTypeDescription
historyIdstringGmail mailbox history id at the time of send.
labelIdsstring[]Labels applied to the sent message.

API mapping

FieldValue
base_urlhttps://gmail.googleapis.com
methodPOST
path/gmail/v1/users/me/messages/send
scopeshttps://www.googleapis.com/auth/gmail.send
docshttps://developers.google.com/gmail/api/reference/rest/v1/users.messages/send

Field mapping

Intent fieldAPI parameter
object.toraw message To header (RFC 5321 addresses)
object.ccraw message Cc header
object.bccraw message Bcc header
object.fromraw message From header
object.subjectraw message Subject header
object.textBodyraw message text/plain body part
object.htmlBodyraw message text/html body part
object.attachmentsraw message MIME attachment parts
idempotency_keyraw message Message-ID header
gmail.threadIdthreadId (query param or JSON field)
gmail.labelIdslabelIds (JSON field)