CDE/cde/doc/C/guides/man/man4/Mail.sgm

<!-- $XConsortium: Mail.sgm /main/5 1996/08/30 14:53:44 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN296.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN296.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Mail</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Mail</Symbol></RefName>
<RefPurpose>compose or mail a document
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Mail.sgm /main/5 1996/08/30 14:53:44 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Mail(in <Emphasis>mediaType contents</Emphasis>);
[<Symbol Role="Variable">file</Symbol>] Mail([out|inout] <Emphasis>mediaType contents</Emphasis>
        [in title <Emphasis>docName</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Mail</Symbol> request causes the handler to route a document to a destination using the
mail message handling system.
The handler is responsible for finding routing information in the document.
</Para>
<Para>When the
<Emphasis>contents</Emphasis> argument is of mode
<Literal>in</Literal>, the handler must deliver the document as is,
without interacting with the user.
</Para>
<Para>When the
<Emphasis>contents</Emphasis> argument is of mode
<Literal>inout</Literal> or
<Literal>out</Literal>, the handler must allow the user to compose or edit the document
(and any embedded routing information)
before it is delivered.
If the handling tool supports some form of intermediate ``save''
operation, it must send a
<Symbol Role="Message">Deposit</Symbol> request back to the tool that initiated the
<Symbol Role="Message">Mail</Symbol> request.
</Para>
<Para>The
<Emphasis>contents</Emphasis> argument
is the contents of the document.
If this argument is unset
(in other words, has a value of
<Literal>(char *)0</Literal>), then the contents of the document are in
the file named in the message's
<Symbol Role="Variable">file</Symbol> attribute.
The data type
(<Emphasis>mediaType</Emphasis>) of the
<Emphasis>contents</Emphasis> argument should be
<Literal>string</Literal>, unless nulls are valid in the given media type,
in which case the data type must be
<Literal>bytes</Literal>.</Para>
<Para>The
<Emphasis>docName</Emphasis> argument contains the name of the document.
If the
<Emphasis>docName</Emphasis> argument is absent and the
<Symbol Role="Variable">file</Symbol> attribute is set,
the file name is considered to be the title of the document.
This string would be suitable for display in a window title bar, for example.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttmedia.ptype.declare; function can be used to register for,
and help process, this message.
</Para>
<Para>This message can be sent with the
&cdeman.ttmedia.load; function.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Mail</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file that was alleged to contain the document does not exist.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENODATA</Term>
<ListItem>
<Para>The in-mode
<Emphasis>contents</Emphasis> argument had no value and the
<Symbol Role="Variable">file</Symbol> attribute
of the message was not set.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_MEDIA_ERR_FORMAT</Term>
<ListItem>
<Para>The document is not a valid instance of the media type.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttmedia.ptype.declare;, &cdeman.ttmedia.load;; <Emphasis>Intro</Emphasis>, <Symbol Role="Message">Edit</Symbol> requests.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->