{"swagger":"2.0","info":{"version":"v4","title":"Global Email","description":"[Global Email Wiki](http://wiki.melissadata.com/index.php?title=Global_Email)\n\n# Overview\nWelcome to Global Email by Melissa.\n\nThe Global Email Cloud Service features real-time Email Mailbox Verification that captures up to 99% of bad emails, helps improve campaign deliverability, increases conversions, and prevents bounce-backs and black listing.\n\nGlobal Email validates your email address information and will allow your Web sites and custom applications to update email addresses in your database files while verifying and correcting misspelled domain names.\n\n![Global Email Diagram](http://wiki.melissadata.com/images/a/a0/EXT_GlobalEmail_Diagram.png \"Global Email Diagram\")\n\n#### You can use Global Email to:\n  * Verify and correct syntax errors; checks for illegal characters and extra “@” characters.\n  * Verify and correct top-level domain names.\n  * Check for and correct misspelled domain names.\n  * Check for and correct domains that have changed.\n  * Standardize casing in email addresses.\n  * Perform Real Time Mailbox Validation.\n\n#### Global Email Real Time Mailbox Validation has the ability to detect:\n  * The email account (the inbox) does not exist at the given domain.\n  * The email address format is incorrect.\n  * If mailbox exists on mail server.\n  * Invalid, bad email.\n  * MX Server Error.\n  * The email address is associated with a domain that doesn't exist.\n  * Unknown or catch all domains.\n  * Disposable/Spamtrap domains; Email address is disposable and the Inbox will self-destruct.\n  * Role-based emails.\n  * Valid email address.\n\nThe Global Email service provides two options for email validation: **PREMIUM** and **EXPRESS** at two different pricing and subscription models.\n\nThe **PREMIUM** option always does the most comprehensive type of real-time checking by using domain-specific logic as well as SMTP commands and other proprietary mechanisms to validate email boxes. Use the PREMIUM option when you absolutely require the highest level of Mailbox verification. Bear in mind it can sometimes take up to 12 seconds to verify an email box. Applications that are time sensitive in nature should be programmed to call the EXPRESS mode instead.\n\nThe **EXPRESS** option of Global Email will use cached mailbox validations, so any submitted emails will be checked against a database of known bad and known good emails. Any emails that are sent into the EXPRESS will also be cached so they can be looked up during a 90-day cycle. Use this option for increased cost savings or where speed and performance are of upmost importance.\n\n## Fields\n### Request\n| Field Name | REST | JSON/XML\n| ---------- | ---- | --------\n| Transmission Reference | t | TransmissionReference\n| License Key | id | CustomerID\n| Options | opt | Options\n| Format | format | Format\n| Record ID | | RecordID\n| Email | email | Email\n\n### Response\n| Field Name | Level\n| ---------- | -----\n| Version | Response (Base)\n| Transmission Reference | Response (Base)\n| Transmission Results | Response (Base)\n| Total Records | Response (Base)\n| Record ID | Record\n| Results | Record\n| Email Address | Record\n| Mailbox Name | Record\n| Domain Name | Record\n| Domain Authentication Status | Record\n| Top Level Domain | Record\n| Top Level Domain Name | Record\n| Date Checked | Record\n| EmailAgeEstimated | Record\n| Deliverability Confidence Score | Record\n| Domain Age Estimated | Record\n| Domain Expiration Date | Record\n| Domain Created Date | Record\n| Domain Updated Date | Record\n| Domain Email | Record\n| Domain Organization | Record\n| Domain Address 1 | Record\n| Domain Locality | Record\n| Domain Administrative Area | Record\n| Domain Postal Code | Record\n| Domain Country | Record\n| Domain Country Code | Record\n| Domain Availability | Record\n| Domain Private Proxy | Record\n| Privacy Flag | Record\n| MX Server | Record\n| Domain Type Indicator | Record\n| Breach Count | Record\n\n## License Key\nYou should have been provided an encrypted and unique License Key from Melissa. This is necessary for using Global Email. This value should be put into the License Key element in each Web service request.\nIf you do not have a License Key, please contact your Melissa sales representative at 1-800-MELISSA (1-800-635-4772).\n\n## Single vs. Batch\nMelissa cloud services are capable of both single record real-time processing and batch processing. The difference is simply in the number of records sent in each request. Melissa cloud services take an array of records. This array can contain anything from one to one hundred records. For a real-time process like a web form entry or a call center application, send in a request with one record. For a batch processing scenario like a database, send requests of up to 100 records until all the records are processed. Note: Make sure each record in the request has a unique Record ID.\n\n## Choosing a Web Service Protocol\nThe Global Email Cloud Service supports REST, JSON, and XML. For the undecided, here are some Pros and Cons of one Web Service protocol over the other.\n\n#### REST\n**_Pros:_** REST is lightweight and relies upon HTTP to do its work. If you don't need a strict API definition, this is the way to go. REST is also format-agnostic so you can use XML or JSON as responses.\n\n**_Cons:_** REST can only be used for sending of single records and doesn’t support strict contracts or more involved security. The Response is a JSON document.\n\n#### JSON\n**_Pros:_** JSON relies on simple object serialization based on JavaScript’s object initialization. It is very simple to use with JavaScript and easily parsed and understood by developers.\n\n**_Cons:_** No support for formal definitions. No namespace support. Not much support in Web Service clients with some platforms.\n\n## Basic Order of Operations (Pseudo Code)\n1. Choose SOAP, XML, or the REST service.\n2. Create an instance of the request object.\n3. Populate the request element CustomerID with your Product License.\n4. Set the options for the Web service.\n5. Add input email addresses to the <Records> array with anywhere from 1 to 100 <RequestRecord> items. (SOAP, XML)\n6. Call the method and pass in the request to the service using the WEB endpoint for XML or JSON requests.\n7. Examine and parse the response from the reply object back from the service.\n8. Interpret the results\n\n## Interpreting Results\nMelissa's Global Email Cloud Service uses Results Codes to determine if an email is good or bad.\nThe following Results conventions are used:\n* Cloud Service Errors: SExx\n* Cloud Transmission Errors: GExx\n* Email Address Status Codes: ESxx\n* Email Address Error Codes: EExx\n\nFor more details, see the [Global Email Wiki](http://wiki.melissadata.com/index.php?title=Global_Email)\n\n## Result Codes\nThe service returns a series of result codes to tell you of the status of the email and any changes or errors found during the verification process.\n\nFor a full list of the Result Codes returned by Global Email, see [Global Email Result Codes](http://wiki.melissadata.com/index.php?title=Result_Code_Details#Global Email)\n\n## Wiki Page\nA product support Wiki is available for your convenience. In the Wiki, you will find documentation about the service in more detail.\n\n[Global Email Wiki Page](http://wiki.melissadata.com/index.php?title=Global_Email)\n\n# Misc. Considerations\n## Firewall\nIf you are behind a firewall, you may need to allow specific IP addresses access in order to communicate with the service.\n\nFor a full list of IP Addresses, see [IP Address Information](http://wiki.melissadata.com/index.php?title=IP_Address_Information)\n\n# Further Details\n![Global Email Mailbox Validation](http://wiki.melissadata.com/images/f/fe/WS_GlobalEmailV4_MailboxValidation.png \"Global Email Mailbox Validation\")\n","contact":{"name":"Melissa Corp.","url":"http://melissadata.com/company/contact.htm"}},"externalDocs":{"description":"Global Email Wiki","url":"http://wiki.melissadata.com/index.php?title=Global_Email"},"host":"globalemail.melissadata.net","basePath":"/v4/WEB","schemes":["http","https"],"consumes":["application/json"],"produces":["application/json"],"responses":{"doGlobalEmailResponse":{"description":"This returns the record response.","schema":{"$ref":"#/definitions/doGlobalEmailResponse"},"examples":{"application/json":{"Version":" ","TransmissionReference":" ","TransmissionResults":" ","TotalRecords":" ","Records":[{"RecordID":" ","Results":" ","EmailAddress":" ","MailboxName":" ","DomainName":" ","TopLevelDomain":" ","TopLevelDomainName":" ","DateChecked":" ","EmailAgeEstimated":" ","DeliverabilityConfidenceScore":" ","DomainAgeEstimated":" ","DomainExpirationDate":" ","DomainCreatedDate":" ","DomainUpdatedDate":" ","DomainEmail":" ","DomainOrganization":" ","DomainAddress1":" ","DomainLocality":" ","DomainAdministrativeArea":" ","DomainPostalCode":" ","DomainCountry":" ","DomainCountryCode":" ","DomainAvailability":" ","DomainPrivateProxy":" ","PrivacyFlag":" ","MXServer":" ","DomainTypeIndicator":" ","BreachCount":" "}]}}}},"paths":{"/GlobalEmail/doGlobalEmail":{"get":{"description":"This is the Global Email request.\n\n**_Note:_** A License Key and Email Address are both required for this request.\n","operationId":"GETGlobalEmail","parameters":[{"name":"t","in":"query","description":"Transmission Reference - Serves as a unique identifier for this set of records. This allows you to match a response to a request.","type":"string"},{"name":"id","in":"query","description":"License Key - License Key from Melissa.","required":true,"type":"string"},{"name":"opt","in":"query","description":"Options - Pass in options you want to set for the request. Options are listed in the <OptionName>:<Setting> format with multiple options delimited with a ','.","type":"options","options":[{"name":"VerifyMailBox","parameters":["Express","Premium"]},{"name":"DomainCorrection","parameters":["off","on"]},{"name":"TimeToWait","parameters":["5","15","30","45"]},{"name":"WhoIs","parameters":["off","on"]}],"collectionFormat":"csv"},{"name":"format","in":"query","description":"Format of the request.","type":"string","enum":["xml","json"]},{"name":"email","in":"query","description":"Email Address - The email to be verified.","required":true,"type":"string"}],"responses":{"200":{"$ref":"#/responses/doGlobalEmailResponse"}}}}},"definitions":{"doGlobalEmailRequest":{"type":"object","additionalProperties":false,"required":["CustomerID","Records"],"properties":{"TransmissionReference":{"type":"string","description":"Serves as a unique identifier for this set of records. This allows you to match a response to a request."},"CustomerID":{"type":"string","description":"Customer ID is your license string. This must be valid for you to access the Web service."},"Options":{"type":"string","description":"Specify which options to use for the selected action."},"Records":{"type":"array","description":"Example: [{\"RecordID\": 1,\"Email\": \"test@melissadata.com\"},{\"RecordID\": 2,\"Email\": \"test@domain.com\"}]","items":{"$ref":"#/definitions/doGlobalEmailRequestRecord"}}},"example":{"CustomerID":"12345678","TransmissionReference":"RestJson","Records":[{"RecordID":"1","Email":"test@melissa.com"}]}},"doGlobalEmailRequestRecord":{"type":"object","properties":{"RecordID":{"type":"string","description":"The record ID."},"Email":{"type":"string","description":"The email Address to be verified."}}},"doGlobalEmailResponse":{"type":"object","properties":{"Version":{"type":"string","description":"Current revision number of Global Email."},"TransmissionReference":{"type":"string","description":"A unique identifier for this set of records. Returned as sent."},"TransmissionResults":{"type":"string","description":"Returns result codes for the request as a whole."},"TotalRecords":{"type":"string","description":"Total number of records returned."},"Records":{"type":"array","description":"Records array.","items":{"$ref":"#/definitions/doGlobalEmail_Records"}}}},"doGlobalEmail_Records":{"type":"object","properties":{"RecordID":{"type":"string","description":"A unique identifier for the current record, if sent in the request."},"Results":{"type":"string","description":"Comma delimited string with any result codes for the record."},"EmailAddress":{"type":"string","description":"Email Address, including any corrections or changes made by Global Email."},"MailboxName":{"type":"string","description":"Mailbox portion of the email address."},"DomainName":{"type":"string","description":"Domain name portion of the email address."},"DomainAuthenticationStatus":{"type":"string","description":"The security protocols used on the receiving mail server."},"TopLevelDomain":{"type":"string","description":"Top level domain portion of the email address."},"TopLevelDomainName":{"type":"string","description":"Top level domain name portion of the email address."},"DateChecked":{"type":"string","description":"Date the email address was last checked, in UTC."},"Email Age Estimated":{"type":"string","description":"The estimated minimum age of the email in days based on historical data. The value is zero when we lack historical data on a given email."},"DeliverabilityConfidenceScore":{"type":"string","description":"Returns the probability [0-100]% of an email sent to this mailbox will be successfully delivered."},"DomainAgeEstimated":{"type":"string","description":"The estimated age of the domain in days."},"DomainExpirationDate":{"type":"string","description":"The date the domain expires/expired in the YYYY-MM-DDTHH:MM:SS format."},"DomainCreatedDate":{"type":"string","description":"The date the domain was created in the YYYY-MM-DDTHH:MM:SS format."},"DomainUpdatedDate":{"type":"string","description":"The date the domain was last updated in the YYYY-MM-DDTHH:MM:SS format."},"DomainEmail":{"type":"string","description":"The email associated with the domain."},"DomainOrganization":{"type":"string","description":"The organization associated with the domain."},"DomainAddress1":{"type":"string","description":"The street address associated with the domain."},"DomainLocality":{"type":"string","description":"The locality associated with the domain."},"DomainAdministrativeArea":{"type":"string","description":"The administrative area associated with the domain."},"DomainPostalCode":{"type":"string","description":"The postal code associated with the domain."},"DomainCountry":{"type":"string","description":"The country associated with the domain."},"DomainCountryCode":{"type":"string","description":"The country code associated with the domain."},"DomainAvailability":{"type":"string","description":"Check to see if domain is available for purchase."},"DomainPrivateProxy":{"type":"string","description":"Check if domain is behind a private proxy."},"PrivacyFlag":{"type":"string","description":"The top level domain may be sensitive to privacy laws. Returns Y for yes and N for no."},"MXServer":{"type":"string","description":"Returns which Mail Exchange (MX) Server was used to validate the email."},"DomainTypeIndicator":{"type":"string","description":"Predicts if email belongs to a personal or business/organization email by analyzing the domain."},"BreachCount":{"type":"string","description":"The known number of breaches that this email account has been involved in."}}}}}