Wed Apr 6 11:29:45 2011

Asterisk developer's documentation


func_vmcount.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (c) 2006 Tilghman Lesher.  All rights reserved.
00005  * 
00006  * Tilghman Lesher <asterisk-vmcount-func@the-tilghman.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  *
00021  * \brief VMCOUNT dialplan function
00022  *
00023  * \author Tilghman Lesher <asterisk-vmcount-func@the-tilghman.com>
00024  *
00025  * \ingroup functions
00026  */
00027 
00028 #include "asterisk.h"
00029 
00030 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 200620 $")
00031 
00032 #include <dirent.h>
00033 
00034 #include "asterisk/file.h"
00035 #include "asterisk/channel.h"
00036 #include "asterisk/pbx.h"
00037 #include "asterisk/module.h"
00038 #include "asterisk/lock.h"
00039 #include "asterisk/utils.h"
00040 #include "asterisk/app.h"
00041 
00042 /*** DOCUMENTATION
00043    <function name="VMCOUNT" language="en_US">
00044       <synopsis>
00045          Count the voicemails in a specified mailbox.
00046       </synopsis>
00047       <syntax>
00048          <parameter name="vmbox" required="true" argsep="@">
00049             <argument name="vmbox" required="true" />
00050             <argument name="context" required="false">
00051                <para>If not specified, defaults to <literal>default</literal>.</para>
00052             </argument>
00053          </parameter>
00054          <parameter name="folder" required="false">
00055             <para>If not specified, defaults to <literal>INBOX</literal></para>
00056          </parameter>
00057       </syntax>
00058       <description>
00059          <para>Count the number of voicemails in a specified mailbox, you could also specify 
00060          the <replaceable>context</replaceable> and the mailbox <replaceable>folder</replaceable>.</para>
00061          <para>Example: <literal>exten => s,1,Set(foo=${VMCOUNT(125)})</literal></para>
00062       </description>
00063    </function>
00064  ***/
00065 
00066 static int acf_vmcount_exec(struct ast_channel *chan, const char *cmd, char *argsstr, char *buf, size_t len)
00067 {
00068    char *context;
00069    AST_DECLARE_APP_ARGS(args,
00070       AST_APP_ARG(vmbox);
00071       AST_APP_ARG(folder);
00072    );
00073 
00074    buf[0] = '\0';
00075 
00076    if (ast_strlen_zero(argsstr))
00077       return -1;
00078 
00079    AST_STANDARD_APP_ARGS(args, argsstr);
00080 
00081    if (strchr(args.vmbox, '@')) {
00082       context = args.vmbox;
00083       args.vmbox = strsep(&context, "@");
00084    } else {
00085       context = "default";
00086    }
00087 
00088    if (ast_strlen_zero(args.folder)) {
00089       args.folder = "INBOX";
00090    }
00091 
00092    snprintf(buf, len, "%d", ast_app_messagecount(context, args.vmbox, args.folder));
00093    
00094    return 0;
00095 }
00096 
00097 static struct ast_custom_function acf_vmcount = {
00098    .name = "VMCOUNT",
00099    .read = acf_vmcount_exec,
00100    .read_max = 12,
00101 };
00102 
00103 static int unload_module(void)
00104 {
00105    return ast_custom_function_unregister(&acf_vmcount);
00106 }
00107 
00108 static int load_module(void)
00109 {
00110    return ast_custom_function_register(&acf_vmcount);
00111 }
00112 
00113 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Indicator for whether a voice mailbox has messages in a given folder.");

Generated on Wed Apr 6 11:29:45 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7