Difference between revisions of "EmailError getInvalidEmails"
(→EmailError_getInvalidEmails) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Email_and_SMS_Functions]] | [[Category:Email_and_SMS_Functions]] | ||
| + | Get the information of email errors in a specific time period. | ||
| + | |||
| + | === <span style="color:#DF8621;">'''Syntax'''</span> === | ||
EmailError_getInvalidEmails(''startDateTime, endDateTime [, groupResourceId]'') | EmailError_getInvalidEmails(''startDateTime, endDateTime [, groupResourceId]'') | ||
| − | '''Arguments''' | + | === <span style="color:#DF8621;">'''Arguments'''</span> === |
| − | + | *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''' | + | === <span style="color:#DF8621;">'''Return type'''</span> === |
Array of objects with the following information: | Array of objects with the following information: | ||
| Line 58: | Line 61: | ||
| style="border: 1px solid #010101" width="366" | | | style="border: 1px solid #010101" width="366" | | ||
The date that the email was declared invalid. | The date that the email was declared invalid. | ||
| + | |} | ||
| − | ''' | + | === <span style="color:#DF8621;">'''Examples'''</span> === |
| + | <source lang="javascript"> | ||
| + | array startdatetime ={2009, 01, 01, 00, 00, 00}; | ||
| − | + | array enddatetime ={2009, 12, 31, 23, 59, 59}; | |
| − | + | number filtergroup = 1234567; | |
| − | filtergroup | + | array maillist = EmailError_getInvalidEmails(startdatetime, enddatetime, filtergroup); |
| − | + | print(maillist); | |
| − | + | /* Output result : | |
| + | {{ominousi77@ionedge.com,0,550 5.7.1 <ominousi77@ionedge.com>: Recipient address rejected: User unknown,{2008,11,28,0,0,59,300,48,40}},{alituioiploma@mashable.com,0,550-5.1.1 The email account that you tried to reach does not exist. Please,{2008,11,28,0,28,57,700,48,40}},{koykyec@jstor.org,0,550 #5.1.0 Address rejected koykyec@jstor.org,{2008,11,28,0,33,40,200,48,40}}}*/ | ||
| + | </source> | ||
| − | |||
__NOTOC__ | __NOTOC__ | ||
<!-- imported from file: 8069.htm--> | <!-- imported from file: 8069.htm--> | ||
Latest revision as of 04:31, 21 December 2011
EmailError_getInvalidEmails
Get the information of email errors in a specific time period.
Syntax
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. |
Examples
array startdatetime ={2009, 01, 01, 00, 00, 00};
array enddatetime ={2009, 12, 31, 23, 59, 59};
number filtergroup = 1234567;
array maillist = EmailError_getInvalidEmails(startdatetime, enddatetime, filtergroup);
print(maillist);
/* Output result :
{{ominousi77@ionedge.com,0,550 5.7.1 <ominousi77@ionedge.com>: Recipient address rejected: User unknown,{2008,11,28,0,0,59,300,48,40}},{alituioiploma@mashable.com,0,550-5.1.1 The email account that you tried to reach does not exist. Please,{2008,11,28,0,28,57,700,48,40}},{koykyec@jstor.org,0,550 #5.1.0 Address rejected koykyec@jstor.org,{2008,11,28,0,33,40,200,48,40}}}*/
