Pictures, names and company logos for the addresses a client shows
For the addresses a client is showing, which are mailboxes on this platform, with their display name and a signed link to their picture when they have one.
An address with no picture whose domain belongs to a company -- not a personal mail provider such as gmail.com, not an IP literal, a single label or a reserved name -- also gets logoUrl, a signed link to the company's logo (see GET /v1/mail/logos/{domain}). The link is handed out without looking anything up, so it may lead to a 404 when the company has no usable logo. The apps show a logo only beside a message that passed DMARC for its From domain, so a spoofed message keeps its initials, and never for a person (a recipient, an account).
Addresses with neither are left out, so the client shows initials for them.
Parameters
| Name | In | Description |
|---|---|---|
| addressesrequired | query | Up to 200 addresses, comma separated. |
Example
curl https://api.woyra.io/v1/mail/avatars \
-H "Authorization: Bearer $WOYRA_KEY"Response
200 The avatars found.
| Field | Type | Description |
|---|---|---|
| object | string | One of list. |
| data | array of object | |
| data.addressrequired | string | |
| data.name | string | |
| data.pictureUrl | string | |
| data.logoUrl | string | The sender's company logo, by signed link. Absent when there is a picture. |
Errors
| Status | Codes |
|---|---|
| 400 | invalid_request, unsupported_version |
| 401 | authentication_required, invalid_api_key |
Also in Mailboxes
- GET /v1/mailboxes — List mailboxes
- POST /v1/mailboxes — Create a mailbox
- GET /v1/mailboxes/{id} — Get a mailbox
- PATCH /v1/mailboxes/{id} — Change a mailbox's quota, suspension or password
- DELETE /v1/mailboxes/{id} — Delete a mailbox and its mail
- GET /v1/mailboxes/usage — Usage per mailbox for a period
- GET /v1/mailboxes/{id}/messages — List the messages in a folder
- GET /v1/mailboxes/{id}/messages/{message_id} — Read a message
- GET /v1/mailboxes/{id}/messages/{message_id}/attachments/{attachment_id} — Download an attachment by signed link
- POST /v1/mailboxes/{id}/messages/flags — Mark messages read, unread, flagged or unflagged
- POST /v1/mailboxes/{id}/messages/move — Move messages to another folder
- POST /v1/mailboxes/{id}/messages/delete — Delete messages for good
- GET /v1/mailboxes/{id}/changes — What changed in a mailbox since a cursor
- POST /v1/mailboxes/{id}/send — Send a message from a mailbox
- GET /v1/mailboxes/{id}/profile — A mailbox's profile
- PATCH /v1/mailboxes/{id}/profile — Change a mailbox's display name, letterhead or signature
- PUT /v1/mailboxes/{id}/profile/picture — Set a mailbox's picture
- GET /v1/mailboxes/sending_limits — What the account may send today, and why
- POST /v1/mail/auth/token — Get a mailbox token for Woyra Mail's apps
- POST /v1/mail/devices — Register this native device for mailbox notifications
- DELETE /v1/mail/devices — Remove a push destination belonging to this device session
- POST /v1/mail/auth/refresh — Rotate a mailbox device session
- POST /v1/mail/auth/revoke — Revoke this mailbox device session
- GET /v1/mail/sync/changes — What changed in the mailbox since a cursor
- GET /v1/mail/sync/messages — Several messages at once
- GET /v1/mail/messages — A folder's messages, newest first
- GET /v1/mail/search — Search the whole mailbox, newest first
- GET /v1/mail/rules — The mailbox's rules and blocked senders
- POST /v1/mail/rules — Add a rule, or block a sender
- DELETE /v1/mail/rules/{id} — Remove a rule, or unblock a sender
- GET /v1/mail/autoreply — The out-of-office reply
- PUT /v1/mail/autoreply — Set the out-of-office reply
- POST /v1/mail/messages/{id}/unsubscribe — Leave the list a message came from
- POST /v1/mail/messages/{id}/cancel-send — Call back a message sent for later
- POST /v1/mail/messages/send — Send from the token's mailbox
- GET /v1/mail/profile — The token's mailbox profile
- PATCH /v1/mail/profile — Change the display name, letterhead or signature
- PUT /v1/mail/profile/picture — Set the mailbox's picture
- DELETE /v1/mail/profile/picture — Remove the mailbox's picture
- PUT /v1/mail/profile/letterhead-image — Set the picture at the head of the letterhead
- DELETE /v1/mail/profile/letterhead-image — Remove the letterhead picture
- GET /v1/mail/letterheads/{id} — A mailbox's letterhead picture, by signed link
- GET /v1/mail/logos/{domain} — A company's logo, by signed link
- GET /v1/mail/pictures/{id} — A mailbox's picture, by signed link
- GET /v1/mail/messages/{id} — One message with its body, marking it read
- PATCH /v1/mail/messages/{id} — Mark a message read or unread, star it, or file it in another folder
- GET /v1/mail/messages/{id}/attachments/{attachment_id} — A short-lived link to one attachment
- GET /v1/mail/unread — How many messages in INBOX are unread
- GET /v1/aliases — List aliases
- POST /v1/aliases — Create or repoint an alias
- DELETE /v1/aliases/{id} — Delete an alias