Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark Email from/to as deprecated #314

Merged
merged 3 commits into from
Jan 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/v2/domains/email-forwards.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,15 @@ Create an email forward under the domain `example.com` in the account `1010`:

Name | Type | Description
-----|------|------------
`from` | `string` | **Required**. The email address the emails are sent to.
`to` | `string` | **Required**. The email address the email address the emails are forwarded to.
`alias_name` | `string` | **Required**. The receiving email recipient, the name part only without the domain. The domain is automatically appended.
`destination_email` | `string` | **Required**. The email recipient the messages are delivered to.

##### Example

~~~json
{
"from": "[email protected]",
"to": "jim@another.com"
"alias_name": "john.doe",
"destination_email": "john@another.com"
}
~~~

Expand Down
33 changes: 24 additions & 9 deletions content/v2/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2989,26 +2989,38 @@ components:
updated_at: '2017-02-03T17:43:22.000Z'
EmailForward:
type: object
example:
id: 1
domain_id: 2
alias_email: [email protected]
destination_email: [email protected]
created_at: '2016-02-04T14:26:50Z'
updated_at: '2016-02-04T14:26:50Z'
properties:
id:
type: integer
domain_id:
type: integer
alias_email:
type: string
format: email
description: The receiving email recipient.
destination_email:
type: string
format: email
description: The email recipient the messages are delivered to.
from:
type: string
deprecated: true
description: Deprecated in favor of alias_email.
to:
type: string
deprecated: true
description: Deprecated in favor of destination_email.
created_at:
$ref: '#/components/schemas/DateTime'
updated_at:
$ref: '#/components/schemas/DateTime'
example:
id: 1
domain_id: 2
from: [email protected]
to: [email protected]
created_at: '2016-02-04T14:26:50Z'
updated_at: '2016-02-04T14:26:50Z'
EventAccountAddUser:
type: object
description: Payload for account.add_user event.
Expand Down Expand Up @@ -4557,10 +4569,13 @@ components:
schema:
type: object
properties:
from:
alias_name:
type: string
to:
description: The receiving email recipient, the name part only without the domain. The domain is automatically appended.
destination_email:
type: string
format: email
description: The email recipient the messages are delivered to.
example:
from: john.doe
to: [email protected]
Expand Down
39 changes: 22 additions & 17 deletions fixtures/v2/api/createEmailForward/created.http
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
HTTP/1.1 201 Created
Server: nginx
Date: Thu, 04 Feb 2016 14:26:51 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: identity
Connection: keep-alive
Status: 201 Created
X-RateLimit-Limit: 4000
X-RateLimit-Remaining: 3991
X-RateLimit-Reset: 1454596042
ETag: W/"10dd958c5a3a43eec0af1d8da655cab0"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fca523a2-aad9-49e6-a828-a0e7711a8501
X-Runtime: 1.711621
Strict-Transport-Security: max-age=31536000

{"data":{"id":17706,"domain_id":228963,"from":"[email protected]","to":"[email protected]","created_at":"2016-02-04T14:26:50Z","updated_at":"2016-02-04T14:26:50Z"}}
HTTP/1.1 201 Created
Server: nginx
Date: Mon, 25 Jan 2021 13:54:40 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: identity
Connection: keep-alive
X-RateLimit-Limit: 4800
X-RateLimit-Remaining: 4772
X-RateLimit-Reset: 1611583415
ETag: W/"80ad3ad1e115a8123193447fa003f68a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1086590f-0e65-4010-8636-031400a662bf
X-Runtime: 0.880228
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Content-Security-Policy: frame-ancestors 'none'
Strict-Transport-Security: max-age=31536000

{"data":{"id":41872,"domain_id":235146,"alias_email":"[email protected]","destination_email":"[email protected]","created_at":"2021-01-25T13:54:40Z","updated_at":"2021-01-25T13:54:40Z","from":"[email protected]","to":"[email protected]"}}
19 changes: 12 additions & 7 deletions fixtures/v2/api/deleteEmailForward/success.http
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
HTTP/1.1 204 No Content
Server: nginx
Date: Thu, 04 Feb 2016 17:14:52 GMT
Date: Mon, 25 Jan 2021 13:56:43 GMT
Connection: keep-alive
Status: 204 No Content
X-RateLimit-Limit: 4000
X-RateLimit-Remaining: 3999
X-RateLimit-Reset: 1454609692
X-RateLimit-Limit: 4800
X-RateLimit-Remaining: 4765
X-RateLimit-Reset: 1611583416
Cache-Control: no-cache
X-Request-Id: 716d181c-495d-47ab-ab79-391a70e8abe1
X-Runtime: 0.145208
X-Request-Id: bfaceb73-4fd3-4490-8528-472ec1df3526
X-Runtime: 0.506670
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Content-Security-Policy: frame-ancestors 'none'
Strict-Transport-Security: max-age=31536000

23 changes: 14 additions & 9 deletions fixtures/v2/api/getEmailForward/success.http
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
HTTP/1.1 200 OK
Server: nginx
Date: Thu, 04 Feb 2016 14:42:46 GMT
Date: Mon, 25 Jan 2021 13:56:24 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: identity
Connection: keep-alive
Status: 200 OK
X-RateLimit-Limit: 4000
X-RateLimit-Remaining: 3999
X-RateLimit-Reset: 1454600566
ETag: W/"10dd958c5a3a43eec0af1d8da655cab0"
X-RateLimit-Limit: 4800
X-RateLimit-Remaining: 4766
X-RateLimit-Reset: 1611583416
ETag: W/"80ad3ad1e115a8123193447fa003f68a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fde15363-9332-4b91-bd8f-00b144eb8081
X-Runtime: 0.022117
X-Request-Id: 8f3a9517-f623-4d14-be2b-3f332a4d7873
X-Runtime: 0.010653
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Content-Security-Policy: frame-ancestors 'none'
Strict-Transport-Security: max-age=31536000

{"data":{"id":17706,"domain_id":228963,"from":"[email protected]","to":"jim@another.com","created_at":"2016-02-04T14:26:50Z","updated_at":"2016-02-04T14:26:50Z"}}
{"data":{"id":41872,"domain_id":235146,"alias_email":"[email protected]","destination_email":"example@example.com","created_at":"2021-01-25T13:54:40Z","updated_at":"2021-01-25T13:54:40Z","from":"[email protected]","to":"[email protected]"}}