Virima API Specification - EMEmailService Services

The requests documented in this section are directed to EMEmailService resources, which represent .

Contents

1 getSentItems GET Interface
2 getReceivedItems GET Interface
3 sendMail POST Interface
4 deleteInboxMail POST Interface
5 deleteAllInboxMail POST Interface
6 deleteSentItemsMail POST Interface
7 deleteAllSentItemsMail POST Interface
8 deleteStarredMail POST Interface
9 deleteTrashMail POST Interface
10 deleteAllTrashMail POST Interface
11 deleteTabTrashMail POST Interface
12 starredMail POST Interface
13 starSingleMail GET Interface
14 getMailDetails GET Interface
15 getStarredMails GET Interface
16 getTrashMails GET Interface
17 copyAttachments POST Interface
18 mailSearch POST Interface

getSentItems GET Interface

Method: GET

Relative URL: em-email/get-sent-items/pagenumber/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
sentitems	SentItemArray

Example Request:

Example Response:

{
   "id":2147483647,
   "totalSentMailCount":?,
   "unreadCount":?,
   "responseList":[
      {
         "id":2147483647,
         "sentTo":"?",
         "sentCC":"?",
         "subject":"?",
         "message":"?",
         "sentTime":?,
         "isAttachment":?,
         "isStarred":?,
         "userId": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "replyToMail":?,
         "relatedMailCount":?,
         "isRead":?,
         "archive":?
      }   ]
}

getReceivedItems GET Interface

Method: GET

Relative URL: em-email/get-received-items/pagenumber/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
receiveditems	ReceivedItemArray

Example Request:

Example Response:

{
   "id":816948207,
   "totalCount":?,
   "unreadCount":?,
   "responseList":[
      {
         "id":2147483647,
         "receivedFrom":"?",
         "subject":"?",
         "message":"?",
         "receivedTime":?,
         "relatedmailreceivedTime":?,
         "isAttachment":?,
         "relativemailisAttachment":?,
         "isStarred":?,
         "userId": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "replyToMail":?,
         "relatedMailCount":?,
         "isRead":?
      }   ]
}

sendMail POST Interface

Method: POST

Relative URL: em-email/send-em-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
sentitem	SentItem

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SENDMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "sentTo":"?",
   "sentCC":"?",
   "subject":"?",
   "message":"?",
   "sentTime":?,
   "isAttachment":?,
   "isStarred":?,
   "userId": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "replyToMail":?,
   "relatedMailCount":?,
   "isRead":?,
   "archive":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteInboxMail POST Interface

Method: POST

Relative URL: em-email/delete-inbox-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
deleteId	IntegerClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEINBOXMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":815043620
}

Example Response:

{
   "id":1019907580,
   "response":"?"
}

deleteAllInboxMail POST Interface

Method: POST

Relative URL: em-email/delete-all-inbox-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEALLINBOXMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteSentItemsMail POST Interface

Method: POST

Relative URL: em-email/delete-sentitems-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
deleteId	IntegerClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETESENTITEMSMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647
}

Example Response:

{
   "id":1829528437,
   "response":"?"
}

deleteAllSentItemsMail POST Interface

Method: POST

Relative URL: em-email/delete-all-sentitems-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listsOfId	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEALLSENTITEMSMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":699628431,
   "response":"?"
}

deleteStarredMail POST Interface

Method: POST

Relative URL: em-email/delete-starred-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listsOfId	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETESTARREDMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":201937860,
   "response":"?"
}

deleteTrashMail POST Interface

Method: POST

Relative URL: em-email/delete-trash-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
deleteId	IntegerClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETETRASHMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1761325685
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteAllTrashMail POST Interface

Method: POST

Relative URL: em-email/delete-all-trash-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listsOfId	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEALLTRASHMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteTabTrashMail POST Interface

Method: POST

Relative URL: em-email/delete-tab-trash-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listsOfId	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETETABTRASHMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1413952601,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

starredMail POST Interface

Method: POST

Relative URL: em-email/starred-mail/is-starred

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listsOfId	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

STARREDMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":117958251,
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

starSingleMail GET Interface

Method: GET

Relative URL: em-email/starred-mail-single/id/is-starred

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getMailDetails GET Interface

Method: GET

Relative URL: em-email/get-mail-details/sent-item-id/archive

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getStarredMails GET Interface

Method: GET

Relative URL: em-email/get-starred-mails/pagenumber/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ReceivedItemArray

Example Request:

Example Response:

{
   "id":1350008817,
   "totalCount":?,
   "unreadCount":?,
   "responseList":[
      {
         "id":2147483647,
         "receivedFrom":"?",
         "subject":"?",
         "message":"?",
         "receivedTime":?,
         "relatedmailreceivedTime":?,
         "isAttachment":?,
         "relativemailisAttachment":?,
         "isStarred":?,
         "userId": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "replyToMail":?,
         "relatedMailCount":?,
         "isRead":?
      }   ]
}

getTrashMails GET Interface

Method: GET

Relative URL: em-email/get-trash-mails/pagenumber/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
sentitems	SentItemArray

Example Request:

Example Response:

{
   "id":2147483647,
   "totalSentMailCount":?,
   "unreadCount":?,
   "responseList":[
      {
         "id":2147483647,
         "sentTo":"?",
         "sentCC":"?",
         "subject":"?",
         "message":"?",
         "sentTime":?,
         "isAttachment":?,
         "isStarred":?,
         "userId": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "replyToMail":?,
         "relatedMailCount":?,
         "isRead":?,
         "archive":?
      }   ]
}

copyAttachments POST Interface

Method: POST

Relative URL: em-email/copy-attachments

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
sentitem	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

COPYATTACHMENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "response":"?"
}

Example Response:

{
   "id":1916877529,
   "response":"?"
}

mailSearch POST Interface

Method: POST

Relative URL: em-email/mail-search/pagenumber/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
search	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

MAILSEARCH 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":652946969,
   "response":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}