abp_smtp.h

00001 /*******************************************************************************
00002 ********************************************************************************
00003 **                                                                            **
00004 ** ABP version 7.16.01 (2015-10-14)                                           **
00005 **                                                                            */
00006 /*******************************************************************************
00007 ********************************************************************************
00008 **
00009 ** File Name
00010 ** ---------
00011 **
00012 ** abp_smtp.h
00013 **
00014 ********************************************************************************
00015 ********************************************************************************
00016 **
00017 ** Description
00018 ** -----------
00019 **
00020 ** ABP - Anybus-CC SMTP Client Interface Object Protocol Definitions.
00021 **
00022 ** This software component contains SMTP definitions used by Anybus-CC
00023 ** modules as well as applications designed to use such modules.
00024 **
00025 ********************************************************************************
00026 ********************************************************************************
00027 **                                                                            **
00028 ** COPYRIGHT NOTIFICATION (c) 2008 HMS Industrial Networks AB                 **
00029 **                                                                            **
00030 ** This code is the property of HMS Industrial Networks AB.                   **
00031 ** The source code may not be reproduced, distributed, or used without        **
00032 ** permission. When used together with a product from HMS, this code can be   **
00033 ** modified, reproduced and distributed in binary form without any            **
00034 ** restrictions.                                                              **
00035 **                                                                            **
00036 ** THE CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. HMS DOES NOT    **
00037 ** WARRANT THAT THE FUNCTIONS OF THE CODE WILL MEET YOUR REQUIREMENTS, OR     **
00038 ** THAT THE OPERATION OF THE CODE WILL BE UNINTERRUPTED OR ERROR-FREE, OR     **
00039 ** THAT DEFECTS IN IT CAN BE CORRECTED.                                       **
00040 **                                                                            **
00041 ********************************************************************************
00042 ********************************************************************************
00043 */
00044 
00045 #ifndef ABP_SMTP_H
00046 #define ABP_SMTP_H
00047 
00048 
00049 /*******************************************************************************
00050 **
00051 ** SMTP Client Interface object constants.
00052 **
00053 ** Object revision: 1.
00054 **
00055 ********************************************************************************
00056 */
00057 
00058 /*------------------------------------------------------------------------------
00059 **
00060 ** The SMTP Client Interface object specific object attributes.
00061 **
00062 **------------------------------------------------------------------------------
00063 */
00064 
00065 #define ABP_SMTP_OA_MAX_INST              11    /* Max number of instances    */
00066 #define ABP_SMTP_OA_EMAILS_SENT           12    /* Emails sent                */
00067 #define ABP_SMTP_OA_EMAIL_FAILED          13    /* Emails failed to send      */
00068 
00069 
00070 /*------------------------------------------------------------------------------
00071 **
00072 ** The data size of the Anybus-CC SMTP Client Interface object specific
00073 ** attributes (in bytes).
00074 **
00075 **------------------------------------------------------------------------------
00076 */
00077 
00078 #define ABP_SMTP_OA_MAX_INST_DS            ABP_UINT16_SIZEOF
00079 #define ABP_SMTP_OA_EMAILS_SENT_DS         ABP_UINT16_SIZEOF
00080 #define ABP_SMTP_OA_EMAIL_FAILED_DS        ABP_UINT16_SIZEOF
00081 
00082 
00083 /*------------------------------------------------------------------------------
00084 **
00085 ** The SMTP Client Interface instance attributes.
00086 **
00087 **------------------------------------------------------------------------------
00088 */
00089 
00090 #define ABP_SMTP_IA_FROM                   1    /* From address               */
00091 #define ABP_SMTP_IA_TO                     2    /* To address                 */
00092 #define ABP_SMTP_IA_SUBJECT                3    /* Message subject            */
00093 #define ABP_SMTP_IA_MESSAGE                4    /* Message body               */
00094 
00095 
00096 /*------------------------------------------------------------------------------
00097 **
00098 ** The data size of the Anybus-CC SMTP Client Interface object instance
00099 ** attributes (in bytes).
00100 **
00101 **------------------------------------------------------------------------------
00102 */
00103 
00104 #define ABP_SMTP_IA_FROM_DS               ( 255 * ABP_UINT8_SIZEOF )
00105 #define ABP_SMTP_IA_TO_DS                 ( 255 * ABP_UINT8_SIZEOF )
00106 #define ABP_SMTP_IA_SUBJECT_DS            ( 255 * ABP_UINT8_SIZEOF )
00107 #define ABP_SMTP_IA_MESSAGE_DS            ( 255 * ABP_UINT8_SIZEOF )
00108 
00109 
00110 /*------------------------------------------------------------------------------
00111 **
00112 ** The SMTP Client Interface object specific message commands.
00113 **
00114 **------------------------------------------------------------------------------
00115 */
00116 
00117 #define ABP_SMTP_CMD_SEND_EMAIL                 0x10
00118 #define ABP_SMTP_CMD_SEND_EMAIL_FROM_FILE       0x11
00119 
00120 
00121 /*------------------------------------------------------------------------------
00122 **
00123 ** SMTP Client Interface object specific error codes.
00124 **
00125 **------------------------------------------------------------------------------
00126 */
00127 
00128 #define ABP_SMTP_NO_EMAIL_SERVER                1
00129 #define ABP_SMTP_SERVER_NOT_READY               2
00130 #define ABP_SMTP_AUTHENTICATION_ERROR           3
00131 #define ABP_SMTP_SOCKET_ERROR                   4
00132 #define ABP_SMTP_SSI_SCAN_ERROR                 5
00133 #define ABP_SMTP_FILE_ERROR                     6
00134 #define ABP_SMTP_OTHER                        255
00135 
00136 
00137 #endif  /* inclusion lock */
00138 
00139 /*******************************************************************************
00140 **
00141 ** End of abp_smtp.h
00142 **
00143 ********************************************************************************
00144 */