Email Management API

this is a technical guide on the development of oelite management portal production api endpoint https //ama beta api oelite io production api swagger https //ama api oelite io/swagger email accounts { "tab" "examples", "url" "/messaging/emails/accounts", "name" "email account fetch authorized mail accounts", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "oygciugootx wlapirlyo", "code" "{\n \\"data\\" \[\n {\n \\"name\\" \\"test user\\",\n \\"displayname\\" \\"test user\\",\n \\"isexternalaccount\\"\ false,\n \\"emailaddress\\" \\"test user\@abc com\\",\n \\"integratedmailaccountuserid\\" \\"635b6d31a3ea7b3fa0fb93f5\\",\n \\"outgoingmailserverport\\" 0,\n \\"sslenabled\\"\ false,\n \\"owneraccountid\\" 121,\n \\"owneruserid\\" 323,\n \\"createdonutc\\" \\"2022 09 09t17 40 49z\\",\n \\"incomingmailserverport\\" 0,\n \\"shareduserid\\" 0,\n \\"canread\\"\ true,\n \\"canwrite\\"\ true,\n \\"candelete\\"\ true,\n \\"shareduserstatus\\" 10,\n \\"searchindexallowed\\"\ true,\n \\"id\\" 1,\n \\"status\\" 0,\n \\"basesearchcount\\" 0,\n \\"searchindexid\\" \\"1\\",\n \\"isdeleted\\"\ false\n },\n {\n \\"name\\" \\"test shared\\",\n \\"displayname\\" \\" test shared\\",\n \\"isexternalaccount\\"\ false,\n \\"integratedmailaccountuserid\\" \\"621b6dab5c20c8b24be9f00d\\",\n \\"outgoingmailserverport\\" 0,\n \\"sslenabled\\"\ false,\n \\"owneraccountid\\" 121,\n \\"owneruserid\\" 323,\n \\"createdonutc\\" \\"2022 09 09t17 40 50z\\",\n \\"incomingmailserverport\\" 0,\n \\"shareduserid\\" 0,\n \\"canread\\"\ true,\n \\"canwrite\\"\ true,\n \\"candelete\\"\ true,\n \\"shareduserstatus\\" 10,\n \\"searchindexallowed\\"\ true,\n \\"id\\" 2,\n \\"status\\" 0,\n \\"basesearchcount\\" 0,\n \\"searchindexid\\" \\"2\\",\n \\"isdeleted\\"\ false\n }\n ],\n \\"total\\" 2,\n \\"message\\" \\"\\",\n \\"success\\"\ true,\n \\"createdonutc\\" \\"0001 01 01t00 00 00z\\",\n \\"expiryonutc\\" \\"0001 01 01t00 00 00z\\",\n \\"gracetillutc\\" \\"0001 01 01t00 00 00z\\",\n \\"associatedtotalcountpropertyname\\" \\"totalrecordscount\\"\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "oygciugootx wlapirlyo" }, "examples" { "languages" \[ { "id" "jxzs5rznkidbp024e lbn", "code" "", "language" "json", "customlabel" "" } ], "selectedlanguageid" "jxzs5rznkidbp024e lbn" }, "description" "get all authorized mail account for the current requesting user", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } response a list of " mailaccount " should be expected mailboxes { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/mailboxes", "name" "mailbox fetch mailboxes", "method" "post", "request" { "pathparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "number", "children" \[], "description" "id of the mail account, used as part of the url path" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "specialuse", "type" "boolean", "children" \[], "description" "should the response include only folders with specialuse flag" }, { "kind" "optional", "name" "showhidden", "type" "boolean", "children" \[], "description" "if true, hidden folders will also be returned" }, { "kind" "optional", "name" "counters", "type" "boolean", "children" \[], "description" "if true, response will include the stats for total and unseen default is true however stating it as false will improve the query performance " }, { "kind" "optional", "name" "sizes", "type" "boolean", "children" \[], "description" "if true, the size of the mailbox in bytes will be returned " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "uiburv4f9vlwfi7n1x5rw", "code" "{\n \\"data\\" \[\n {\n \\"id\\" \\"631b6c3153ea7b3fa0fb93f6\\",\n \\"name\\" \\"inbox\\",\n \\"path\\" \\"inbox\\",\n \\"modifyindex\\" 90,\n \\"subscribed\\" true,\n \\"total\\" 26,\n \\"unseen\\" 4\n },\n {\n \\"id\\" \\"631db923ea92bcffbb88c60a\\",\n \\"name\\" \\"archive\\",\n \\"path\\" \\"archive\\",\n \\"modifyindex\\" 0,\n \\"subscribed\\" true,\n \\"total\\" 0,\n \\"unseen\\" 0\n },\n {\n \\"id\\" \\"631b6c3153ea7b3fa0fb93f9\\",\n \\"name\\" \\"drafts\\",\n \\"path\\" \\"drafts\\",\n \\"specialuse\\" \\"\\\\\\\drafts\\",\n \\"modifyindex\\" 397,\n \\"subscribed\\" true,\n \\"total\\" 1,\n \\"unseen\\" 0\n },\n {\n \\"id\\" \\"631b6c3153ea7b3fa0fb93fa\\",\n \\"name\\" \\"junk\\",\n \\"path\\" \\"junk\\",\n \\"specialuse\\" \\"\\\\\\\junk\\",\n \\"modifyindex\\" 0,\n \\"subscribed\\" true,\n \\"total\\" 0,\n \\"unseen\\" 0\n },\n {\n \\"id\\" \\"631b6c3153ea7b3fa0fb93f7\\",\n \\"name\\" \\"sent mail\\",\n \\"path\\" \\"sent mail\\",\n \\"specialuse\\" \\"\\\\\\\sent\\",\n \\"modifyindex\\" 3,\n \\"subscribed\\" true,\n \\"total\\" 3,\n \\"unseen\\" 0\n },\n {\n \\"id\\" \\"631b6c3153ea7b3fa0fb93f8\\",\n \\"name\\" \\"trash\\",\n \\"path\\" \\"trash\\",\n \\"specialuse\\" \\"\\\\\\\trash\\",\n \\"modifyindex\\" 6,\n \\"subscribed\\" true,\n \\"total\\" 6,\n \\"unseen\\" 0\n }\n ],\n \\"total\\" 1,\n \\"message\\" \\"\\",\n \\"success\\" true,\n \\"createdonutc\\" \\"0001 01 01t00 00 00z\\",\n \\"expiryonutc\\" \\"0001 01 01t00 00 00z\\",\n \\"gracetillutc\\" \\"0001 01 01t00 00 00z\\",\n \\"associatedtotalcountpropertyname\\" \\"totalrecordscount\\"\n}", "language" "200", "customlabel" "" }, { "id" "bkij2ih2malelcxoulb x", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "uiburv4f9vlwfi7n1x5rw" }, "examples" { "languages" \[ { "id" "xaacfzs60trhex8caifxv", "code" "", "language" "json", "customlabel" "" } ], "selectedlanguageid" "xaacfzs60trhex8caifxv" }, "description" "this endpoint is used to retreive a list of mailboxes of a requested mail account ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } response a list of " wdmailboxinfo " should be expected { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/purge/{mailboxid}", "name" "mailbox purge mailbox message", "method" "delete", "request" { "pathparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "number", "children" \[], "description" "id of the mail account" }, { "kind" "required", "name" "mailboxid", "type" "string", "children" \[], "description" "id of the mailbox" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "8gis7qbuto8hrzzjotg k", "code" "true", "language" "200", "customlabel" "" }, { "id" "dadnb3yrluthdenp1zs3x", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "8gis7qbuto8hrzzjotg k" }, "examples" { "languages" \[ { "id" "nrwvdpnocugug72rvmshm", "code" "", "language" "json", "customlabel" "" } ], "selectedlanguageid" "nrwvdpnocugug72rvmshm" }, "description" "delete all messages of a requested mailbox", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response "true" or "false" should be expected mailbox messages { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/messages", "name" "message fetch mailbox messages", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "number", "children" \[], "description" "id of the mail account as part of the request url" } ], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "mailboxid", "type" "string", "children" \[], "description" "id of the mailbox" }, { "kind" "optional", "name" "pagesize", "type" "number", "children" \[], "description" "number of messages to be returned" }, { "kind" "optional", "name" "pageindex", "type" "number", "children" \[], "description" "requested page number start from 0 " }, { "kind" "optional", "name" "unreadonly", "type" "boolean", "children" \[], "description" "if true, then returns only unread messages" }, { "kind" "optional", "name" "includemetadata", "type" "boolean", "children" \[], "description" "if true, then includes the metadata in the response" }, { "kind" "optional", "name" "includethreadmessagecount", "type" "boolean", "children" \[], "description" "if true, then include the threadmessagecount in the response counters slow down the query's performance " }, { "kind" "optional", "name" "sortorder", "type" "string", "children" \[], "description" "ordering of the records' creation date sortorder can only take \\"asc\\" or \\"desc\\"" }, { "kind" "optional", "name" "nextcursor", "type" "string", "children" \[], "description" "cursor value for the next page, retrieved from nextcursor in response value" }, { "kind" "optional", "name" "previouscursor", "type" "string", "children" \[], "description" "cursor value for the previous page, retrieved from previouscurosr in response value" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "0irukjckth9rnk5p2qddy", "code" "{\n \\"success\\"\ true,\n \\"total\\" 1,\n \\"page\\" 1,\n \\"previouscursor\\" \\"false\\",\n \\"nextcursor\\" \\"false\\",\n \\"results\\" \[\n {\n \\"id\\" 1,\n \\"mailbox\\" \\"631b6c3153ea7b3fa0fb93f6\\",\n \\"thread\\" \\"631db933ea92bcffbb88c60d\\",\n \\"from\\" {\n \\"name\\" \\"\\",\n \\"address\\" \\"test user\@abc com\\"\n },\n \\"to\\" \[\n {\n \\"name\\" \\"\\",\n \\"address\\" \\"test user\@abc com\\"\n }\n ],\n \\"cc\\" \[\n \n ],\n \\"bcc\\" \[\n \n ],\n \\"subject\\" \\"test test to self\\",\n \\"intro\\" \\"test this e mail is scanned by oelite enterprise mail gateway for virus and intentional spam checks e mail transmission cannot…\\",\n \\"attachments\\"\ false,\n \\"seen\\"\ false,\n \\"deleted\\"\ false,\n \\"draft\\"\ false,\n \\"flagged\\"\ false,\n \\"answered\\"\ false,\n \\"forwarded\\"\ false,\n \\"contenttype\\" {\n \\"value\\" \\"multipart/alternative\\",\n \\"params\\" {\n \\"boundary\\" \\" = rainloop 617 437411321 1662892339\\"\n }\n }\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "0irukjckth9rnk5p2qddy" }, "examples" { "languages" \[ { "id" "7 raf4wcsv4aid6scmsgn", "code" "{\n \\"pagesize\\" 20,\n \\"pageindex\\" 0,\n \\"mailboxid\\" \\"631b6c3153ea7b3fa0fb93f6\\"\n}", "language" "json", "customlabel" "" } ], "selectedlanguageid" "7 raf4wcsv4aid6scmsgn" }, "description" "this endpoint is used to retreive a list of emails of a requested mail box ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } response a " wdbaseentitycollectionresponse\<wdmessagebaseinfo> " object should be expected { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/{mailboxid}/messages", "name" "message update & move messages", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "number", "children" \[], "description" "id of the mail account" }, { "kind" "required", "name" "mailboxid", "type" "string", "children" \[], "description" "id of the mailbox where requesting messages are currently stored in" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "messageids", "type" "array", "description" "an array of requesting message ids " }, { "kind" "optional", "name" "movetomailboxid", "type" "string", "children" \[], "description" "id of a mailbox when requesting to move messages from current mailbox to the specified mailbox" }, { "kind" "optional", "name" "markasseen", "type" "boolean", "children" \[], "description" "if true, mark all requesting messages as read" }, { "kind" "optional", "name" "markasflagged", "type" "boolean", "children" \[], "description" "if true, mark all requesting messages as flagged " }, { "kind" "optional", "name" "markasdraft", "type" "boolean", "children" \[], "description" "if true, mark asll requesting messages as draft" }, { "kind" "optional", "name" "expires", "type" "string", "children" \[], "description" "a iso date string for auto expiring the message if submitted as 'false' in string, it will turn off auto expiring feature of the requesting messages " }, { "kind" "optional", "name" "metadata", "type" "string", "children" \[], "description" "metadata information update for the requesting message" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "7zf6dsyv8wftfeq6 az7e", "code" "{\n success true,\n data {\n ids \[\n 6,\n 12\n ],\n updatecount 2\n }\n}", "language" "200", "customlabel" "" }, { "id" "fbeigs7270pdwsaggld00", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "7zf6dsyv8wftfeq6 az7e" }, "examples" { "languages" \[ { "id" "vgrpxlkoqqepzdslgekmm", "code" "{\n \\"messagids\\" \[],\n \\"movetomailboxid\\" \\"string\\",\n \\"markasseen\\" true,\n \\"markasflagged\\" true,\n \\"markasdraft\\" true,\n \\"expires\\" \\"string\\",\n \\"metadata\\" \\"string\\"\n}", "language" "json", "customlabel" "" } ], "selectedlanguageid" "vgrpxlkoqqepzdslgekmm" }, "description" "this endpoint is used to update one or more message statuses it is also used when moving messages to a different mailbox ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } response a responsemessage object will be returned if successful, the 'data' field should contain field " ids " which is an array of messageid and " updatecount " which indicates how many messages were updated in oelite occ project, a " wdmessageupdateresponse " object is defined for the return data { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/{mailboxid}/{messageid}/{markasseen}", "name" "message get messsage details", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "string", "children" \[], "description" "id of the mail account" }, { "kind" "required", "name" "mailboxid", "type" "string", "children" \[], "description" "id of the mail box" }, { "kind" "required", "name" "messageid", "type" "number", "children" \[], "description" "id of the email" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "cd6vfgg blo1jh90mcuvx", "code" "{\n \\"success\\"\ true,\n \\"total\\" 1,\n \\"page\\" 1,\n \\"previouscursor\\" \\"false\\",\n \\"nextcursor\\" \\"false\\",\n \\"results\\" \[\n {\n \\"id\\" 1,\n \\"mailbox\\" \\"631b6c3153ea7b3fa0fb93f6\\",\n \\"thread\\" \\"631db933ea92bcffbb88c60d\\",\n \\"from\\" {\n \\"name\\" \\"\\",\n \\"address\\" \\"test user\@abc com\\"\n },\n \\"to\\" \[\n {\n \\"name\\" \\"\\",\n \\"address\\" \\"test user\@abc com\\"\n }\n ],\n \\"cc\\" \[\n \n ],\n \\"bcc\\" \[\n \n ],\n \\"subject\\" \\"test test to self\\",\n \\"intro\\" \\"test this e mail is scanned by oelite enterprise mail gateway for virus and intentional spam checks e mail transmission cannot…\\",\n \\"attachments\\"\ false,\n \\"seen\\"\ false,\n \\"deleted\\"\ false,\n \\"draft\\"\ false,\n \\"flagged\\"\ false,\n \\"answered\\"\ false,\n \\"forwarded\\"\ false,\n \\"contenttype\\" {\n \\"value\\" \\"multipart/alternative\\",\n \\"params\\" {\n \\"boundary\\" \\" = rainloop 617 437411321 1662892339\\"\n }\n }\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "cd6vfgg blo1jh90mcuvx" }, "examples" { "languages" \[ { "id" "so0efj7egz2qwowgwcskb", "code" "", "language" "json", "customlabel" "" } ], "selectedlanguageid" "so0efj7egz2qwowgwcskb" }, "description" "this endpoint is used to retreive a full message details of a requested email ", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response a " wdmessagedetail " object should be expected { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/{mailboxid}/message", "name" "message upload a mailbox message", "method" "post", "request" { "pathparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "number", "children" \[], "description" "id of the mail account" }, { "kind" "required", "name" "mailboxid", "type" "string", "children" \[], "description" "id of the mailbox" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "seen", "type" "boolean", "children" \[], "description" "is the message read or no" }, { "kind" "optional", "name" "draft", "type" "boolean", "children" \[], "description" "is the message a draft if the message is a draft (and later needs to be sent), you draft=true is required in order to use the \\"send message\\" endpoint " }, { "kind" "optional", "name" "flagged", "type" "string", "children" \[], "description" "is the message flagged" }, { "kind" "optional", "name" "raw", "type" "string", "children" \[], "description" "a message/rfc822 mime formatted content which represent the entire email when used, other message details will be discarded " }, { "kind" "required", "name" "from", "type" "object", "children" \[], "description" "object of \\"address\\"" }, { "kind" "required", "name" "to", "type" "array", "children" \[], "description" "an array of \\"address\\" which are the recipients" }, { "kind" "optional", "name" "cc", "type" "array", "children" \[], "description" "an array of \\"address\\" which are the recipients to be copied in" }, { "kind" "optional", "name" "bcc", "type" "array", "children" \[], "description" "an array of \\"address\\" which are the recipients to be blind carbon copied" }, { "kind" "required", "name" "subject", "type" "string", "children" \[], "description" "subject of the message if empty, resolve from \\"reference\\" message if available " }, { "kind" "optional", "name" "text", "type" "string", "children" \[], "description" "plaintext message" }, { "kind" "optional", "name" "html", "type" "string", "children" \[], "description" "html formatted message" }, { "kind" "optional", "name" "headers", "type" "array", "children" \[], "description" "an array of name & value pairs for the message" }, { "kind" "optional", "name" "files", "type" "array", "children" \[], "description" "an array of file ids (in string) of the attachments this is only used when the attachments are from storage files with referenced file ids " }, { "kind" "optional", "name" "attachments", "type" "array", "children" \[], "description" "an array of \\"wdmessageattachement\\" only the following fields are required content, filename, contenttype, cid " }, { "kind" "optional", "name" "metadata", "type" "string", "children" \[], "description" "a json object or string for storing additional data " }, { "kind" "optional", "name" "reference", "type" "object", "children" \[], "description" "an object of wdreferencewithattachements note this field is not yet developed in current feature " }, { "kind" "optional", "name" "replaceprevious", "type" "object", "children" \[ { "kind" "required", "name" "mailbox", "type" "string", "description" "id of the mailbox" }, { "kind" "required", "name" "id", "type" "string", "description" "id of the message to be replaced" } ], "description" "if set, then delete the previous message with the same message id and replace it with the newly uploaded message it's useful when auto saving drafts " }, { "kind" "optional", "name" "ess", "type" "string", "children" \[], "description" "store a session identifier in the message for logging" }, { "kind" "optional", "name" "ip", "type" "string", "children" \[], "description" "ip address for message logging" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "8gis7qbuto8hrzzjotg k", "code" "{\n success \\"true\\",\n data {\n id 511,\n mailbox \\"631b6c3153ea7b3fa0fb93f8\\"\n }\n}", "language" "200", "customlabel" "" }, { "id" "dadnb3yrluthdenp1zs3x", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "8gis7qbuto8hrzzjotg k" }, "examples" { "languages" \[ { "id" "nrwvdpnocugug72rvmshm", "code" "{\n \\"unseen\\" true,\n \\"draft\\" true,\n \\"flagged\\" true,\n \\"raw\\" \\"string\\",\n \\"from\\" {\n \\"name\\" \\"string\\",\n \\"address\\" \\"string\\"\n },\n \\"to\\" \[\n {\n \\"name\\" \\"string\\",\n \\"address\\" \\"string\\"\n }\n ],\n \\"cc\\" \[\n {\n \\"name\\" \\"string\\",\n \\"address\\" \\"string\\"\n }\n ],\n \\"bcc\\" \[\n {\n \\"name\\" \\"string\\",\n \\"address\\" \\"string\\"\n }\n ],\n \\"subject\\" \\"string\\",\n \\"text\\" \\"string\\",\n \\"html\\" \\"string\\",\n \\"headers\\" \[\n {\n \\"key\\" \\"string\\",\n \\"value\\" \\"string\\"\n }\n ],\n \\"files\\" \[\n \\"string\\"\n ],\n \\"attachments\\" \[\n {\n \\"content\\" \\"string\\",\n \\"filename\\" \\"string\\",\n \\"contenttype\\" \\"string\\",\n \\"cid\\" \\"string\\"\n }\n ],\n \\"metadata\\" {},\n \\"reference\\" {\n \\"mailbox\\" \\"string\\",\n \\"id\\" 0,\n \\"action\\" \\"string\\",\n \\"attachments\\" \[\n \\"string\\"\n ]\n },\n \\"replaceprevious\\" {\n \\"mailbox\\" \\"string\\",\n \\"id\\" 0\n },\n \\"sess\\" \\"string\\",\n \\"ip\\" \\"string\\"\n}", "language" "json", "customlabel" "" } ], "selectedlanguageid" "nrwvdpnocugug72rvmshm" }, "description" "create anew email message", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } request body note the body is "wdmessageuploaddetails" object, a derived structure from "wdmessagedetails" only the fields listed above in boday parameters are used for the request response a responsemessage object with data containing the message id and mailbox id should be expected { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/{mailboxid}/{messageid}", "name" "message delete mailbox message", "method" "delete", "request" { "pathparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "number", "children" \[], "description" "id of the mail account" }, { "kind" "required", "name" "mailboxid", "type" "string", "children" \[], "description" "id of the mailbox" }, { "kind" "required", "name" "messageid", "type" "number", "children" \[], "description" "id of the message" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "8gis7qbuto8hrzzjotg k", "code" "true", "language" "200", "customlabel" "" }, { "id" "dadnb3yrluthdenp1zs3x", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "8gis7qbuto8hrzzjotg k" }, "examples" { "languages" \[ { "id" "lzexa1e7m5qus6hi8jiku", "code" "", "language" "json", "customlabel" "" } ], "selectedlanguageid" "lzexa1e7m5qus6hi8jiku" }, "description" "delete a messages", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/messages", "name" "message batch delete mailbox messages", "method" "delete", "request" { "pathparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "number", "children" \[], "description" "id of the mail account" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" " ", "type" "array", "description" "an array of deletemessagerequest or wddeletemessagerequest object " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "wkqrydrhpxpcrwnnfwdky", "code" "{\n success true,\n deleted 2\n}", "language" "200", "customlabel" "" }, { "id" "sw8rbvsy6vfp8fvd ukso", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "wkqrydrhpxpcrwnnfwdky" }, "examples" { "languages" \[ { "id" "uemtzxi8petoeuupkv8yu", "code" "\[\n {\n mailboxid \\"string\\",\n messageid number\n },\n {\n mailboxid \\"string\\",\n messageid number\n }\n]", "language" "json", "customlabel" "" } ], "selectedlanguageid" "uemtzxi8petoeuupkv8yu" }, "description" "delete a number of messages", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response an object of wddeletemessageresult should be expected { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/{mailboxid}/{messageid}/attachment/download", "name" "message download attachment", "method" "post", "request" { "pathparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "number", "children" \[], "description" "id of the mail account" }, { "kind" "required", "name" "mailboxid", "type" "string", "children" \[], "description" "id of the mailbox" }, { "kind" "required", "name" "messageid", "type" "number", "children" \[], "description" "id of the message" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "id", "type" "string", "children" \[], "description" "id in wdmessageattachment" }, { "kind" "required", "name" "filename", "type" "string", "children" \[], "description" "filename of the attachment this is required for the download returning in correct file name" }, { "kind" "optional", "name" "contenttype", "type" "string", "children" \[], "description" "if not specified, the default contenttype is \\"application/octet stream\\"" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "8gis7qbuto8hrzzjotg k", "code" "", "language" "200", "customlabel" "" }, { "id" "dadnb3yrluthdenp1zs3x", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "8gis7qbuto8hrzzjotg k" }, "examples" { "languages" \[ { "id" "lzexa1e7m5qus6hi8jiku", "code" "{\n \\"id\\" \\"at00001\\",\n \\"filename\\" \\"text xls\\",\n \\"contenttype\\" \\"application/vnd ms excel\\"\n}", "language" "json", "customlabel" "" } ], "selectedlanguageid" "lzexa1e7m5qus6hi8jiku" }, "description" "download an attachment in a message", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } response a direct download file stream in "application/octet stream" content type { "tab" "examples", "url" "/messaging/emails/{mailaccountid}/{mailboxid}/{messageid}/deliver", "name" "message send message", "method" "post", "request" { "pathparameters" \[ { "kind" "required", "name" "mailaccountid", "type" "number", "children" \[], "description" "id of the mail account" }, { "kind" "required", "name" "mailboxid", "type" "string", "children" \[], "description" "id of the mailbox" }, { "kind" "required", "name" "messageid", "type" "number", "children" \[], "description" "id of the message" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "deletefiles", "type" "string", "children" \[], "description" "if true then deletes attachment files listed in metadata files array" }, { "kind" "optional", "name" "sendtime", "type" "string", "children" \[], "description" "this allows user to specify a future date time for delivery instead of sending the message out immediately " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "8gis7qbuto8hrzzjotg k", "code" "{\n \\"success\\" true,\n \\"data\\" {\n \\"id\\" 0,\n \\"mailbox\\" \\"string\\",\n \\"size\\" 0\n }\n}\n", "language" "200", "customlabel" "" }, { "id" "dadnb3yrluthdenp1zs3x", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "8gis7qbuto8hrzzjotg k" }, "examples" { "languages" \[ { "id" "lzexa1e7m5qus6hi8jiku", "code" "{\n \\"deletefiles\\" false\n}", "language" "json", "customlabel" "" } ], "selectedlanguageid" "lzexa1e7m5qus6hi8jiku" }, "description" "send a message for delivery to deliver message using api, the message should have already been created as draft so a messageid can be obtained\n", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } request body the body parameters is available as " wdmessagedeliverrequest " object response a "responsemessage" should be expected