Documentation
¶
Index ¶
- func DeleteMail(writer http.ResponseWriter, request *http.Request)
- func DownloadAttachment(writer http.ResponseWriter, request *http.Request)
- func GetMail(writer http.ResponseWriter, request *http.Request)
- func GetMailCollection(writer http.ResponseWriter, request *http.Request)
- func GetMailCount(writer http.ResponseWriter, request *http.Request)
- func GetPruneOptions(writer http.ResponseWriter, request *http.Request)
- func GetVersion(writer http.ResponseWriter, request *http.Request)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DeleteMail ¶
func DeleteMail(writer http.ResponseWriter, request *http.Request)
DeleteMail is a request to delete mail items. This expects a body containing a DeleteMailRequest object.
DELETE: /mail
func DownloadAttachment ¶
func DownloadAttachment(writer http.ResponseWriter, request *http.Request)
DownloadAttachment retrieves binary database from storage and streams it back to the caller
func GetMail ¶
func GetMail(writer http.ResponseWriter, request *http.Request)
GetMail returns a single mail item by ID.
GET: /mail/{id}
func GetMailCollection ¶
func GetMailCollection(writer http.ResponseWriter, request *http.Request)
GetMailCollection returns a collection of mail items. This is constrianed by a page number. A page of data contains 50 items.
GET: /mails?pageNumber={pageNumber}
func GetMailCount ¶
func GetMailCount(writer http.ResponseWriter, request *http.Request)
GetMailCount returns the number of mail items in storage.
GET: /mailcount
func GetPruneOptions ¶
func GetPruneOptions(writer http.ResponseWriter, request *http.Request)
GetPruneOptions returns a set of valid pruning options.
GET: /v1/pruneoptions
func GetVersion ¶
func GetVersion(writer http.ResponseWriter, request *http.Request)
GetVersion returns the current MailSlurper version
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.