EmailStatus (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Communication

Managing emails

WLanguage functions

EmailStatus

Presentation

Example

Managing emails in asynchronous mode

See also

EmailAddFolder

EmailBuildSource

EmailChangeFolder (Example)

EmailChangeFolder

EmailChangeStatus

EmailCheckAddress

EmailCloseSession (Example)

EmailCloseSession

EmailConfigure

EmailCopy

EmailCurrentFolder

EmailDeleteMessage (Example)

EmailDeleteMessage

EmailExportHTML

EmailExpunge

EmailGetAll

EmailGetIndicator

EmailGetTimeOut

EmailImportHTML

EmailImportSource

EmailListFolder (Example)

EmailListFolder

EmailLoadAttachment

EmailMessageLength

EmailMsgError (Example)

EmailMsgError

EmailNbMessage (Example)

EmailNbMessage

EmailProgressBar

EmailReadFirst (Example)

EmailReadFirst

EmailReadFirstHeader

EmailReadLast (Example)

EmailReadLast

EmailReadLastHeader

EmailReadMessage (Example)

EmailReadMessage

EmailReadMessageHeader

EmailReadNext (Example)

EmailReadNext

EmailReadNextHeader

EmailReadPrevious (Example)

EmailReadPrevious

EmailReadPreviousHeader

EmailRemoveFolder

EmailReset

EmailRunApp

EmailSaveAttachment (Example)

EmailSaveAttachment

EmailSeekFirst (Example)

EmailSeekFirst

EmailSeekFirstNotes

EmailSend (Example)

EmailSend

EmailSendMessage (Example)

EmailSendMessage

EmailSetTimeOut

EmailStartIMAPSession

EmailStartNotesSession

EmailStartOutlookSession

EmailStartPOP3Session

EmailStartSMTPSession

EmailStartSession (Example)

EmailStartSession

EmailStatus

EmailUpdate (Example)

EmailUpdate

OutlookStartSession (Example)

OutlookStartSession

emailAttach

emailHeader

emailIMAPSession

emailNotesSession

emailOutlookSession

emailPOP3Session

emailSMTPSession

Managing emails in asynchronous mode

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EmailStatus (Function)

In french: EmailEtat

Returns the status of an email sent via an SMTP session started in asynchronous mode.

Example

// Send an email via the SMTP protocol
IF EmailStartSession(USER, PASSWORD, "pop3.ifrance.fr", ...
"smtp.ifrance.fr", 110, 25, True) = True THEN
UserName = USER
ELSE
UserName = ""
Error("Unable to establish the connection")
END

// Initialize the email structure
Email.Recipient = "support@pcsoft.fr"
Email.Sender = "Tartampion@box.net.eu"
Email.Message = "Auto Email Test"
Email.NbRecipient = 1

// Send the email
IF EmailSendMessage(UserName) = False THEN
Error("EMailSendMessage failed '" + ErrorInfo(errMessage) + "'")
ELSE
Info("EmailSendMessage was successful")
END
...
// Track the email
SWITCH EmailStatus(Email.MailIdentifier)
CASE emailSent: Trace("The email was sent")
CASE emailPending: Trace("The email is currently processed")
CASE emailError: Trace("Error: " + ErrorInfo(errMessage))
END

Syntax

<Result> = EmailStatus(<Email Identifier>)

<Result>: Constant

Outgoing status of the specified email:
emailError An error occurred. The error details are returned by ErrorInfo(errMessage).
emailPending The email is waiting to be sent. It is in the spooler.
emailSent The email was sent.

<Email Identifier>: Integer

Email identifier (Email.MailIdentifier variable or ID property of the Email variable initialized when the email was sent with EmailSend and EmailSendMessage).

Remarks

Managing emails in asynchronous mode

The email functions are locking functions by default. Which means that no other code can be run during their execution. The program will resume only when the current Email functions have been run.

WEBDEV gives you the ability to manage the emails in asynchronous mode. This mode allows your sites to send emails without locking the execution of other processes.

To use the asynchronous mode, you must:

Uncheck "Disable the email spooler" in the WEBDEV administrator ("Advanced" tab).
Enable the asynchronous mode when starting the SMTP session (with EmailStartSMTPSession or EmailStartSession).
All outgoing emails will be transmitted to a "spooler". Emails are queued up before being sent.

Executing Email functions does no longer block the rest of the program. EmailStatus determines the status of an email.

Remark: If the WEBDEV administrator is closed, the email spooler is cleared: pending emails are not sent and are removed from the spooler.

If there are pending emails, and the "Disable the email spooler" option is checked, the emails will not be lost: the administrator continues to send them, but the spooler will not accept any new emails.

Caution: The asynchronous mode can only be used when starting a session on an SMTP server (EmailStartSMTPSession for sending emails or EmailStartSession). The asynchronous mode is ignored in all other cases.

Component: wd270com.dll