SWS SendEmailWithPassword Method
Sends an email via eStore using the specified template. The organization can create custom templates, but this method does not currently support them. This will only send an email, it will not perform the update that the email is about.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AccountID | Long | Optional |
| Description | The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. | |
| EcommID | Long | Optional |
| Description | The account’s eCommerce ID number. | |
| String | Optional | |
| Description | The email address for the primary contact. | |
| EmailType | emailMsgTemplateIds | Required |
| Description | Indicates what template the email will use. Available values:
(Other templates are not available with this method.) |
|
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| Password | String | No longer used |
| Description | The customer’s password/eCommerce code. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| SentResponse | Long |
| Description | The email message ID if successful, or an error message if it failed to send. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects. We will need the standard service object, a SendEmailWithPassword request object, and a SendEmail response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SendEmailWithPassword_Request request = new SWS.SendEmailWithPassword_Request();
SWS.SendEmail_Response response;
Here is a sample code of the request object (including optional parameters):
// SendEmailWithPassword Request
request.OrgID = 123456;
request.SiteID = 123456;
request.AccountID = 123456;
request.EcommID = 123546;
request.Email = "j.doe@a.c";
request.EmailType = SWS.emailMsgTemplateIds.SWS_PASSWORD_RETRIEVAL;
Finally we can call the method and pass across the login object and the request object to retrieve our requested information. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
response = service.SendEmailWithPassword(user_request, request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.
For a full list of methods see SWS Methods.
Yardi Store Developer eXchange 