SendSmtpFileMessage: Difference between revisions

From Opale Wiki
Jump to navigation Jump to search
VisualWikitext
(Created page with " This command executes HTTP method on the specified GSM port. It requires an active connection to HTTP server on the specified GSM port. HTTP method can be GET, PUT, DELETE or POST. Input file path is used for PUT and POST methods, output file path is used for GET, DELETE and POST methods. If any of required parameter is not needed it can be specified as NULL string (""). Optional HTTP header name and value should be specified always in pair. Up to 12 HTTP headers...")
Tag: 2017 source edit
 
No edit summary
 
Line 1: Line 1:


This command executes HTTP method on the specified GSM port.  
This command sends a specified Email message to SMTP server on the specified GSM port. It requires an active data session on the specified GSM por.  


It requires an active connection to HTTP server on the specified GSM port.
Message is sent with the content from the specified file that should contain formatted SMTP data including headers (see <nowiki>RFC 2822</nowiki>).


HTTP method can be GET, PUT, DELETE or POST. Input file path is used for PUT and POST methods, output file path is used for GET, DELETE and POST methods.  
If any of required parameters is not needed it can be specified as NULL string ("").


If any of required parameter is not needed it can be specified as NULL string ("").  
Sender Email address will be used in "MAIL From" SMTP message, Recipient Email Address will be used in "RCPT To".


Optional HTTP header name and value should be specified always in pair. Up to 12 HTTP headers can be specified.  
Optional User Name and Password can be specified if authentication is required. Optional SSL flag can be added at the end of this command.


Command waits until data is transferred or timer expires.
Command waits until Email message is sent or general timeout expired.  


'''COMMAND'''
'''COMMAND'''
Line 18: Line 18:
!Returns
!Returns
|-
|-
|ExecuteHttpMethod
|'''SendSmtpFileMessage'''
|PortIndex, HTTPMethod, URL, UserName, Password, FilePath, ListPairsHTTPHeaderName-HTTPHeaderValue
|PortIndex, SMTPServerIPAddressorHostName, [:Peer Port], SenderName, SenderEmailAddress, RecepientEmailAddress, CCEmailAddress, BCCEmailAddress, Subject, MessageFilePath, [UserName, Password and SSLflag]
|[[R2D2 Error Codes|Error Code]] in case of error.
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
|}
Line 28: Line 28:


'''EXAMPLE''' <syntaxhighlight lang="text">
'''EXAMPLE''' <syntaxhighlight lang="text">
~# SendSmtpFileMessage 0 "smtp.ultiroam.com" "name@ultiroam.com" "dest@gmail.com" "/var/tmp/test.eml"
EMAIL MESSAGE SENT


~# ExecuteHttpMethod 0 GET www.acme.com "user" "pass" """/tmp/test/url.html" "Accept" "text/html" "Transfer-coding" "compress"
~# SendSmtpFileMessage 0 "89182:25" "name@ultiroam.com" "dest@gmail.com" "/var/tmp/test.msg" "user1" "password" 60
OK
FILE NOT FOUND
 
~# ExecuteHttpMethod 0 GET www.acme.com "user" "wrongpass" """/tmp/test/url.html" "Accept" "text/html" "Transfer-coding" "compress"
AUTHENTICATION FAILED
 
~# ExecuteHttpMethod 1 GET www.acme.com "" "" "" "/tmp/test/url.html" "Accept"
BAD PARAMETERS
 
~# ExecuteHttpMethod 0 POST www.acme.com "user" "pass" "/tmp/test/put.htm" "/tmp/test/url.html" "Accept" "text/html" "Transfer-coding" "compress"
OK
</syntaxhighlight>
</syntaxhighlight>
[[Category:R2D2]]
[[Category:R2D2]]
[[Category:DATA]]
[[Category:DATA]]

Latest revision as of 20:12, 1 April 2025

This command sends a specified Email message to SMTP server on the specified GSM port. It requires an active data session on the specified GSM por.

Message is sent with the content from the specified file that should contain formatted SMTP data including headers (see RFC 2822).

If any of required parameters is not needed it can be specified as NULL string ("").

Sender Email address will be used in "MAIL From" SMTP message, Recipient Email Address will be used in "RCPT To".

Optional User Name and Password can be specified if authentication is required. Optional SSL flag can be added at the end of this command.

Command waits until Email message is sent or general timeout expired.

COMMAND

Command Line Arguments Returns
SendSmtpFileMessage PortIndex, SMTPServerIPAddressorHostName, [:Peer Port], SenderName, SenderEmailAddress, RecepientEmailAddress, CCEmailAddress, BCCEmailAddress, Subject, MessageFilePath, [UserName, Password and SSLflag] Error Code in case of error.

OUTPUT

Success or Error Message (See Data Commands Messages)

EXAMPLE 

~# SendSmtpFileMessage 0 "smtp.ultiroam.com" "name@ultiroam.com" "dest@gmail.com" "/var/tmp/test.eml"
EMAIL MESSAGE SENT

~# SendSmtpFileMessage 0 "89182:25" "name@ultiroam.com" "dest@gmail.com" "/var/tmp/test.msg" "user1" "password" 60
FILE NOT FOUND
Retrieved from "https://wiki.opalesystems.com/index.php?title=SendSmtpFileMessage&oldid=4512"