Quectel AG35 SMTP Installation manual

AG35 SMTP
AT Commands Manual
LTE Module Series
Rev. AG35_SMTP_AT_Commands_Manual_V1.0
Date: 2017-10-13
www.quectel.com

LTE Module Series
AG35 SMTP AT Commands Manual
AG35_SMTP_AT_Commands_Manual Confidential / Released 1 / 30
Our aim is to provide customers with timely and comprehensive service. For any
assistance, please contact our company headquarters:
Quectel Wireless Solutions Co., Ltd.
7th Floor, Hongye Building, No.1801 Hongmei Road, Xuhui District, Shanghai 200233, China
Tel: [phone]
Email: [email protected]om
Or our local office. For more information, please visit:
http://www.quectel.com/support/salesupport.aspx
For technical support, or to report documentation errors, please visit:
http://www.quectel.com/support/techsupport.aspx
Or email to: [e-mail]
GENERAL NOTES
QUECTEL OFFERS THE INFORMATION AS A SERVICE TO ITS CUSTOMERS. THE INFORMATION
PROVIDED IS BASED UPON CUSTOMERS’ REQUIREMENTS. QUECTEL MAKES EVERY EFFORT
TO ENSURE THE QUALITY OF THE INFORMATION IT MAKES AVAILABLE. QUECTEL DOES NOT
MAKE ANY WARRANTY AS TO THE INFORMATION CONTAINED HEREIN, AND DOES NOT ACCEPT
ANY LIABILITY FOR ANY INJURY, LOSS OR DAMAGE OF ANY KIND INCURRED BY USE OF OR
RELIANCE UPON THE INFORMATION. ALL INFORMATION SUPPLIED HEREIN IS SUBJECT TO
CHANGE WITHOUT PRIOR NOTICE.
COPYRIGHT
THE INFORMATION CONTAINED HERE IS PROPRIETARY TECHNICAL INFORMATION OF
QUECTEL CO., LTD. TRANSMITTING, REPRODUCTION, DISSEMINATION AND EDITING OF THIS
DOCUMENT AS WELL AS UTILIZATION OF THE CONTENT ARE FORBIDDEN WITHOUT
PERMISSION. OFFENDERS WILL BE HELD LIABLE FOR PAYMENT OF DAMAGES. ALL RIGHTS
ARE RESERVED IN THE EVENT OF A PATENT GRANT OR REGISTRATION OF A UTILITY MODEL
OR DESIGN.
Copyright © Quectel Wireless Solutions Co., Ltd. 2017. All rights reserved.
Quectel
Confidential

LTE Module Series
AG35 SMTP AT Commands Manual
AG35_SMTP_AT_Commands_Manual Confidential / Released 2 / 30
About the Document
History
Revision
Date
Author
Description
1.0
2017-10-13
Chris PENG/
Mandy WANG
Initial
Quectel
Confidential

LTE Module Series
AG35 SMTP AT Commands Manual
AG35_SMTP_AT_Commands_Manual Confidential / Released 3 / 30
Contents
About the Document...................................................................................................................................2
Contents.......................................................................................................................................................3
Table Index...................................................................................................................................................4
1Introduction..........................................................................................................................................5
1.1. Introduction about SSL Type...................................................................................................5
1.2. The Process of Sending Email................................................................................................5
1.3. Description of Data Mode........................................................................................................7
2Description of SMTP AT Commands.................................................................................................8
2.1. AT+QSMTPCFG Configure Parameters for SMTP Server..................................................8
2.2. AT+QSMTPDST Add or Delete Recipients........................................................................10
2.3. AT+QSMTPSUB Edit the Subject of an Email ...................................................................12
2.4. AT+QSMTPBODY Edit the Body of an Email.....................................................................13
2.5. AT+QSMTPATT Add or Delete Attachments for an Email..................................................15
2.6. AT+QSMTPCLR Clear the Content of an Email.................................................................16
2.7. AT+QSMTPPUT Send an Email.........................................................................................17
3Examples ............................................................................................................................................19
3.1. Send an Email without SSL...................................................................................................19
3.2. Send an Email with SSL........................................................................................................21
3.3. Send an Email with STARTTLS............................................................................................22
4Error Handling....................................................................................................................................24
4.1. Executing SMTPAT Command Fails....................................................................................24
4.2. PDPActivation Fails..............................................................................................................24
4.3. DNS Parse Fails....................................................................................................................24
4.4. Error Response ofAT+QSMTPPUT......................................................................................25
5Summary of Error Codes ..................................................................................................................26
6Summary of SMTP Protocol Error Codes .......................................................................................28
7Appendix A References.....................................................................................................................30
Quectel
Confidential

