EmailAddress
Properties
| Name |
Type |
Description |
Notes |
| userFormat |
String |
Email address in arbitrary format as provided by user. Note: Please be aware that this format may vary between email addresses. If you need a format for programmatic purposes, please consider using `rfc882Format` (for delivery) or `normalFormat` (for duplicate detection). |
[default to null] |
| rfc882Format |
String |
Email address in RFC882 standard format meant for delivery. Based on RFC 1035, section 3.1 the domain part is case-insensitive. However, according to RFC 5321, section 2.3.11 the local part of an email address (`local@domain`) MUST be interpreted and assigned semantics only by the host specified in the domain part of the address. Thus, this format applies lower-case only to the domain part. However, there are exceptions where the local part may also be lowercased for common services, roles, and functions as defined in RFC 2142. For example, while this format will not lower-case the local part of `Sales-Team@modigie.com`, it will lowercase the local part of `sales@modigie.com`, because it is one of the common mailbox names. This is the safest format to use in the `TO` (recipient) field of an email. |
[optional] [default to null] |
| normalFormat |
String |
Entirely lower-case format of the `rfc882Format` meant for duplicate detection. The difference to `rfc882Format` is that here the local part of an email address (`local@domain`) is in lower-case, too. In `rfc882Format` only the domain is in lower-case. Although there may be legacy mail systems that interprete case-sensitive local part of an email address (`local@domain`), where theoretically `Foo@example.com` and `foo@example.com` could be routed to different mailboxes, for almost all use cases it is safe to treat email addresses as case-insensitive, at least if it comes to detecting duplicate email addresses. |
[optional] [default to null] |
| isSyntaxValid |
Boolean |
Is `true` if email address syntax is valid, but not necessearily deliverable. `\"me@localhost\"` is valid, but not deliverable. |
[optional] [default to null] |
| isDeliverable |
Boolean |
Is `true` if at the time of validation technically an email could be delivered to this email address. `\"sales-team@modigie.com\"` is valid and because the DNS records for delivering an email to this address are configured, this address is also deliverable. Note: This signal may change over time and is not authoritive. Theoretically it is possible that an email address is legit, but there are temporary issues that prevent our system from resolving the DNS and route to the recipient, so it is shown as not deliverable. Furthermore, even if shown as deliverable, there could be additional technical challenges why a recipient can't receive an email. For example: failed email authentication (DKIM, DMARC, SPF), incorrect email routes on the servers, spam filters. |
[optional] [default to null] |
[Back to Model list] [Back to API list] [Back to README]