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.

Sign up for GitHub

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

Jump to bottom

Add email.return_path.address #1947

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add email.return_path.address #1947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3570105
add return_path.address
ebeahan May 26, 2022
eeb6052
artifacts
ebeahan May 26, 2022
1867fb7
expect an array
ebeahan Jun 27, 2022
fd6e496
add changelog
ebeahan Jun 27, 2022
50a9ac5
Merge branch 'main' into add-email-return-path
ebeahan Jun 27, 2022
f9a88c8
update doc artifacts with latest changes
ebeahan Jun 27, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.next.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Thanks, you're awesome :-) -->
#### Added

* Add `service.node.role` #1916
* Add `email.return_path.address` #1947
* Initial set of `expected_values`. #1962

#### Improvements
Expand Down
19 changes: 19 additions & 0 deletions docs/fields/field-details.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2864,6 +2864,25 @@ example: `reply.here@example.com`

// ===============================================================

|
[[field-email-return-path-address]]
<<field-email-return-path-address, email.return_path.address>>

a| The address to deliver bounce messages. Found in the RFC 5322 `Return-Path:` header.

type: keyword


Note: this field should contain an array of values.



example: `noreply@example.com`

| extended

// ===============================================================

|
[[field-email-sender-address]]
<<field-email-sender-address, email.sender.address>>
Expand Down
8 changes: 8 additions & 0 deletions experimental/generated/beats/fields.ecs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2043,6 +2043,14 @@
in the RFC 5322 `Reply-To:` header.
example: reply.here@example.com
default_field: false
- name: return_path.address
level: extended
type: keyword
ignore_above: 1024
description: The address to deliver bounce messages. Found in the RFC 5322 `Return-Path:`
header.
example: noreply@example.com
default_field: false
- name: sender.address
level: extended
type: keyword
Expand Down
1 change: 1 addition & 0 deletions experimental/generated/csv/fields.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
8.5.0-dev+exp,true,email,email.message_id,wildcard,extended,,81ce15$8r2j59@mail01.example.com,Value from the Message-ID header.
8.5.0-dev+exp,true,email,email.origination_timestamp,date,extended,,2020-11-10T22:12:34.8196921Z,Date and time the email was composed.
8.5.0-dev+exp,true,email,email.reply_to.address,keyword,extended,array,reply.here@example.com,Address replies should be delivered to.
8.5.0-dev+exp,true,email,email.return_path.address,keyword,extended,array,noreply@example.com,The address to deliver bounce messages.
8.5.0-dev+exp,true,email,email.sender.address,keyword,extended,,,Address of the message sender.
8.5.0-dev+exp,true,email,email.subject,keyword,extended,,Please see this important message.,The subject of the email message.
8.5.0-dev+exp,true,email,email.subject.text,match_only_text,extended,,Please see this important message.,The subject of the email message.
Expand Down
13 changes: 13 additions & 0 deletions experimental/generated/ecs/ecs_flat.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2557,6 +2557,19 @@ email.reply_to.address:
- array
short: Address replies should be delivered to.
type: keyword
email.return_path.address:
dashed_name: email-return-path-address
description: The address to deliver bounce messages. Found in the RFC 5322 `Return-Path:`
header.
example: noreply@example.com
flat_name: email.return_path.address
ignore_above: 1024
level: extended
name: return_path.address
normalize:
- array
short: The address to deliver bounce messages.
type: keyword
email.sender.address:
dashed_name: email-sender-address
description: Per RFC 5322, specifies the address responsible for the actual transmission
Expand Down
13 changes: 13 additions & 0 deletions experimental/generated/ecs/ecs_nested.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3389,6 +3389,19 @@ email:
- array
short: Address replies should be delivered to.
type: keyword
email.return_path.address:
dashed_name: email-return-path-address
description: The address to deliver bounce messages. Found in the RFC 5322 `Return-Path:`
header.
example: noreply@example.com
flat_name: email.return_path.address
ignore_above: 1024
level: extended
name: return_path.address
normalize:
- array
short: The address to deliver bounce messages.
type: keyword
email.sender.address:
dashed_name: email-sender-address
description: Per RFC 5322, specifies the address responsible for the actual
Expand Down
8 changes: 8 additions & 0 deletions experimental/generated/elasticsearch/composable/component/email.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,14 @@
}
}
},
"return_path": {
"properties": {
"address": {
"ignore_above": 1024,
"type": "keyword"
}
}
},
"sender": {
"properties": {
"address": {
Expand Down
8 changes: 8 additions & 0 deletions experimental/generated/elasticsearch/legacy/template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1068,6 +1068,14 @@
}
}
},
"return_path": {
"properties": {
"address": {
"ignore_above": 1024,
"type": "keyword"
}
}
},
"sender": {
"properties": {
"address": {
Expand Down
8 changes: 8 additions & 0 deletions generated/beats/fields.ecs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1993,6 +1993,14 @@
in the RFC 5322 `Reply-To:` header.
example: reply.here@example.com
default_field: false
- name: return_path.address
level: extended
type: keyword
ignore_above: 1024
description: The address to deliver bounce messages. Found in the RFC 5322 `Return-Path:`
header.
example: noreply@example.com
default_field: false
- name: sender.address
level: extended
type: keyword
Expand Down
1 change: 1 addition & 0 deletions generated/csv/fields.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
8.5.0-dev,true,email,email.message_id,wildcard,extended,,81ce15$8r2j59@mail01.example.com,Value from the Message-ID header.
8.5.0-dev,true,email,email.origination_timestamp,date,extended,,2020-11-10T22:12:34.8196921Z,Date and time the email was composed.
8.5.0-dev,true,email,email.reply_to.address,keyword,extended,array,reply.here@example.com,Address replies should be delivered to.
8.5.0-dev,true,email,email.return_path.address,keyword,extended,array,noreply@example.com,The address to deliver bounce messages.
8.5.0-dev,true,email,email.sender.address,keyword,extended,,,Address of the message sender.
8.5.0-dev,true,email,email.subject,keyword,extended,,Please see this important message.,The subject of the email message.
8.5.0-dev,true,email,email.subject.text,match_only_text,extended,,Please see this important message.,The subject of the email message.
Expand Down
13 changes: 13 additions & 0 deletions generated/ecs/ecs_flat.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2488,6 +2488,19 @@ email.reply_to.address:
- array
short: Address replies should be delivered to.
type: keyword
email.return_path.address:
dashed_name: email-return-path-address
description: The address to deliver bounce messages. Found in the RFC 5322 `Return-Path:`
header.
example: noreply@example.com
flat_name: email.return_path.address
ignore_above: 1024
level: extended
name: return_path.address
normalize:
- array
short: The address to deliver bounce messages.
type: keyword
email.sender.address:
dashed_name: email-sender-address
description: Per RFC 5322, specifies the address responsible for the actual transmission
Expand Down
13 changes: 13 additions & 0 deletions generated/ecs/ecs_nested.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3309,6 +3309,19 @@ email:
- array
short: Address replies should be delivered to.
type: keyword
email.return_path.address:
dashed_name: email-return-path-address
description: The address to deliver bounce messages. Found in the RFC 5322 `Return-Path:`
header.
example: noreply@example.com
flat_name: email.return_path.address
ignore_above: 1024
level: extended
name: return_path.address
normalize:
- array
short: The address to deliver bounce messages.
type: keyword
email.sender.address:
dashed_name: email-sender-address
description: Per RFC 5322, specifies the address responsible for the actual
Expand Down
8 changes: 8 additions & 0 deletions generated/elasticsearch/composable/component/email.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,14 @@
}
}
},
"return_path": {
"properties": {
"address": {
"ignore_above": 1024,
"type": "keyword"
}
}
},
"sender": {
"properties": {
"address": {
Expand Down
8 changes: 8 additions & 0 deletions generated/elasticsearch/legacy/template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1026,6 +1026,14 @@
}
}
},
"return_path": {
"properties": {
"address": {
"ignore_above": 1024,
"type": "keyword"
}
}
},
"sender": {
"properties": {
"address": {
Expand Down
10 changes: 10 additions & 0 deletions schemas/email.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,16 @@
normalize:
- array

- name: return_path.address
level: extended
type: keyword
short: The address to deliver bounce messages.
description: >
The address to deliver bounce messages. Found in the RFC 5322 `Return-Path:` header.
example: "noreply@example.com"
normalize:
- array

- name: sender.address
level: extended
type: keyword
Expand Down