LTE Module Series
AG35 SMTP AT Commands Manual
AG35_SMTP_AT_Commands_Manual Confidential / Released 4 / 30
Table Index
TABLE 1: SUMMARY OF ERROR CODES ...................................................................................................... 26
TABLE 2: SUMMARY OF SMTP PROTOCOL ERROR CODES...................................................................... 28
TABLE 3: RELATED DOCUMENTS.................................................................................................................. 30
TABLE 4: TERMS AND ABBREVIATIONS........................................................................................................ 30
Quectel
Confidential

LTE Module Series
AG35 SMTP AT Commands Manual
AG35_SMTP_AT_Commands_Manual Confidential / Released 5 / 30
1Introduction
AG35 provides SMTP application interface for sending emails. This document is a reference guide to all
the AT commands defined for SMTP.
1.1. Introduction about SSL Type
There are three kinds of connections between SMTP client and SMTP server:
Without SSL
SSL
STARTTLS
Some SMTP servers do not support connection without SSL, while some can support all of them.
Customers can choose one kind according to the mail service provider.
These three kinds of connections can be set by <ssltype> parameter in AT+QSMTPCFG=“ssltype”.
1. If <ssltype> is 0, it means “without SSL”. In this case, SSL function will not be used, and emails are
sent with insecure connection. The port of SMTP server depends on mail service provider, and it is
the port 25 usually.
2. If <ssltype> is 1, it means “SSL”. In this case, emails are sent with SSL/TLS encrypted SMTP. The
port of SMTP server depends on mail service provider, and it is the port 465 or 587 usually.
3. If <ssltype> is 2, it means “STARTTLS”. In this case, the normal insecure connection can be
upgraded to secure connection through STARTTLS function, for sending the mail data. The port of
SMTP server depends on mail service provider, and it is the port 25, 465 or 587 usually.
1.2. The Process of Sending Email
As AG35 supports SMTP protocol, customers can send emails easily by AG35 SMTP AT commands. The
general process is as follows:
Step 1: Configure and activate a PDP context.
1) Configure <APN>, <username>, <password> and other parameters of a PDP context by
AT+QICSGP. Please refer to Quectel_AG35_TCP(IP)_AT_Commands_Manual for details.
Quectel
Confidential

LTE Module Series
AG35 SMTP AT Commands Manual
AG35_SMTP_AT_Commands_Manual Confidential / Released 6 / 30
If QoS settings need to be updated, configure them by AT+CGQMIN, AT+CGEQMIN,
AT+CGQREQ and AT+CGEQREQ commands. For more details, please refer to
Quectel_AG35_AT_Commands_Manual.
2) Activate the PDP context byAT+QIACT.
3) Configure the PDP context ID for SMTP by AT+QSMTPCFG=“contextid”,<contextID>.
Step 2: Configure SMTP server and user account.
1) Configure SSL type by AT+QSMTPCFG=“ssltype”,<ssltype>. If <ssltype> is SSL or STARTTLS,
customers should choose an SSL context by AT+QSMTPCFG=“sslctxid”,<sslctxID> and
configure the <sslctxID> by AT+QSSLCFG="ciphersuite",<sslctxID>,<ciphersuites>. For more
details about these commands, please refer to Quectel_AG35_SSL_AT_Commands_ Manual.
2) Configure SMTP server by AT+QSMTPCFG=“smtpserver”,<srvaddr>,<srvport>. <srvaddr> and
<srvport> parameters depend on the mail service provider.
3) Configure account information by AT+QSMTPCFG=“account”,<username>,<password>.
4) Configure sender information by AT+QSMTPCFG=“sender”,<sender_name>,<sender_email>.
Step 3: Edit the email content.
1) Configure the recipient email address by AT+QSMTPDST.
2) Configure the subject of email by AT+QSMTPSUB.
3) Configure the body of email by AT+QSMTPBODY.
4) Add attachments for the email by AT+QSMTPATT. The attachments can be RAM, UFS or SD
files. And the files can be uploaded to RAM, UFS or SD card by AT+QFUPL. After sending email
successfully, the file should be deleted by AT+QFDEL. For more details of these commands,
please refer to Quectel_AG35_FILE_Application_Note.
Step 4: Send email.
Send the email by AT+QSMTPPUT. It will take some time to send the email depending on the total
size of attachments and network status. When the sending action ends, “+QSMTPPUT:
<err>,<protocol_error>”will be returned.
Step 5: Clear the email content.
AT+QSMTPCLR will clear the email content configured in Step 3. The attached files should be
deleted by AT+QFDEL. For more details of these commands, please refer to
Quectel_AG35_FILE_Application_Note. Then repeat Step 3 and 4. If the SMTP server
information and user information need to be changed, then Step 2 to Step 4 should be repeated.
If emails have not been sent for a long time, such as 30 minutes or even longer, then the PDP
context should be deactivated by AT+QIDEACT=<contextID>. For more details, please refer to
Quectel_AG35_TCP(IP)_AT_Commands_Manual.
Quectel
Confidential

