GET/users/{userId}/mail/filters/{filterId}

Gets a specified filter.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

mail
mail.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/mail/filters/{filterId}

Path Parameters

ParameterTypeDescription
userId string 

Member ID (must be URL-encoded)

  • User ID
  • Login ID (email)
  • Me

required
example : me 
filterId string 

Filter ID


required
example : 1 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
filter object (filter) 

Filter information


required 

filter

PropertyTypeDescription
filterId integer 

Filter ID


required
format : int64 
folderId integer 

Folder ID


format : int32 
from string 

Sender's email address

 
toCc string 

To or cc recipient's email address

 
to string 

To recipient's email address

 
cc string 

Cc recipient's email address

 
subject string 

Subject

 
body string 

Body

 
hasAttach boolean 

Indicates whether the message has an attachment.


default : false 
highlightColor string 

Highlight color in RGB


minLength : 0 
isForwardEmail boolean 

Indicates whether to forward filtered messages.


default : false 
isMoveFolder boolean 

Indicates whether to move filtered messages to a specified folder.


default : false 
isRead boolean 

Indicates whether to mark filtered messages as Read.


default : false 
isColor boolean 

Indicates whether to highlight filtered messages with color.


default : false 
isReplyFromMe boolean 

Indicates whether the message is a reply to my message.


default : false 
isCalendarMail boolean 

Indicates whether the message is an appointment from Calendar.


default : false 
isImportant boolean 

Indicates whether to mark filtered messages as Important.


default : false 
isDelete boolean 

Indicates whether to trash filtered messages.


default : false 
isApplyExistingMails boolean 

Indicates whether to filter the existing messages as well.


default : false 

Response Example

example

1{2  "filter": {3    "filterId": 0,4    "folderId": 0,5    "from": "admin@example.com",6    "toCc": "tocc@example.com",7    "to": "to@example.com",8    "cc": "cc@example.com",9    "subject": "SubjectString",10    "body": "bodyString",11    "hasAttach": false,12    "highlightColor": "#e8f8fd",13    "isForwardEmail": false,14    "isMoveFolder": false,15    "isRead": false,16    "isColor": true,17    "isReplyFromMe": false,18    "isCalendarMail": false,19    "isImportant": false,20    "isDelete": false,21    "isApplyExistingMails": false22  }23}

HTTP 400

Bad Request

HTTP 500

Internal Server Error