JBoss.orgCommunity Documentation
The Mail application of eXo Collaboration uses MailWebservice to provide all APIs for working with mail, such as sending/checking/storing mail to JCR.
REST API of the Mail portlet is exposed by org.exoplatform.services.cs.mail.MailWebservice class.
The Mail portlet and its services are deprecated. It remains fully supported for eXo customers, however it will not receive any enhancement and will be removed from the product scope in the future.
| Service name | Service URL | Location | Description |
|---|---|---|---|
| MailWebservice | $portalname/$restcontextname/private/cs/mail |
- Maven groupId: org.exoplatform.cs - artifactId: exo.cs.web.webservice | This service is used to call extended services of the Mail application. |
APIs Usage:
Use the following APIs to build all functions of the Mail application:
| Name | Service URL endpoint | Parameters | Expected Values | Description |
|---|---|---|---|---|
| checkMail | /checkmail/{username}/{accountId}/{folderId/}/ |
username accountID folderId |
user id account id folder id | Check mails when having a request. |
| synchFolders | /synchfolders/{username}/{accountId}/ |
username accountID |
user id account id | Synchronize the mail folders in the clients and those in the mail server. |
| stopCheckMail | /stopcheckmail/{username}/{accountId}/ |
username accountId |
user id account id | Stop checking the mail. |
| getCheckMailJobInfo | /checkmailjobinfo/{username}/{accountId}/ |
username accountId |
user id account id | The method to get information of the mail-checking job. |
| searchemail | /searchemail/{keywords} | keywords | string | Search information from emails. |