SAP ABAP Class /TDAG/CPCL_MAILER (CP: Component to send mails)

Hierarchy

☛ TDAGBCA (Software Component) TechniData Basic Components
   ⤷ EHS (Application Component) Environment, Health and Safety
     ⤷ /TDAG/CP_OF (Package) CP: Overall functions and features

Properties

Class	/TDAG/CPCL_MAILER
Short Description	CP: Component to send mails
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/TDAG/CP_OF	CP: Overall functions and features
Created	20070613	SAP
Last change	20141109
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /TDAG/CPCL_MAILER has no forward declaration.

Interfaces

Class /TDAG/CPCL_MAILER has no interface implemented.

Friends

Class /TDAG/CPCL_MAILER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_MAIL_ATT_CONTENT	Instance attribute	Private	☐	Type reference (TYPE)	/TDAG/CPY_SOTEXT		Content of the mail	20070613
2	MT_MAIL_TEXT	Instance attribute	Private	☐	Type reference (TYPE)	/TDAG/CPY_SOLISTI1		Text of the mail	20070613
3	MT_RECEIVERS	Instance attribute	Private	☐	Type reference (TYPE)	/TDAG/CPY_SOMLRECI1		CP: Table type of SAP Office structure SOMLRECI1	20070613
4	M_ATT_DESCR	Instance attribute	Private	☐	Type reference (TYPE)	SO_OBJ_DES		Short description of contents	20070613
5	M_ATT_DOCTYPE	Instance attribute	Private	☐	Type reference (TYPE)	SO_OBJ_TP		Code for document class	20070613
6	M_ATT_FILENAME	Instance attribute	Private	☐	Type reference (TYPE)	SO_OBJ_NAM		Name of document, folder or distribution list	20070613
7	M_ATT_FILE_EXT	Instance attribute	Private	☐	Type reference (TYPE)	SO_OBJ_NAM		File extension	20070613
8	M_ATT_SIZE	Instance attribute	Private	☐	Type reference (TYPE)	SO_DOC_SIZ		Size of SAPoffice Document (for API1)	20070613
9	M_FLG_CONTAINS_ATT	Instance attribute	Private	☐	Type reference (TYPE)	ESEBOOLE		Flag if the mail contains an attachment	20070613
10	M_MAIL_LANGU	Instance attribute	Private	☐	Type reference (TYPE)	SPRAS		Language Key	20090812
11	M_MAIL_NAME	Instance attribute	Private	☐	Type reference (TYPE)	SO_OBJ_NAM		Name of document, folder or distribution list	20070613
12	M_MAIL_SENSIVITY	Instance attribute	Private	☐	Type reference (TYPE)	SO_OBJ_SNS		Object: Sensitivity (private, functional, ...)	20070613
13	M_MAIL_SUBJECT	Instance attribute	Private	☐	Type reference (TYPE)	SO_OBJ_DES		Short description of contents	20070613
14	M_PUT_IN_OUTBOX	Instance attribute	Private	☐	Type reference (TYPE)	ESEBOOLE		Flag if the mail shall be put in outbox	20070613
15	RECEIVER_INTERNET_ADDR	Static Attribute	Public	☑	Type reference (TYPE)	SO_ESCAPE	'U'	Internet address	20070613
16	RECEIVER_SAP_USER	Static Attribute	Public	☑	Type reference (TYPE)	SO_ESCAPE	'B'	SAP user	20070613

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20070613
2	SEND_MAIL	Instance method	Public	Method	Sends a mail to one or more SAP users (into SAP Office)	20070613

Events

Class /TDAG/CPCL_MAILER has no event.

Types

Class /TDAG/CPCL_MAILER has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MAIL_ATT_CONTENT	Call by reference	☑	Type reference (TYPE)	/TDAG/CPY_SOTEXT		Binary content of the attachment in SAP Office structures	20070613
2	Importing	IT_MAIL_TEXT	Call by reference	☐	Type reference (TYPE)	/TDAG/CPY_SOLISTI1		Text of the mail in SAP Office structures	20070613
3	Importing	IT_RECEIVERS	Call by reference	☐	Type reference (TYPE)	/TDAG/CPY_SOMLRECI1		Mail receivers in SAP Office structures	20070613
4	Importing	I_ATT_DESCR	Call by reference	☑	Type reference (TYPE)	SO_OBJ_DES		Description of the attachment	20070613
5	Importing	I_ATT_DOCTYPE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_TP		Code for document class (e.g. PDF)	20070613
6	Importing	I_ATT_FILENAME	Call by reference	☑	Type reference (TYPE)	SO_OBJ_NAM		Filename of the attachment (without extension)	20070613
7	Importing	I_ATT_FILE_EXT	Call by reference	☑	Type reference (TYPE)	SO_OBJ_NAM		Extension of the attachment filename with dot (e.g. .pdf)	20070613
8	Importing	I_ATT_SIZE	Call by reference	☑	Type reference (TYPE)	SO_DOC_SIZ		Filesize of the attachment	20070613
9	Importing	I_FLG_CONTAINS_ATT	Call by reference	☐	Type reference (TYPE)	ESEBOOLE	''	The mail contains an attachment	20070613
10	Importing	I_MAIL_LANGU	Call by reference	☐	Type reference (TYPE)	SPRAS	SY-LANGU	Language Key	20090812
11	Importing	I_MAIL_NAME	Call by reference	☐	Type reference (TYPE)	SO_OBJ_NAM	'URGENT'	Name of the mail	20070613
12	Importing	I_MAIL_SENSIVITY	Call by reference	☐	Type reference (TYPE)	SO_OBJ_SNS	'O'	Object: Sensitivity (private, functional, ...)	20070613
13	Importing	I_MAIL_SUBJECT	Call by reference	☐	Type reference (TYPE)	SO_OBJ_DES		Subject of the mail	20070613
14	Importing	I_PUT_IN_OUTBOX	Call by reference	☐	Type reference (TYPE)	ESEBOOLE	'X'	Flag if the mail shall also be stored in outbox of SAP Offic	20070613

#	Exception	Resumable	Description	Created on
1	ATTACHMENT_INCOMPLETE	☐	The information about the attachment is incomplete	20070613
2	NO_RECEIVERS	☐	No recipients were specified	20070613

Method SEND_MAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NEW_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	SO_OBJ_ID		SAPoffice: ID of a SAPoffice object	20070613
2	Exporting	E_SENT_TO_ALL	Call by reference	☐	Type reference (TYPE)	ESEBOOLE		Truth Value	20070613

#	Exception	Resumable	Description	Created on
1	DOCUMENT_NOT_SENT	☐	Document was not sent	20070613
2	DOCUMENT_TYPE_NOT_EXIST	☐	Document type or attachment type does not exist	20070613
3	ENQUEUE_ERROR	☐	Required locks could not be set	20070613
4	OPERATION_NO_AUTHORIZATION	☐	No authorization to send/create	20070613
5	PARAMETER_ERROR	☐	Invalid combination of parameter values	20070613
6	TOO_MANY_RECEIVERS	☐	Too many recipients, no authorization	20070613
7	X_ERROR	☐	Internal error or database inconsistency	20070613

History

Last changed by/on	SAP	20141109
SAP Release Created in	222_46C