SAP ABAP Class CL_SMTP_REQUEST (SMTP Request (Implements IF_SMTP_REQUEST))
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷ BC-MID-RFC (Application Component) RFC
⤷ SSMTP (Package) Development Class for SMTP Communication
⤷ BC-MID-RFC (Application Component) RFC
⤷ SSMTP (Package) Development Class for SMTP Communication
Meta Relationship - Using
# | Relationship type | Using | Short Description | Created on |
---|---|---|---|---|
1 | Inheritance (c INHERITING FROM c_ref) | CL_SMTP_ENTITY | SMTP Comm. Unit (implements IF_SMTP_ENTITY) | 20000717 |
2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SMTP_REQUEST | SMTP request (outgoing mail oder status) | 20000717 |
Properties
Class | CL_SMTP_REQUEST | |
Short Description | SMTP Request (Implements IF_SMTP_REQUEST) | |
Super Class | CL_SMTP_ENTITY | SMTP Comm. Unit (implements IF_SMTP_ENTITY) |
Instantiability of a Class | 2 | Public |
Final |
General Data
Message Class | ||
Program status | ||
Category | 0 | |
Package | SSMTP | Development Class for SMTP Communication |
Created | 20000717 | SAP |
Last change | 20130531 | SAP |
Shared Memory-enabled | ||
Fixed point arithmetic | ||
Unicode checks active |
Forward declarations
# | Type group / Object type | Type | Type Description |
---|---|---|---|
1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
2 | SX | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
# | Interface | Abstract | Final | Description | Created on |
---|---|---|---|---|---|
1 | IF_SMTP_REQUEST | SMTP request (outgoing mail oder status) | 20000717 |
Friends
Class CL_SMTP_REQUEST has no friend class.
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | M_HOSTMATCH | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | TLS: Host match required | 20120531 | ||
2 | M_PSENAME | Instance attribute | Private | Type reference (TYPE) | LOCALFILE | Local File for Upload/Download | 20120618 | ||
3 | M_SERVVER | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | Verify Certificate | 20120531 | ||
4 | M_SMTP_REQUEST_TYPE | Instance attribute | Private | Type reference (TYPE) | C | 'S' | Type of SMTP request | 20000720 | |
5 | M_USETLS | Instance attribute | Private | Type reference (TYPE) | N | Use STARTTLS | 20120531 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | ADD_RECIPIENT | Instance method | Public | Method | Sets an e-mail receiver in SMTP address format | 20000717 |
2 | CHANGE_MESSAGE_PROPS | Instance method | Public | Method | Changes message characteristics from their default values | 20000727 |
3 | CLEAR_RECIPIENTS | Instance method | Public | Method | Deletes all saved receivers | 20000718 |
4 | DISPLAY | Instance method | Public | Method | Redefinition of entity display | 20000724 |
5 | GENERATE_XSTRING | Instance method | Private | Method | Creates a |
20000914 |
6 | PARSE_XSTRING | Instance method | Private | Method | Reads parameters from |
20001020 |
7 | SET_EMAIL | Instance method | Public | Method | Sets e-mail as XSTRING. Data according to RFC822/MIME. | 20000717 |
8 | SET_EMAILDOMAIN | Instance method | Public | Method | Sets e-mail domain of sending SMTP hosts (optional) | 20000717 |
9 | SET_ORIGINATOR | Instance method | Public | Method | Sets the e-mail sender in SMTP address format | 20000717 |
10 | SET_TLS | Instance method | Public | Method | Set TLS Parameters | 20120531 |
11 | SET_TYPE | Instance method | Public | Method | Sets SMTP Request Type ( |
20000720 |
Events
Class CL_SMTP_REQUEST has no event.
Types
Class CL_SMTP_REQUEST has no local type.
Method Signatures
Method ADD_RECIPIENT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | NOTIFY | Call by reference | Type reference (TYPE) | SX_NOTIFY | Type SX_NOTIFY, Bedingung zur Erzeugg eines (N)DR | 20000918 | ||
2 | Importing | NO_CHECK | Call by reference | Type reference (TYPE) | SX_BOOLEAN | SAPconnect: Auswahl | 20100201 | ||
3 | Importing | RECIPIENT | Call by reference | Type reference (TYPE) | STRING | Empfänger der E-Mail im SMTP Adressformat | 20000717 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_BCOM_SMTP | Ausnahmen in den (E)SMTP Klassen | 20010102 |
Method CHANGE_MESSAGE_PROPS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | ENVID | Call by reference | Type reference (TYPE) | CHAR38 | Sendeprozeß ID (sonst wird eine GUID erzeugt) | 20000727 |
Method CHANGE_MESSAGE_PROPS on class CL_SMTP_REQUEST has no exception.
Method CLEAR_RECIPIENTS Signature
Method CLEAR_RECIPIENTS on class CL_SMTP_REQUEST has no parameter.
Method CLEAR_RECIPIENTS on class CL_SMTP_REQUEST has no exception.
Method DISPLAY Signature
Method DISPLAY on class CL_SMTP_REQUEST has no parameter.
Method DISPLAY on class CL_SMTP_REQUEST has no exception.
Method GENERATE_XSTRING Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | REQUEST_TYPE | Call by reference | Type reference (TYPE) | C | ID des Types des zu generierenden |
20000914 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_BCOM_SMTP | Ausnahmen in den (E)SMTP Klassen | 20010215 | |
2 | SMTP_DOMAIN_UNKNOWN | E-mail domain ist unbekannt | ||
3 | SMTP_EMAIL_EMPTY | Keine E-Mail gespeichert | ||
4 | SMTP_GUID_GEN_FAILED | Generierung einer Sendeprozeß-ID schlug fehl | ||
5 | SMTP_ID_UNKNOWN | ID des zu generierenden |
||
6 | SMTP_ORIGINATOR_UNKNOWN | Absender ist unbekannt | ||
7 | SMTP_RECIPIENTS_UNKNOWN | Empfänger sind unbekannt | ||
8 | SYSTEM_ERROR | Fehler beim Aufruf Systemmethode (E-Msg wird ausgegeben) |
Method PARSE_XSTRING Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | PLUGIN_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | Zu dekodierender plugin xstring | 20001020 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_BCOM_SMTP | Ausnahmen in den (E)SMTP Klassen | 20010102 |
Method SET_EMAIL Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | Call by reference | Type reference (TYPE) | XSTRING | E-mail als XSTRING. Daten gemäß RFC822/MIME. | 20000717 |
Method SET_EMAIL on class CL_SMTP_REQUEST has no exception.
Method SET_EMAILDOMAIN Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | EMAIL_DOMAIN | Call by reference | Type reference (TYPE) | STRING | E-Mail domain des sendenden SMTP hosts. | 20000717 |
Method SET_EMAILDOMAIN on class CL_SMTP_REQUEST has no exception.
Method SET_ORIGINATOR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | ORIGINATOR | Call by reference | Type reference (TYPE) | STRING | Absender der E-Mail im SMTP Adressformat | 20000717 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_BCOM_SMTP | Ausnahmen in den (E)SMTP Klassen | 20010102 |
Method SET_TLS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IV_HOSTMATCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20120531 | |||
2 | Importing | IV_SERVVER | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20120531 | |||
3 | Importing | IV_SSLAPPLIC | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120618 | |||
4 | Importing | IV_USETLS | Call by reference | Type reference (TYPE) | N | 20120531 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_BCOM_SMTP | Ausnahmen in den (E)SMTP Klassen | 20120618 |
Method SET_TYPE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | TYPE | Call by reference | Type reference (TYPE) | C | 'S' | SMTP request TYP | 20000720 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_BCOM_SMTP | Ausnahmen in den (E)SMTP Klassen | 20010102 |
History
Last changed by/on | SAP | 20130531 |
SAP Release Created in | 50A |