LTE Module Series
AG35 SMTP AT Commands Manual
AG35_SMTP_AT_Commands_Manual Confidential / Released 7 / 30
1.3. Description of Data Mode
The COM port of AG35 module has two working modes: AT command mode and data mode. In AT
command mode, the inputted data via COM port will be treated asATcommand, while in data mode, it will
be treated as data.
Inputting “+++” or pulling up DTR (AT&D1 should be set first) can make the module exit from data mode.
To prevent the “+++” from being misinterpreted as data, the following sequence should be followed:
1) Do not input any character within 1s or longer before inputting “+++”.
2) Input “+++” within 1s, and no other characters can be inputted during the time.
3) Do not input any character within 1s after “+++” has been inputted.
When AT+QSMTPBODY is executed, the COM port will enter into data mode. All inputted data will be the
body of email. If the inputted data reaches the <body_length> or the time reaches <input_time>, the port
will exit from data mode automatically. If the inputted data is less than the <body_length>, customers can
finish editing body by inputting “+++” or changing DTR level from low to high before <input_time> reaches.
In such case, the COM port cannot reenter data mode by executingATO command.
Quectel
Confidential

LTE Module Series
AG35 SMTP AT Commands Manual
AG35_SMTP_AT_Commands_Manual Confidential / Released 8 / 30
2Description of SMTP AT Commands
2.1. AT+QSMTPCFG Configure Parameters for SMTP Server
The command is used to configure SMTP server, user account and SSL settings. If the Write Command
only executes one parameter, it will query the current settings.
AT+QSMTPCFG Configure Parameters for SMTP Server
Test Command
AT+QSMTPCFG=?
Response
+QSMTPCFG: “account”,<username>,<password>
+QSMTPCFG: “sender”,<sender_name>,<sender_email>
+QSMTPCFG: “smtpserver”,<srvaddr>,<srvport>
+QSMTPCFG: “contextid”,(1-16)
+QSMTPCFG: “sslctxid”,(0-5)
+QSMTPCFG: “ssltype”,(0-2)
OK
Write Command
AT+QSMTPCFG=“account”[,<userna
me>,<password>]
Response
If <username> and <password> are not omitted:
OK
Or
+CME ERROR: <err>
If <username> and <password> are both omitted, query the
current settings:
+QSMTPCFG: “account”,<username>,<password>
OK
Write Command
AT+QSMTPCFG=“sender”[,<sender_
name>,<sender_email>]
Response
If <sender_name> and <sender_email> are not omitted:
OK
Or
+CME ERROR: <err>
If <sender_name> and <sender_email> are both omitted,
query the current settings:
Quectel
Confidential

LTE Module Series
AG35 SMTP AT Commands Manual
AG35_SMTP_AT_Commands_Manual Confidential / Released 9 / 30
+QSMTPCFG: “sender”,<sender_name>,<sender_email>
OK
Write Command
AT+QSMTPCFG=“smtpserver”[,<srva
ddr>,<srvport>]
Response
If <srvaddr> and <srvport> are not omitted:
OK
Or
+CME ERROR: <err>
If <srvaddr> and <srvport> are both omitted, query the current
settings:
+QSMTPCFG: “smtpserver”,<srvaddr>,<srvport>
OK
Write Command
AT+QSMTPCFG=“contextid”[,<conte
xtID>]
Response
If <contextID> is not omitted:
OK
Or
+CME ERROR: <err>
If <contextID> is omitted, query the current settings:
+QSMTPCFG: “contextid”,<contextID>
OK
Write Command
AT+QSMTPCFG=“sslctxid”[,<sslctxID
>]
Response
If <sslctxID> is not omitted:
OK
Or
+CME ERROR: <err>
If <sslctxID> is omitted, query the current settings:
+QSMTPCFG: “sslctxid”,<sslctxID>
OK
Write Command
AT+QSMTPCFG=“ssltype”[,<ssltype>
]
Response
If <ssltype> is not omitted:
OK
Or
+CME ERROR: <err>
If <ssltype> is omitted, query the current settings:
+QSMTPCFG: “ssltype”,<ssltype>
OK
Quectel
Confidential