Class EmailsApiV2Controller
Class EmailsApiV2Controller
This controller provides a gateway to the EmailService of the system. The user is able to get, send, queue and delete email records through his shop. Email forwarding is not directly supported but can be easily implemented by getting an existing email and then sending it with the updated contact addresses.
API consumers can also upload attachments through the AttachmentsApiV2Controller and later use them within their emails. The upload operation must be executed before sending/queuing the email because it is not possible to send the email JSON data and upload a file at the same time. For more info see the AttachmentsV2Controller.
- AbstractApiV2Controller
- HttpApiV2Controller
- EmailsApiV2Controller
Category: System
Located at Controllers/Api/v2/EmailsApiV2Controller.inc.php
Methods summary
protected
|
|
public
|
|
public
|
|
public
|
|
public
|
Methods inherited from HttpApiV2Controller
_linkResponse()
,
_locateResource()
,
_mapResponse()
,
_minimizeResponse()
,
_paginateResponse()
,
_searchResponse()
,
_setJsonValue()
,
_sortResponse()
,
_writeResponse()
Methods inherited from AbstractApiV2Controller
Constants summary
Constants inherited from AbstractApiV2Controller
DEFAULT_CONTROLLER_NAME
,
DEFAULT_PAGE_ITEMS
,
DEFAULT_RATE_LIMIT
,
DEFAULT_RATE_RESET_PERIOD
Properties summary
protected
|
$emailService
E-Mail service. |
|
protected
|
$emailSerializer
E-Mail serializer. |