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
⤷
⤷
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 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | 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 | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | TLS: Host match required | 20120531 | |||
| 2 | Instance attribute | Private | Type reference (TYPE) | LOCALFILE | Local File for Upload/Download | 20120618 | |||
| 3 | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | Verify Certificate | 20120531 | |||
| 4 | Instance attribute | Private | Type reference (TYPE) | C | 'S' | Type of SMTP request | 20000720 | ||
| 5 | Instance attribute | Private | Type reference (TYPE) | N | Use STARTTLS | 20120531 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Sets an e-mail receiver in SMTP address format | 20000717 | |
| 2 | Instance method | Public | Method | Changes message characteristics from their default values | 20000727 | |
| 3 | Instance method | Public | Method | Deletes all saved receivers | 20000718 | |
| 4 | Instance method | Public | Method | Redefinition of entity display | 20000724 | |
| 5 | Instance method | Private | Method | Creates a |
20000914 | |
| 6 | Instance method | Private | Method | Reads parameters from |
20001020 | |
| 7 | Instance method | Public | Method | Sets e-mail as XSTRING. Data according to RFC822/MIME. | 20000717 | |
| 8 | Instance method | Public | Method | Sets e-mail domain of sending SMTP hosts (optional) | 20000717 | |
| 9 | Instance method | Public | Method | Sets the e-mail sender in SMTP address format | 20000717 | |
| 10 | Instance method | Public | Method | Set TLS Parameters | 20120531 | |
| 11 | 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 | NOTIFY | Call by reference | Type reference (TYPE) | SX_NOTIFY | Type SX_NOTIFY, Bedingung zur Erzeugg eines (N)DR | 20000918 | |||
| 2 | NO_CHECK | Call by reference | Type reference (TYPE) | SX_BOOLEAN | SAPconnect: Auswahl | 20100201 | |||
| 3 | RECIPIENT | Call by reference | Type reference (TYPE) | STRING | Empfänger der E-Mail im SMTP Adressformat | 20000717 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 | 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 | REQUEST_TYPE | Call by reference | Type reference (TYPE) | C | ID des Types des zu generierenden |
20000914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahmen in den (E)SMTP Klassen | 20010215 | ||
| 2 | E-mail domain ist unbekannt | |||
| 3 | Keine E-Mail gespeichert | |||
| 4 | Generierung einer Sendeprozeß-ID schlug fehl | |||
| 5 | ID des zu generierenden |
|||
| 6 | Absender ist unbekannt | |||
| 7 | Empfänger sind unbekannt | |||
| 8 | 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 | PLUGIN_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | Zu dekodierender plugin xstring | 20001020 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 | 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 | 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 | ORIGINATOR | Call by reference | Type reference (TYPE) | STRING | Absender der E-Mail im SMTP Adressformat | 20000717 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 | IV_HOSTMATCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20120531 | ||||
| 2 | IV_SERVVER | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20120531 | ||||
| 3 | IV_SSLAPPLIC | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120618 | ||||
| 4 | IV_USETLS | Call by reference | Type reference (TYPE) | N | 20120531 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 | TYPE | Call by reference | Type reference (TYPE) | C | 'S' | SMTP request TYP | 20000720 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahmen in den (E)SMTP Klassen | 20010102 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 50A |