Difference between revisions of "MAILOPEN()"

From Lianjapedia
Jump to: navigation, search
(Description)
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
==Syntax==
 
==Syntax==
MAILOPEN(<expC1>, <expC2>, <expC3> [, <expC4>])
+
MAILOPEN(<expC1>, <expC2>, <expC3> [, <expC4> [, <expN1>]])
  
 
==See Also==
 
==See Also==
[[CLOSEMAIL()]], [[COUNTMAIL()]], [[DELETEMAIL()]], [[MAILATTACH()]], [[MAILCLOSE()]], [[MAILCOUNT()]], [[MAILDELETE()]], [[MAILERROR()]], [[MAILHEADER()]], [[MAILNODENAME()]], [[MAILREAD()]], [[MAILSAVEAS()]], [[MAILSEND()]], [[MAILUSERNAME()]], [[OPENMAIL()]], [[READMAIL()]], [[SENDMAIL()]]
+
[[BASE64_ENCODE()]], [[CLOSEMAIL()]], [[COUNTMAIL()]], [[DELETEMAIL()]], [[MAILATTACH()]], [[MAILCLOSE()]], [[MAILCOUNT()]], [[MAILDELETE()]], [[MAILERROR()]], [[MAILHEADER()]], [[MAILNODENAME()]], [[MAILREAD()]], [[MAILSAVEAS()]], [[MAILSEND()]], [[MAILUSERNAME()]], [[OPENMAIL()]], [[READMAIL()]], [[SENDMAIL()]]
  
 
==Description==
 
==Description==
The MAILOPEN() function is used to connect to the specified mail server.  The mail type POP3 should be used for reading mail, and SMTP used for sending mail.
+
The MAILOPEN() function is used to connect to the specified mail server.  The mail type POP3 should be used for reading mail, and SMTP/ESMTP used for sending mail.
  
{| class="wikitable"
+
{| class="wikitable" width="100%"
!Parameters||Required||Default||Description
+
!width="15%"|Parameters||width="15%"|Required||width="15%"|Default||Description
 
|-
 
|-
 
|<expC1>||Yes||None||The node name or IP address of the mail server
 
|<expC1>||Yes||None||The node name or IP address of the mail server
 
|-
 
|-
|<expC2>||Yes||None||The user name with which to connect to the mail server
+
|valign="top"|<expC2>||valign="top"|Yes||valign="top"|None||The user name with which to connect to the mail server.  For ESMTP, this must be [[BASE64_ENCODE()|Base64 encoded]].
 
|-
 
|-
|<expC3>||Yes||None||The password for the user name
+
|<expC3>||Yes||None||The password for the user name.  For ESMTP, this must be [[BASE64_ENCODE()|Base64 encoded]].
 
|-
 
|-
|<expC4>||No||POP3||The mail protocol type.  POP3 and SMTP are the currently supported protocols.
+
|valign="top"|<expC4>||valign="top"|No||valign="top"|POP3||The mail protocol type.  POP3, SMTP and ESMTP are the currently supported protocols.
 +
|-
 +
|valign="top"|<expN1>||valign="top"|No||valign="top"|25||The SMTP/ESMTP port number.
 
|-
 
|-
 
|}
 
|}
Line 32: Line 34:
 
if not m_open
 
if not m_open
 
     dialog box mailerror()
 
     dialog box mailerror()
     endif
+
else
mailclose()
+
     // process mail
 +
    mailclose()
 +
endif
  
 
// Open SMTP for sending
 
// Open SMTP for sending
Line 39: Line 43:
 
if not m_open
 
if not m_open
 
     dialog box mailerror()
 
     dialog box mailerror()
     endif
+
else
mailclose()
+
     //process mail
 +
    mailclose()
 +
endif
 
</code>
 
</code>
  

Latest revision as of 11:20, 14 January 2020

Purpose

Function to connect to the specified mail server

Syntax

MAILOPEN(<expC1>, <expC2>, <expC3> [, <expC4> [, <expN1>]])

See Also

BASE64_ENCODE(), CLOSEMAIL(), COUNTMAIL(), DELETEMAIL(), MAILATTACH(), MAILCLOSE(), MAILCOUNT(), MAILDELETE(), MAILERROR(), MAILHEADER(), MAILNODENAME(), MAILREAD(), MAILSAVEAS(), MAILSEND(), MAILUSERNAME(), OPENMAIL(), READMAIL(), SENDMAIL()

Description

The MAILOPEN() function is used to connect to the specified mail server. The mail type POP3 should be used for reading mail, and SMTP/ESMTP used for sending mail.

Parameters Required Default Description
<expC1> Yes None The node name or IP address of the mail server
<expC2> Yes None The user name with which to connect to the mail server. For ESMTP, this must be Base64 encoded.
<expC3> Yes None The password for the user name. For ESMTP, this must be Base64 encoded.
<expC4> No POP3 The mail protocol type. POP3, SMTP and ESMTP are the currently supported protocols.
<expN1> No 25 The SMTP/ESMTP port number.

If successful the MAILOPEN() will return .T., otherwise .F.. The MAILERROR() function can be used to return the error message if the MAILOPEN() fails.

Example

// Open POP3 for reading mail
m_open = mailopen("mailserver.company.com", "username", "password", "POP3")
if not m_open
    dialog box mailerror()
else
    // process mail
    mailclose()
endif
 
// Open SMTP for sending
m_open = mailopen("mailserver.company.com","username","password", "SMTP")
if not m_open
    dialog box mailerror()
else
    //process mail
    mailclose()
endif