United States Department of Veterans Affairs
Email Utilities
Overview
The methods in this web service provide a variety of functions relating to Emails. Below is a short description of each method.
  • ConvertToASCII_string
  • - Returns the submitted string (Email address) to its ASCII representation. This helps to keep web bots from harvesting Email addresses from web pages.
  • CreateASCIImailto_string
  • - Returns a mailto string to be used in a hyperlink. All email addresses are converted to their ASCII representation and the subject is converted to a URL safe format.
  • IsValidEmailAddressSyntax
  • - Returns a boolean (YES|NO) indicating whether or not the supplied Email address is syntactically correct.
top of page

Demonstration
Demo the ConvertToASCII_string method with inString = 'vawebservices@med.va.gov'
Demo the CreateASCIImailto_string method where toAddr = 'vawebservices@med.va.gov' AND ccAddr = '' AND bccAddr = '' AND subject = 'Web Solutions Email web service'
Demo the IsValidEmailAddressSyntax method where eAddr = 'vawebservices@med.va.gov'
top of page

Samples
There are no samples available of the methods in this web service. However, you can get an idea of the usage possibilities by looking at the demonstrations.
top of page

Summary
Below is a high-level look at the web service and the methods it has to offer for public consumption.
hierarchy: webservices.email.utilities
location: http://www.va.gov/webservices/email/utilities.cfc
wsdl: http://www.va.gov/webservices/email/utilities.cfc?wsdl
methods: ConvertToASCII_string, CreateASCIImailto_string, IsValidEmailAddressSyntax
output: string
boolean (YES,NO)
version: 1.0

top of page

Interface Details
Below is a detail look at the methods contained in this web service.

 methods
ConvertToASCII_string
remote string ConvertToASCII_string (required string inString, required string license)

This method converts the supplied EMail address to its ASCII code equivelent and returns it in a string.

Input:
inString: [string, required] - The Email address to be converted.
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.
Output:
string
CreateASCIImailto_string
remote string CreateASCIImailto_string(required string toAddr, required string ccAddr, required string bccAddr, required string subject, required string license)

This method creates and returns a Mailto string for use in a hyperlink. mailto: is included in the returned string.

Input:
toAddr: [string, required] - The Email address to be used as the To address.
ccAddr: [string, required] - If needed, the Email address to be used in the cc field.
bccAddr: [string, required] - If needed, the Email address to be used in the bcc field.
subject: [string, required] - If needed, the subject of the Email.
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.
Output:
string
IsValidEmailAddressSyntax
remote boolean IsValidEmailAddressSyntax(required string license, required string eAddr)

This method returns a boolean (YES|NO) indicating whether or not the supplied Email address is syntactically correct.

Input:
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.
eAddr: [string, required] - The Email address to be checked for proper syntax.
Output:
boolean

top of page