| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.settings.html">settings</a> . <a href="gmail_v1.users.settings.filters.html">filters</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(userId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a filter.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(userId, id, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a filter.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(userId, id, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a filter.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(userId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the message filters of a Gmail user.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(userId, body=None, x__xgafv=None)</code> |
| <pre>Creates a filter. |
| |
| Args: |
| userId: string, User's email address. The special value "me" |
| can be used to indicate the authenticated user. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Resource definition for Gmail filters. Filters apply to specific messages |
| # instead of an entire email thread. |
| "action": { # A set of actions to perform on a message. # Action that the filter performs. |
| "forward": "A String", # Email address that the message should be forwarded to. |
| "removeLabelIds": [ # List of labels to remove from the message. |
| "A String", |
| ], |
| "addLabelIds": [ # List of labels to add to the message. |
| "A String", |
| ], |
| }, |
| "id": "A String", # The server assigned ID of the filter. |
| "criteria": { # Message matching criteria. # Matching criteria for the filter. |
| "negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same |
| # query format as the Gmail search box. For example, |
| # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> |
| # is:unread"`. |
| "subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and |
| # leading whitespace are be trimmed and adjacent spaces are collapsed. |
| "to": "A String", # The recipient's display name or email address. Includes recipients in the |
| # "to", "cc", and "bcc" header fields. You can use simply the local part of |
| # the email address. For example, "example" and "example@" both match |
| # "example@gmail.com". This field is case-insensitive. |
| "size": 42, # The size of the entire RFC822 message in bytes, including all headers and |
| # attachments. |
| "query": "A String", # Only return messages matching the specified query. Supports the same |
| # query format as the Gmail search box. For example, |
| # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> |
| # is:unread"`. |
| "excludeChats": True or False, # Whether the response should exclude chats. |
| "sizeComparison": "A String", # How the message size in bytes should be in relation to the size field. |
| "hasAttachment": True or False, # Whether the message has any attachment. |
| "from": "A String", # The sender's display name or email address. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Resource definition for Gmail filters. Filters apply to specific messages |
| # instead of an entire email thread. |
| "action": { # A set of actions to perform on a message. # Action that the filter performs. |
| "forward": "A String", # Email address that the message should be forwarded to. |
| "removeLabelIds": [ # List of labels to remove from the message. |
| "A String", |
| ], |
| "addLabelIds": [ # List of labels to add to the message. |
| "A String", |
| ], |
| }, |
| "id": "A String", # The server assigned ID of the filter. |
| "criteria": { # Message matching criteria. # Matching criteria for the filter. |
| "negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same |
| # query format as the Gmail search box. For example, |
| # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> |
| # is:unread"`. |
| "subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and |
| # leading whitespace are be trimmed and adjacent spaces are collapsed. |
| "to": "A String", # The recipient's display name or email address. Includes recipients in the |
| # "to", "cc", and "bcc" header fields. You can use simply the local part of |
| # the email address. For example, "example" and "example@" both match |
| # "example@gmail.com". This field is case-insensitive. |
| "size": 42, # The size of the entire RFC822 message in bytes, including all headers and |
| # attachments. |
| "query": "A String", # Only return messages matching the specified query. Supports the same |
| # query format as the Gmail search box. For example, |
| # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> |
| # is:unread"`. |
| "excludeChats": True or False, # Whether the response should exclude chats. |
| "sizeComparison": "A String", # How the message size in bytes should be in relation to the size field. |
| "hasAttachment": True or False, # Whether the message has any attachment. |
| "from": "A String", # The sender's display name or email address. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(userId, id, x__xgafv=None)</code> |
| <pre>Deletes a filter. |
| |
| Args: |
| userId: string, User's email address. The special value "me" |
| can be used to indicate the authenticated user. (required) |
| id: string, The ID of the filter to be deleted. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(userId, id, x__xgafv=None)</code> |
| <pre>Gets a filter. |
| |
| Args: |
| userId: string, User's email address. The special value "me" |
| can be used to indicate the authenticated user. (required) |
| id: string, The ID of the filter to be fetched. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Resource definition for Gmail filters. Filters apply to specific messages |
| # instead of an entire email thread. |
| "action": { # A set of actions to perform on a message. # Action that the filter performs. |
| "forward": "A String", # Email address that the message should be forwarded to. |
| "removeLabelIds": [ # List of labels to remove from the message. |
| "A String", |
| ], |
| "addLabelIds": [ # List of labels to add to the message. |
| "A String", |
| ], |
| }, |
| "id": "A String", # The server assigned ID of the filter. |
| "criteria": { # Message matching criteria. # Matching criteria for the filter. |
| "negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same |
| # query format as the Gmail search box. For example, |
| # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> |
| # is:unread"`. |
| "subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and |
| # leading whitespace are be trimmed and adjacent spaces are collapsed. |
| "to": "A String", # The recipient's display name or email address. Includes recipients in the |
| # "to", "cc", and "bcc" header fields. You can use simply the local part of |
| # the email address. For example, "example" and "example@" both match |
| # "example@gmail.com". This field is case-insensitive. |
| "size": 42, # The size of the entire RFC822 message in bytes, including all headers and |
| # attachments. |
| "query": "A String", # Only return messages matching the specified query. Supports the same |
| # query format as the Gmail search box. For example, |
| # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> |
| # is:unread"`. |
| "excludeChats": True or False, # Whether the response should exclude chats. |
| "sizeComparison": "A String", # How the message size in bytes should be in relation to the size field. |
| "hasAttachment": True or False, # Whether the message has any attachment. |
| "from": "A String", # The sender's display name or email address. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(userId, x__xgafv=None)</code> |
| <pre>Lists the message filters of a Gmail user. |
| |
| Args: |
| userId: string, User's email address. The special value "me" |
| can be used to indicate the authenticated user. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for the ListFilters method. |
| "filter": [ # List of a user's filters. |
| { # Resource definition for Gmail filters. Filters apply to specific messages |
| # instead of an entire email thread. |
| "action": { # A set of actions to perform on a message. # Action that the filter performs. |
| "forward": "A String", # Email address that the message should be forwarded to. |
| "removeLabelIds": [ # List of labels to remove from the message. |
| "A String", |
| ], |
| "addLabelIds": [ # List of labels to add to the message. |
| "A String", |
| ], |
| }, |
| "id": "A String", # The server assigned ID of the filter. |
| "criteria": { # Message matching criteria. # Matching criteria for the filter. |
| "negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same |
| # query format as the Gmail search box. For example, |
| # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> |
| # is:unread"`. |
| "subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and |
| # leading whitespace are be trimmed and adjacent spaces are collapsed. |
| "to": "A String", # The recipient's display name or email address. Includes recipients in the |
| # "to", "cc", and "bcc" header fields. You can use simply the local part of |
| # the email address. For example, "example" and "example@" both match |
| # "example@gmail.com". This field is case-insensitive. |
| "size": 42, # The size of the entire RFC822 message in bytes, including all headers and |
| # attachments. |
| "query": "A String", # Only return messages matching the specified query. Supports the same |
| # query format as the Gmail search box. For example, |
| # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> |
| # is:unread"`. |
| "excludeChats": True or False, # Whether the response should exclude chats. |
| "sizeComparison": "A String", # How the message size in bytes should be in relation to the size field. |
| "hasAttachment": True or False, # Whether the message has any attachment. |
| "from": "A String", # The sender's display name or email address. |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
