This shows you the differences between two versions of the page.
Last revision Both sides next revision | |||
developers:api:email [2014/10/16 13:06] Jaco van Wyk created |
developers:api:email [2014/10/17 10:26] Jaco van Wyk |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Emails ====== | ====== Emails ====== | ||
+ | ===== /v1/email/id/get ===== | ||
+ | |||
+ | Retrieve an Email by id and return it's details. | ||
+ | |||
+ | <code> | ||
+ | 'id' => $this->id, | ||
+ | 'xid' => $this->xid, | ||
+ | 'state' => $this->state, | ||
+ | 'date' => $this->date, | ||
+ | 'client' => $this->client_id ? $this->client->get_data($level+1) : NULL, | ||
+ | 'user' => $this->from_user_id ? $this->from_user->get_data($level+1) : NULL, | ||
+ | 'from' => $this->from, | ||
+ | 'to' => $this->to, | ||
+ | 'subject' => $this->subject | ||
+ | </code> | ||
+ | |||
+ | ===== Email Parameter Listing ===== | ||
+ | |||
+ | ^Name ^Availability ^Description^ | ||
+ | |id |get |The id of the Email.| | ||
+ | |xid |get |The globally unique id of the Email.| | ||
+ | |state |get |The current state of the Email.| | ||
+ | |date |get |The date this email was sent.| | ||
+ | |client |get |The client this email was sent to.| | ||
+ | |user |get |The account user that initiated the action of sending the email.| | ||
+ | |from |get |The from address of the email.| | ||
+ | |to |get |The to address of the email.| | ||
+ | |subject |get |The subject line of the email.| | ||
+ | |||
+ | ===== /v1/email/list ===== | ||
+ | |||
+ | List all Emails associated with the current account. | ||
+ | |||
+ | ===== List Email Filters ===== | ||
+ | |||
+ | ^Name ^Availability ^Description^ | ||
+ | |client_id |get |The client_id of the SMS.| | ||
+ | |page |get |The page of results to return.| | ||
+ | |perpage |get |The number of results per page to return.| |