Set forwarding
PUT
/api/v1/mailbox/forwardingForwards new mail to up to 5 addresses. keep_copy: false forwards without keeping a copy here. Send enabled: false to stop.
Errors
| Status | When |
|---|---|
401 |
No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login. |
403 |
The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required. |
422 |
No address while turning it on, more than 5 addresses, or the mailbox's own address. |
Request body
enabledbooleanForward new mail.
addressesarray<string>Where to, up to 5. Not this mailbox itself.
keep_copybooleanKeep a copy here as well.
Request
PUT
/api/v1/mailbox/forwardingcurl -X PUT 'https://courier.mailyte.com/api/v1/mailbox/forwarding' \
-H 'Authorization: Bearer MAILBOX_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"enabled": true,
"addresses": [
"ada.obi@gmail.com"
],
"keep_copy": true
}'const response = await fetch('https://courier.mailyte.com/api/v1/mailbox/forwarding', {
method: 'PUT',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"enabled": true,
"addresses": [
"ada.obi@gmail.com"
],
"keep_copy": true
}),
});
const { data } = await response.json();import requests
response = requests.put(
"https://courier.mailyte.com/api/v1/mailbox/forwarding",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
json={
"enabled": true,
"addresses": [
"ada.obi@gmail.com"
],
"keep_copy": true
},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->put('https://courier.mailyte.com/api/v1/mailbox/forwarding', [
'enabled' => true,
'addresses' => [
'ada.obi@gmail.com',
],
'keep_copy' => true,
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://courier.mailyte.com/api/v1/mailbox/forwarding")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
request["Content-Type"] = "application/json"
request.body = {
"enabled": true,
"addresses": [
"ada.obi@gmail.com"
],
"keep_copy": true
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Successful Response
dataobjectenabledbooleanaddressesarray<string>keep_copybooleanKeep a copy in this mailbox as well.
managedbooleanTrue once set through this API.
200
application/json{
"type": "success",
"msg": "Forwarding saved",
"data": {
"enabled": true,
"addresses": [
"ada.obi@gmail.com"
],
"keep_copy": true,
"managed": true
}
}Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |
403 | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |
422 | No address while turning it on, more than 5 addresses, or the mailbox's own address. |
Every status, with what causes it and what to do, is on the error reference.