This type defines the Microservice main entry point for the Mail feature. More...
Inheritance diagram for Beamable.Server.Api.Mail.IMicroserviceMailApi:
Collaboration diagram for Beamable.Server.Api.Mail.IMicroserviceMailApi:
Additional Inherited Members | |
 Public Member Functions inherited from Beamable.Common.Api.Mail.IMailApi | |
| Promise< SearchMailResponse > | SearchMail (SearchMailRequest request) |
| Find mail given a SearchMailRequest argument. The request contains a set of SearchMailRequestClause that can be configured to search for specific types of mail. More... | |
| Promise< ListMailResponse > | GetMail (string category, long startId=0, long limit=100) |
| Get the latest mail for a player More... | |
| Promise< EmptyResponse > | SendMail (MailSendRequest request) |
| Must be sent from an admin user or a microservice. Send mail to one or many users. More... | |
| Promise< EmptyResponse > | Update (MailUpdateRequest updates) |
| Must be sent from an admin user or a microservice. Update a mailing after it has been sent. More... | |
| Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< MailQueryResponse > | |
| Promise< TData > | GetCurrent (string scope="") |
| Manually fetch the available data. If the server hasn't delivered a new update, this method will not return the absolute latest data unless you pass forceRefresh as true. More... | |
Detailed Description
This type defines the Microservice main entry point for the Mail feature.
Related Links
- See the Mail feature documentation
- See Beamable.Server.IBeamableServices script reference
The documentation for this interface was generated from the following file:
- com.beamable.server/SharedRuntime/Api/Mail/IMicroserviceMailApi.cs
