Forwarding Rules a email account

Parameters

Request

curl -X POST 'https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/forwarding-rules' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/forwarding-rules', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/forwarding-rules",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->post('https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/forwarding-rules');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/forwarding-rules")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringmailbox_forwarding_rule
  • idstring

    Unique identifier for the rule.

  • mailbox_idstring

    The mailbox this rule applies to. Retrieve it with `GET /api/v1/email-accounts/{email_account}`.

  • forward_tostring

    The address mail is forwarded to.

  • conditionobject

    When the rule applies. The two halves travel together because they are meaningless apart.

    • typestringall | from | subject | has_attachment

      `all` forwards everything; `from` and `subject` match `value`; `has_attachment` needs no value.

    • valuestring

      The address or subject fragment matched on. **null when `type` is `all` or `has_attachment`**, where there is nothing to match against — not an unknown value.

  • keep_copyboolean

    Whether the original is also left in the mailbox. False forwards and removes.

  • activeboolean

    Whether the rule is switched on. A plain flag rather than a `state`, because a forwarding rule has no mail-server lifecycle to disagree with it — nothing carries the rule to the mail server, so `true` means the rule is stored and enabled here, which is not the same statement as "mail is being forwarded".

  • created_atstring
  • updated_atstring

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.