EmailError getInvalidEmails

From Catglobe Wiki
Revision as of 10:47, 7 March 2011 by 127.0.0.1 (talk | contribs) (jrfconvert import)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search



EmailError_getInvalidEmails

EmailError_getInvalidEmails(startDateTime, endDateTime [, groupResourceId])

Arguments

startDateTime: is a datetime array in the format {yyyy, mm, dd, hh, mm, ss [, milisecond][, week][, timezoneId]}. It is the start time of the period in which you are searching for invalid emails based on last updated date.

endDateTime: is a datetime array in the format {yyyy, mm, dd, hh, mm, ss [, milisecond][, week][, timezoneId]}. It is the end time of the period in which you are searching for invalid emails based on last updated date.

groupResourceId: is a number equal to the id of the group for which you will limit the returned array to.

Return type

Array of objects with the following information:

Parameter

Type

Description

EMAIL_ERROR_ADDRESS

String

An invalid email

EMAIL_ERROR_TYPE

Number

An enumeration that specifies which of four general types of error that caused the email to be declared invalid.

EMAIL_ERROR_TYPE_HARD = 0

EMAIL_ERROR_TYPE_SOFT = 1

EMAIL_ERROR_TYPE_UNKNOWN = 2

EMAIL_ERROR_DIAGNOSTIC_CODE

String

An explanation of the exact reason that the email was declared invalid.

EMAIL_ERROR_LAST_UPDATED_DATE

Array

The date that the email was declared invalid.

Example

startdatetime ={2009, 01, 01, 00, 00, 00};

enddatetime ={2009, 12, 31, 23, 59, 59};

filtergroup = 1234567;

a = EmailError_getInvalidEmails(startdatetime, enddatetime, filtergroup);

Availability

From 5.8.1