HttpClientInterface
in
Http client interface
Tags
Table of Contents
Methods
- getAttachment() : mixed
- Get message attachment
- getAttachments() : mixed
- Get message attachments
- getMessage() : mixed
- Get messages
- getMessages() : mixed
- Get messages
- markAsRead() : HttpClientInterface
- Mark message as read
- markAsUnread() : HttpClientInterface
- Mark message as unread
Methods
getAttachment()
Get message attachment
public
getAttachment(string $messageId, string $attachmentId[, string $folder = 'Inbox' ]) : mixed
Parameters
- $messageId : string
- $attachmentId : string
- $folder : string = 'Inbox'
Tags
getAttachments()
Get message attachments
public
getAttachments(string $messageId[, string $folder = 'Inbox' ]) : mixed
Parameters
- $messageId : string
- $folder : string = 'Inbox'
Tags
getMessage()
Get messages
public
getMessage(string $messageId[, bool $raw = false ]) : mixed
Parameters
- $messageId : string
- $raw : bool = false
Tags
getMessages()
Get messages
public
getMessages([string $folder = 'Inbox' ][, array<string|int, mixed> $search = [] ][, int $limit = 10 ]) : mixed
Parameters
- $folder : string = 'Inbox'
- $search : array<string|int, mixed> = []
- $limit : int = 10
Tags
markAsRead()
Mark message as read
public
markAsRead(string $messageId[, bool $isRead = true ]) : HttpClientInterface
Parameters
- $messageId : string
- $isRead : bool = true
Tags
Return values
HttpClientInterfacemarkAsUnread()
Mark message as unread
public
markAsUnread(string $messageId) : HttpClientInterface
Parameters
- $messageId : string