Google_Mail
Create a new draft.
Note: To create a draft, you need to provide either the recipient's email address, subject, or the body of the email.
Args: request: The request object. http_headers: The HTTP headers.
Create draft request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]A list of email addresses (carbon copy). Each item must be a string containing a valid email address.
A list of email addresses (blind carbon copy). Each item must be a string containing a valid email address.
Sender email address. If provided, has to be a valid email address. You can use aliases.
Subject of the email.
Body of the email. Can be plain text or HTML.
List of files to attach to the email. Each file should be an InputFile object.
A list of recipient email addresses (TO field). Each item must be a string containing a valid email address.
Successful Response
Validation Error
List drafts in the user's mailbox.
Args: request: The request object. http_headers: The HTTP headers.
List drafts request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Include drafts in spam and trash.
falseMaximum number of drafts to return.
Token to retrieve the next page of results.
Search query to filter drafts. Can be a string or a list of strings.
""Successful Response
Validation Error
Send a draft.
Note: To send a draft, the draft should be have a valid Recipient Email Address.
Args: request: The request object. http_headers: The HTTP headers.
Send draft request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the draft to send.
Successful Response
Validation Error
Get a draft.
Args: request: The request object. http_headers: The HTTP headers.
Get draft request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the draft to retrieve.
Format of the draft. Can be 'full', 'raw', 'metadata', or 'minimal'.
fullDecode the draft body. If set to True, the draft body will be decoded from base64url encoding, you will get the draft body as a string.
falseSuccessful Response
Validation Error
Update a draft.
Args: request: The request object. http_headers: The HTTP headers.
Update draft request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]A list of email addresses (carbon copy). Each item must be a string containing a valid email address.
A list of email addresses (blind carbon copy). Each item must be a string containing a valid email address.
Sender email address. If provided, has to be a valid email address. You can use aliases.
Subject of the email.
Body of the email. Can be plain text or HTML.
List of files to attach to the email. Each file should be an InputFile object.
ID of the draft to update.
A list of recipient email addresses (TO field). Each item must be a string containing a valid email address.
Successful Response
Validation Error
Get total emails per label with optional waiting.
Args: request (TotalEmailPerLabelRequest): The request object. http_headers (ExposedDefaultHeaders): The HTTP headers.
Total Email Per Label request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Waiting mode. If True, wait for completion and return actual data (sync mode). If False or None, process in background and return immediately (background mode).
Successful Response
Validation Error
Get label details by ID.
Args: request: The request object. http_headers: The HTTP headers.
Get Label Details request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the label to retrieve details for.
Successful Response
Validation Error
No content
Create a new label.
Args: request: The request object. http_headers: The HTTP headers.
Create Labels request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Visibility of the label in the label list. Can be 'labelShow', 'labelShowIfUnread', or 'labelHide'.
labelShowVisibility of the label in the message list. Can be 'show' or 'hide'.
showThe owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. Can be 'user' or 'system'.
userBackground color of the label. Should be a hex color code (including the #). Use one of the predefined color values from these values: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
Text color of the label. Should be a hex color code (including the #). Use one of the predefined color values from these values: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
Name of the label. Must be between 1 and 255 characters long. Cannot be empty or contain only whitespace characters.
Successful Response
Validation Error
No content
Modify an existing label.
Args: request: The request object. http_headers: The HTTP headers.
Modify Labels request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Visibility of the label in the label list. Can be 'labelShow', 'labelShowIfUnread', or 'labelHide'.
labelShowVisibility of the label in the message list. Can be 'show' or 'hide'.
showThe owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. Can be 'user' or 'system'.
userBackground color of the label. Should be a hex color code (including the #). Use one of the predefined color values from these values: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
Text color of the label. Should be a hex color code (including the #). Use one of the predefined color values from these values: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
ID of the label to modify.
Name of the label. Must be between 1 and 255 characters long. Cannot be empty or contain only whitespace characters.
Successful Response
Validation Error
No content
Delete a label by ID.
Args: request: The request object. http_headers: The HTTP headers.
Delete Labels request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the label to delete.
Successful Response
Validation Error
No content
Create a new email.
Args: request: The request object. http_headers: The HTTP headers.
Create Emails request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]A list of email addresses (carbon copy). Each item must be a string containing a valid email address.
A list of email addresses (blind carbon copy). Each item must be a string containing a valid email address.
Sender email address. If provided, has to be a valid email address. You can use aliases.
Subject of the email.
Body of the email. Can be plain text or HTML.
List of files to attach to the email. Each file should be an InputFile object.
A list of recipient email addresses (TO field).
Message ID of the email being replied to. Used for threading replies.
References header for email threading. Contains space-separated Message-IDs of all emails in the conversation thread (chronological order). For simple reply: same as in_reply_to. For long threads: ' '. Optional for Gmail (uses threadId primarily), but recommended for compatibility with other email clients.
Thread ID to associate this email with an existing conversation thread.
Set to True will include signature in the email body when it sent (if available).
falseSuccessful Response
Validation Error
List emails in the user's mailbox.
Args: request: The request object. http_headers: The HTTP headers.
List Emails request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Include Emails in spam and trash.
falseOnly return Emails with these label IDs.
Maximum number of Emails to return.
Page token to retrieve the next page of results.
Only return Emails matching the specified query. For more information, see the Gmail API documentation.
Successful Response
Validation Error
Get email details by ID.
Args: request: The request object. http_headers: The HTTP headers.
Get Email Details request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the email to retrieve.
Format of the email. Can be 'full', 'raw', 'metadata', or 'minimal'.
fullList of headers to return in the metadata format.
Decode the email body. If set to True, the email body will be decoded from base64url encoding, you will get the email body as a string.
falseSuccessful Response
Validation Error
Modify email labels.
Args: request: The request object. http_headers: The HTTP headers.
Modify Email request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the email to modify.
List of labels to add to the email.
List of labels to remove from the email.
Successful Response
Validation Error
Delete email by ID.
Args: request: The request object. http_headers: The HTTP headers.
Delete Email request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the email to delete.
Successful Response
Validation Error
Trash email by ID.
Args: request: The request object. http_headers: The HTTP headers.
Trash Email request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the email to move to trash.
Successful Response
Validation Error
Untrash email by ID.
Args: request: The request object. http_headers: The HTTP headers.
Untrash Email request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the email to move out of trash.
Successful Response
Validation Error
List threads in the user's mailbox.
Args: request: The request object. http_headers: The HTTP headers.
List Threads request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Include threads in spam and trash.
falseOnly return threads with these label IDs.
Maximum number of threads to return.
Page token to retrieve the next page of results.
Only return threads matching the specified query. For more information, see the Gmail API documentation.
Successful Response
Validation Error
No content
Get details of a specific thread.
Args: request: The request object. http_headers: The HTTP headers.
Get Thread Details request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the thread to retrieve.
Format of the thread. Can be 'full', 'metadata', or 'minimal'.
fullList of headers to return in the metadata format.
Decode the thread body. If set to True, the thread body will be decoded from base64url encoding, you will get the thread body as a string.
falseSuccessful Response
Validation Error
No content
Modify labels of a specific thread.
Args: request: The request object. http_headers: The HTTP headers.
Modify Thread Labels request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the thread to modify.
List of labels to add to the thread.
List of labels to remove from the thread.
Successful Response
Validation Error
No content
Set auto reply settings.
Args: request: The request object. http_headers: The HTTP headers.
Set Auto Reply Settings request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]True or False. Flag that determines whether the auto-reply feature is enabled or disabled. If this is set to False, the auto-reply feature will be disabled and no auto-replies will be sent.
falseOptional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
Response body in plain text format.
Response body in HTML format. Gmail will sanitize the HTML before storing it. If both response_body_plain_text and response_body_html are specified, response_body_html will be used.
True or False. Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
falseTrue or False. Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.
falseString format (yyyy-mm-dd) timestamp in milliseconds.
An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
String format (yyyy-mm-dd) timestamp in milliseconds.
An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime. Note that when an endTime is input, it is interpreted as one day earlier than the provided date. For example, if endTime is set to '2023-05-15', the auto-replies will cease on '2023-05-14'.
Successful Response
Validation Error
No content
Download attachment by ID.
Get Attachments request model.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]ID of the message to retrieve attachments from.
ID of the attachment to retrieve.
Successful Response
Validation Error
No content
Last updated